ESH API Schema

API Specification

The base API schema is shown below, but will dynamically change based on the Templates created in the system. Each Template generates an additional schemas where it is possible to have payloads for specific payloads validated.

For the full API schema at any given time, in the ESH console, navigate to the API page.

Schema Version: 1.0.0

/

GET

Responses

Code	Description
200	Health status

/audit_trail

GET

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

/data

GET

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

/identity

GET

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

/login

POST

Responses

Code	Description
200	Login

/management/groups

GET

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header
access_type	query		No	string

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

POST

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

/management/groups/{group_name}

DELETE

Parameters

Name	Located in	Description	Required	Schema
			No	group_name
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

GET

Parameters

Name	Located in	Description	Required	Schema
			No	group_name
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

PATCH

Parameters

Name	Located in	Description	Required	Schema
			No	group_name
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

PUT

Parameters

Name	Located in	Description	Required	Schema
			No	group_name
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

/management/users

GET

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

POST

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

/management/users/{username}

DELETE

Parameters

Name	Located in	Description	Required	Schema
			No	username
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

GET

Parameters

Name	Located in	Description	Required	Schema
			No	username
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

PUT

Parameters

Name	Located in	Description	Required	Schema
			No	username
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

/organizations

GET

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

POST

Responses

Code	Description
201	Organization was created

Security

Security Schema	Scopes
cognito

/organizations/{organization_id}

DELETE

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

GET

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

PUT

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

/policies/opa

GET

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

POST

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

/policies/opa/{opa_policy_id}

DELETE

Parameters

Name	Located in	Description	Required	Schema
			No	opa_policy_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

GET

Parameters

Name	Located in	Description	Required	Schema
			No	opa_policy_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

PUT

Parameters

Name	Located in	Description	Required	Schema
			No	opa_policy_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

/regions

GET

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

/schema

GET

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

/settings

GET

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

PATCH

Responses

Code	Description
200

Security

Security Schema	Scopes
cognito

/target_groups

GET

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

POST

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
201	Target group was created

Security

Security Schema	Scopes
cognito

/target_groups/{target_group_id}

DELETE

Parameters

Name	Located in	Description	Required	Schema
			No	target_group_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

GET

Parameters

Name	Located in	Description	Required	Schema
			No	target_group_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

PUT

Parameters

Name	Located in	Description	Required	Schema
			No	target_group_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

/target_groups/{target_group_id}/targets

GET

Parameters

Name	Located in	Description	Required	Schema
			No	target_group_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

/targets

GET

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

POST

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
201

Security

Security Schema	Scopes
cognito

/targets/{target_id}

DELETE

Parameters

Name	Located in	Description	Required	Schema
			No	target_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

GET

Parameters

Name	Located in	Description	Required	Schema
			No	target_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

PUT

Parameters

Name	Located in	Description	Required	Schema
			No	target_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

/template_groups

GET

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

POST

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
201	Template was created

Security

Security Schema	Scopes
cognito

/template_groups/{template_group_id}

DELETE

Parameters

Name	Located in	Description	Required	Schema
			No	template_group_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

GET

Parameters

Name	Located in	Description	Required	Schema
			No	template_group_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

PUT

Parameters

Name	Located in	Description	Required	Schema
			No	template_group_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

/template_groups/{template_group_id}/templates

GET

Parameters

Name	Located in	Description	Required	Schema
			No	template_group_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

/templates

GET

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

POST

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
201	Template was created

Security

Security Schema	Scopes
cognito

/templates/discover_repo_tags

POST

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Tags

Security

Security Schema	Scopes
cognito

/templates/{template_id}

DELETE

Parameters

Name	Located in	Description	Required	Schema
			No	template_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

GET

Parameters

Name	Located in	Description	Required	Schema
			No	template_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

PUT

Parameters

Name	Located in	Description	Required	Schema
			No	template_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

/templates/{template_id}/discover_repo_tags

GET

Parameters

Name	Located in	Description	Required	Schema
			No	template_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Tags

Security

Security Schema	Scopes
cognito

/templates/{template_id}/latest

GET

Parameters

Name	Located in	Description	Required	Schema
			No	template_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

/templates/{template_id}/tags

GET

Parameters

Name	Located in	Description	Required	Schema
			No	template_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

POST

Parameters

Name	Located in	Description	Required	Schema
			No	template_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Tags

Security

Security Schema	Scopes
cognito

PUT

Parameters

Name	Located in	Description	Required	Schema
			No	template_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Tags

Security

Security Schema	Scopes
cognito

/templates/{template_id}/tags/{tag}

DELETE

Parameters

Name	Located in	Description	Required	Schema
			No	template_id
			No	tag
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

GET

Parameters

Name	Located in	Description	Required	Schema
			No	template_id
			No	tag
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

PATCH

Parameters

Name	Located in	Description	Required	Schema
			No	template_id
			No	tag
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

/tenants

GET

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

POST

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
201

Security

Security Schema	Scopes
cognito

/tenants/{tenant_id}

DELETE

Parameters

Name	Located in	Description	Required	Schema
			No	tenant_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

GET

Parameters

Name	Located in	Description	Required	Schema
			No	tenant_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

PUT

Parameters

Name	Located in	Description	Required	Schema
			No	tenant_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
204	Operation was successful

Security

Security Schema	Scopes
cognito

/tenants/{tenant_id}/deployments

GET

Parameters

Name	Located in	Description	Required	Schema
			No	tenant_id
			No	organization_id_header
			No	domain_name_header
target_id	query		No	string
archived	query		No	boolean
awaiting_approval	query		No	boolean
approval_type	query		No	string

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

POST

Parameters

Name	Located in	Description	Required	Schema
			No	tenant_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
201

Security

Security Schema	Scopes
cognito

/tenants/{tenant_id}/deployments/history/{run_id}

GET

Parameters

Name	Located in	Description	Required	Schema
run_id	path		Yes	string
			No	tenant_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Status of current resource

Security

Security Schema	Scopes
cognito

/tenants/{tenant_id}/deployments/{deployment_id}

DELETE

Parameters

Name	Located in	Description	Required	Schema
			No	deployment_id
			No	tenant_id
			No	organization_id_header
			No	domain_name_header
operation_type	query		Yes	string

Responses

Code	Description
200	Operation was successful

Security

Security Schema	Scopes
cognito

GET

Parameters

Name	Located in	Description	Required	Schema
			No	deployment_id
			No	tenant_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Status of current resource

Security

Security Schema	Scopes
cognito

PUT

Parameters

Name	Located in	Description	Required	Schema
			No	deployment_id
			No	tenant_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Status of current resource

Security

Security Schema	Scopes
cognito

/tenants/{tenant_id}/deployments/{deployment_id}/confirm

POST

Parameters

Name	Located in	Description	Required	Schema
deployment_id	path		Yes	string
			No	tenant_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Status of current resource

Security

Security Schema	Scopes
cognito

/tenants/{tenant_id}/deployments/{deployment_id}/history

GET

Parameters

Name	Located in	Description	Required	Schema
deployment_id	path		Yes	string
			No	tenant_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Status of current resource

Security

Security Schema	Scopes
cognito

/tenants/{tenant_id}/deployments/{deployment_id}/stages/{stage_id}

GET

Parameters

Name	Located in	Description	Required	Schema
			No	tenant_id
			No	deployment_id
			No	stage_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito

/tenants/{tenant_id}/deployments/{deployment_id}/stages/{stage_id}/approve

POST

Parameters

Name	Located in	Description	Required	Schema
deployment_id	path		Yes	string
			No	tenant_id
			No	stage_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Status of current resource

Security

Security Schema	Scopes
cognito

/tenants/{tenant_id}/deployments/{deployment_id}/stages/{stage_id}/logs/{run_id}

GET

Parameters

Name	Located in	Description	Required	Schema
run_id	path		Yes	string
			No	deployment_id
			No	tenant_id
			No	stage_id
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Status of current resource

Security

Security Schema	Scopes
cognito

/ui

GET

Parameters

Name	Located in	Description	Required	Schema
			No	organization_id_header
			No	domain_name_header

Responses

Code	Description
200	Schema specification

Security

Security Schema	Scopes
cognito