# Environment
# Environment
Creating, configuring, cost-tracking, budgeting and tearing down a dedicated cloud environment over HTTP.
An environment here is a whole cloud account, not a namespace: its own domain, its own certificates, its own API key, its own stack set. It is created, configured, metered against a budget and destroyed through calls.
Teardown is a first-class path with scripted removal of stacks, storage and identity, rather than an operational runbook someone follows by hand.
## How it works
Cost attribution reaches down to individual model conversations and up to a per-environment budget. Metering at that granularity is what makes a budget enforceable instead of advisory — a budget that can only be checked after the invoice arrives cannot stop anything.
A configuration check returns a vector of policy answers rather than a pass or fail, so an environment that is out of policy names which control it fell out of.
## Operations
### Activate Key
`POST` `/activate-key`
#### Activate Key for Environment
`activateKey`
Activate key used to activate a key for being used in the environment.
##### Request
application/json Copy
```
{
"api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```
##### Request body`application/json`
1 fields
| Field | Type | Description |
| --- | --- | --- |
| `api_key`required | `string` | X-api-key to be activated in the environmentExample `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` |
##### Response `200``application/json`
3 fields
Key activated.
| Field | Type | Description |
| --- | --- | --- |
| `fqdn`required | `string` | Fully qualified domain name of the environment where the key was activated. |
| `status`required | `string` | Status of the key activation. |
| `message`required | `string` | Message about the key activation. |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error`required | `string` | Error message. |
##### Response `404``application/json`
1 fields
Environment not found
| Field | Type | Description |
| --- | --- | --- |
| `error`required | `string` | Error message. |
##### Response `500``application/json`
1 fields
Key Activation error
| Field | Type | Description |
| --- | --- | --- |
| `error`required | `string` | Error message. |
##### Other responses
`403`
### Budgets
`PUT` `/budgets/{fqdn}`
#### Update environment budget
`updateBudget`
This API allows the Staircase Finance team to update the budget of a given environment.
##### Request
application/json Copy
```
{
"products": [
{
"product_name": "Language",
"monthly_budget": 1500
},
{
"product_name": "Batch",
"monthly_budget": 750
},
{
"product_name": "Datalake",
"monthly_budget": 750
}
]
}
```
##### Response
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | API-KEY received via email upon account creation |
| `fqdn` required | `string` path | `example.staircaseapi.com` | Environment fully qualified domain name. |
##### Request body`application/json`
1 fields
| Field | Type | Description |
| --- | --- | --- |
| `products`required | `object[]` | List of products and their monthly budget. |
| `product_name`required | `string` | Name of the product.Example `Environment` |
| `monthly_budget`required | `number` | Monthly budget for the product.Example `1000` |
##### Response `201``application/json`
3 fields
Environment creation In-progress.
| Field | Type | Description |
| --- | --- | --- |
| `domain_name`required | `string` | Fully qualified domain name of the environment. |
| `monthly_budget`required | `object` | Monthly budget for the environment. |
| `products` | `object[]` | List of products and their monthly budget. |
| `product_name`required | `string` | Name of the product.Example `Environment` |
| `monthly_budget`required | `number` | Monthly budget for the product.Example `1000` |
| `last_update_datetime`required | `string` | Last update time stamp. |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `401``application/json`
1 fields
Unauthorized
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access. |
| `message` | `string` | Error message. |
##### Response `422``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
`PUT` `/budgets`
#### Create or update budget for products owned by team
`createOrUpdateTeamBudget`
Create or update team budget
This API manages and monitors daily spending on products for each company by storing budget information and summing all related spending per company and product. If spending exceeds the budget, it sends alerts to the company’s Slack #alerts-negative channel for each additional dollar spent.
##### Request
application/json Copy
```
{
"budget_per_day": 25,
"product_identifier": "c20994b0-be01-4421-a075-8dcea035d155",
"company_identifier": "01G52C9RCP0Q5C6JYEPE4487VV"
}
```
##### Response
200400
application/json Copy Environment creation In-progress.
```
{
"budget_per_day": 25,
"product_identifier": "c20994b0-be01-4421-a075-8dcea035d155",
"company_identifier": "01G52C9RCP0Q5C6JYEPE4487VV"
}
```
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | API-KEY received via email upon account creation |
##### Request body`application/json`
3 fields
| Field | Type | Description |
| --- | --- | --- |
| `budget_per_day`required | `number` | US dollars per day.Example `25` |
| `product_identifier`required | `string` | Product identifier.Example `c20994b0-be01-4421-a075-8dcea035d155` |
| `company_identifier`required | `string` | Company identifier fromExample `01G52C9RCP0Q5C6JYEPE4487VV` |
##### Response `200``application/json`
3 fields
Environment creation In-progress.
| Field | Type | Description |
| --- | --- | --- |
| `budget_per_day`required | `number` | US dollars per day.Example `25` |
| `product_identifier`required | `string` | Product identifier.Example `c20994b0-be01-4421-a075-8dcea035d155` |
| `company_identifier`required | `string` | Company identifier fromExample `01G52C9RCP0Q5C6JYEPE4487VV` |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `401``application/json`
1 fields
Unauthorized
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access. |
| `message` | `string` | Error message. |
##### Response `422``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
### Costs
`GET` `/costs`
#### Retrieve product costs
`getProductCosts`
Retrieve the detailed product costs across the organization.
Due to the monthly billing cycle, the values will change until the end of the month is reached, and the final adjustments are applied.
The authorization access token for using this service can be obtained from Comply Authentication
##### Response
200400 application/json400 text/html
application/json Copy Response body with the detailed costs of a given product across all environments.
```
{
"total_cost": "$ 1785.4194 USD",
"costs_unit": "USD",
"total_cost_raw": 1785.4194,
"product_name": "Test",
"environments_count": 330,
"average_environment_cost": 5.4104,
"costs_by_environment": [
{
"costs": 146.4983,
"organization_id": "01G5XXXXXXXXXX93E41X70MXS",
"environment_domain": "my-subdomain.staircaseapi.com"
}
],
"costs_by_service": [
{
"aws_service": "Amazon EC2 Container Registry (ECR)",
"cost": 654.9967
},
{
"aws_service": "AWS Key Management Service",
"cost": 318.5916
},
{
"aws_service": "Amazon Simple Storage Service",
"cost": 13.0348
},
{
"aws_service": "AWS Lambda",
"cost": 7.3645
},
{
"aws_service": "AWS WAF",
"cost": 5.8065
},
{
"aws_service": "Amazon DynamoDB",
"cost": 1.9304
},
{
"aws_service": "AmazonCloudWatch",
"cost": 0.6591
},
{
"aws_service": "Amazon Simple Queue Service",
"cost": 0.5514
},
{
"aws_service": "CodeBuild",
"cost": 0
}
],
"costs_by_period": [
{
"time_period": "2022-08-01-2022-08-02",
"cost": 70.3507
},
{
"time_period": "2022-08-02-2022-08-03",
"cost": 76.8517
}
]
}
```
application/json Copy Bad request.
```
Bad request
```
text/html Copy Bad request.
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
5
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | X-API-KEY for using the service. |
| `Authorization` required | `string` header | `` | Authorization token. |
| `product_name` required | `string` query | `Environment` | Product name |
| `start_date` required | `string` query | `2022-01-01` | start date for the time range |
| `end_date` required | `string` query | `2022-01-31` | end date for the time range |
##### Response `200``application/json`
8 fields
Response body with the detailed costs of a given product across all environments.
| Field | Type | Description |
| --- | --- | --- |
| `total_costs`required | `string` | Formatted total costs for the given product name. |
| `costs_unit`required | `string` | Unit for the costs values. |
| `total_costs_raw`required | `number` | Total costs for the given product name. |
| `environments_count`required | `number` | Number of environments in which the product is deployed. |
| `average_environment_cost`required | `number` | Average cost per environments. |
| `costs_by_environment`required | `object[]` | List of Product costs per environment |
| `product_by_environment_costs` | `object` | Data object containing the Product costs per environment |
| `environment_domain` | `string` | Domain of the environment |
| `costs` | `number` | Product costs of the environment |
| `organization_id` | `string` | Domain of the environment |
| `costs_by_service`required | `object` | Product costs by AWS service |
| `costs_by_period` | `object` | Product costs by day |
##### Response `400``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Environment not found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `422``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Other responses
`401`
`GET` `/environment-costs/{api_key}`
#### Retrieve environment costs
`getEnvironmentCosts`
Retrieve environment costs.
When resource_details is set to true, the output will show the costs detailed by service instead of the component.
Due to the monthly billing cycle, the values will change until the end of the month is reached, and the final adjustments are applied.
This service only provides data for last 14 days. The authorization access token for using this service can be obtained from Comply Authentication
##### Response
400 application/json400 text/html
application/json Copy Bad request.
```
Bad request
```
text/html Copy Bad request.
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
6
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | X-API-KEY for using the service. |
| `Authorization` required | `string` header | `` | Authorization token. |
| `api_key` required | `string` path | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | X-API-KEY for the environment to query |
| `start_date` required | `string` query | `2022-01-01` | start date for the time range |
| `end_date` required | `string` query | `2022-01-31` | end date for the time range |
| `resource_details` | `boolean` query | `true` | If enabled it will show the Environment resources usage detail, resource details cannot be used with more that 14 days old dates. |
##### Response `200``application/json`
4 fields
Response body with the list of stacks deployed in a given environment.
| Field | Type | Description |
| --- | --- | --- |
| `unit`required | `string` | Currency |
| `total_cost`required | `string` | Total cost for the given environment. |
| `time_range`required | `object` | Time range queried. |
| `start_date`required | `string` | Start date for the time range queried |
| `end_date`required | `string` | End date for the time range queried |
| `usage_details`required | `object[]` | Usage details of the environment by stack name. |
| `service`required | `string` | Name of the resource service. |
| `cost`required | `string` | Total cost generated by the resource. |
##### Response `400``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Environment not found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `422``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Other responses
`401`
### EnvironmentCosts
`POST` `/costs`
#### Save Costs
`save-costs`
For tracking non AWS related costs.
Use this API for reporting usage of external services that are not tracked by AWS. For example, this API is used by the Bot product to report the price of conversation for specific bot.
##### Request
application/json Copy
```
{
"usage": 3,
"name": "Personal Identity Collector",
"invocation_id": "1234567890"
}
```
##### Response
text/html Copy Bad request.
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Request body`application/json`
3 fields
| Field | Type | Description |
| --- | --- | --- |
| `usage`required | `number` | Usage of the external service, in US Cents.Example `100` |
| `name`required | `string` | Name of the external service.Example `Personal Identity Collector` |
| `invocation_id` | `string` | Unique identifier for the invocation of the external service. |
##### Response `200``application/json`
1 fields
Response body with confirmation of the saved costs.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Confirmation message. |
##### Response `400``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
### Environment
`POST` `/environment`
#### Create Environment
`createEnvironment`
Create environment
This service allows you to create a staircase environment for with a given subdomain.
You can also include a callback URL with an optional payload to get notified automatically after your environment creation is finished;
After the environment is created it is subscribed to Environment and Deploy products automatically.
- Callback payload request example:
```
{
"api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"subdomain": "my-env",
"organization_id": "26d4253f8509"
"callback_url": "",
"callback_payload": {"callback_id":"identifier_callback"}
}
```
- Callback payload response example:
```
{
"environment_status": "ACTIVE",
"environment_fqdn": "my-env.staircaseapi.com",
"message": "Environment ready to use",
"callback_payload": {"callback_id":"identifier_callback"}
}
```
##### Request
application/json Copy
```
{
"subdomain": "mysubdomain",
"api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"organization_id": "26d4253f8509",
"callback_url": "https://mycallbak_url.com/callback_url",
"callback_payload": {
"callback_id": "identifier_callback"
}
}
```
##### Response
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | API-KEY received via email upon account creation |
##### Request body`application/json`
5 fields
| Field | Type | Description |
| --- | --- | --- |
| `subdomain`required | `string` | Subdomain for the New Staircase environment.Example `marketplace` |
| `api_key`required | `string (uuid)` | API-KEY received via email upon account creationExample `` |
| `organization_id` | `string` | Organization ID to which the account belongs toExample `b665gncdb891` |
| `callback_url` | `string` | Callback URL POST endpoint to be called upon environment creation completionExample `https://mycallbak_url.com/callback_url` |
| `callback_payload` | `object` | User defined payload to be sent to the callback URL suppliedExample `{'callback_id':'identifier_callback'}` |
##### Response `201``application/json`
2 fields
Environment creation In-progress.
| Field | Type | Description |
| --- | --- | --- |
| `staircase_environment`required | `object` | Staircase Environment creation status. |
| `api_key`required | `string` | Unique identifier for the environment. |
| `status_url`required | `string` | URL for checking the status while it's not Active. |
| `status`required | `string` | Status of the environment creation. |
| `message`required | `string` | Status description message. |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `401``application/json`
1 fields
Unauthorized
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access. |
| `message` | `string` | Error message. |
##### Response `422``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
`PUT` `/environment`
#### Update Environment Data
`updateEnvironmentData`
This service allows you to update the environment data such as organization ID
##### Request
application/json Copy
```
{
"api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"organization_id": "26d4253f8509"
}
```
##### Response
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | API-KEY received via email upon account creation |
##### Request body`application/json`
2 fields
| Field | Type | Description |
| --- | --- | --- |
| `api_key`required | `string (uuid)` | API-KEY received via email upon account creationExample `` |
| `organization_id`required | `string` | Organization ID to which the account belongs toExample `b665gncdb891` |
##### Response `200``application/json`
2 fields
Environment Data Update.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Status description message. |
| `status`required | `string` | Status of the operation executed |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `401``application/json`
1 fields
Unauthorized
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access. |
| `message` | `string` | Error message. |
##### Response `422``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
`DELETE` `/environment`
#### Disable Environment
`disableEnvironment`
This service allows you to disable a given environment. Disabling an environment will delete all the resources in it and the environment will not be recoverable The authorization access token for using this service can be obtained from Comply Authentication The token requires an admin level permission
##### Response
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Account-key received via email upon account creation. |
| `environment_fqdn` required | `string` query | `my-env.staircaseapi.com` | Fully qualified domain name of the staircase environment. |
##### Response `200``application/json`
2 fields
Environment Data Update.
| Field | Type | Description |
| --- | --- | --- |
| `environment_fqdn`required | `string` | Fully qualified domain name of the environment. |
| `organization_id`required | `string` | Organization ID of the queried environment. |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `401``application/json`
1 fields
Unauthorized
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access. |
| `message` | `string` | Error message. |
##### Response `422``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
`GET` `/environment`
#### Get Environment Data
`getEnvironmentData`
This service allows you to retrieve the environment data such as organization ID
##### Response
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Account-key received via email upon account creation. |
| `environment_fqdn` required | `string` query | `my-env.staircaseapi.com` | Fully qualified domain name of the staircase environment. |
##### Response `200``application/json`
5 fields
Environment Data Update.
| Field | Type | Description |
| --- | --- | --- |
| `environment_fqdn`required | `string` | Fully qualified domain name of the environment. |
| `organization_id`required | `string` | Organization ID of the queried environment. |
| `environment_owner`required | `string` | Owner email of the queried environment. |
| `company_name`required | `string` | Company name of queried environment. |
| `last_updated_at`required | `string` | When environment was updated. |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `401``application/json`
1 fields
Unauthorized
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access. |
| `message` | `string` | Error message. |
##### Response `422``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
`DELETE` `/environment/delete`
#### Clean Environment
`disableEnvironment`
This service allows you to clean a given environment. Cleaning an environment will delete all the resources in it and the environment will not be recoverable
##### Request
application/json Copy
```
{
"target_account_id": "123456789033"
}
```
##### Response
application/json Copy Request data invalid
```
{
"message": "target_account_id must be provided."
}
```
##### Request body`application/json`
3 fields
| Field | Type | Description |
| --- | --- | --- |
| `target_account_id`required | `string` | AWS account ID of the environment to be cleaned. The account ID must be a 12-digit number within Staircase organization. |
| `callback_url` | `string (uri)` | URL to be called when the cleaning process is complete. The URL must be accessible from the internet.s |
| `resources_to_retain` | `object` | Object specifying arrays of S3 and Glue resources to be retained during cleanup. Each array contains objects representing individual resources. A report will be generated post-cleanup detailing retained and removed resources. In case of errors in retaining a specified resource, the user will be notified for manual intervention. |
| `S3` | `object[]` | Array of objects, each representing an S3 bucket name to be retained. |
| `bucket_name`required | `string` | Name of the S3 bucket to be retained. |
| `Glue` | `object[]` | Array of objects, each representing a Glue resource to be retained. |
| `database_name`required | `string` | Name of the Glue database to be retained. |
| `IAMUser` | `string` | IAM User to be retained. |
##### Response `200``application/json`
1 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `job_id`required | `string` | ID of the cleaning job.Example `01GXQZV8M1V57GEZHK29SR1J3J` |
##### Response `400``application/json`
1 fields
Request data invalid
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message |
`POST` `/`
#### Add region
`addRegion`
This service allows you to configure new region is this environment, so it will be ready to get Staircase bundles deployed in it WAF distribution will be created. The distribution ID will be available inside the environment token data. api.subdomain.staircaseapi.com custom API GW domain name will be created. {region_name}.subdomain.staircaseapi.com custom API GW domain name will be created. Route53 failover configuration will be created for api.subdomain.staircaseapi.com and used for the health checks managed by the Environment product. Route53 us-east-1.domain.com to direct to API Gateway on us-east-1
##### Request
application/json Copy
```
{
"region_name": "us-east-2"
}
```
##### Response
200400
application/json Copy Ok.
```
{
"message": "Region added"
}
```
application/json Copy Request data invalid
```
{
"message": "Request body is invalid."
}
```
##### Request body`application/json`
1 fields
| Field | Type | Description |
| --- | --- | --- |
| `region_name`required | `string` | Region name`us-east-2``us-west-1``us-west-2`Example `us-east-2` |
##### Response `200``application/json`
1 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | message |
##### Response `400``application/json`
1 fields
Request data invalid
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message |
`GET` `/stacks/{api_key}`
#### Retrieve environment products
`getProductsDeployed`
Retrieve the environment products
Get environment components Fetch list of deployed components in a given environment. The authorization access token for using this service can be obtained from Comply Authentication
##### Response
400 application/json400 text/html
application/json Copy Bad request.
```
Bad request
```
text/html Copy Bad request.
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
3
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | X-API-KEY for using the service. |
| `Authorization` required | `string` header | `` | Authorization token. |
| `api_key` required | `string` path | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Environment API-KEY |
##### Response `200``application/json`
1 fields
Response body with the list of stacks deployed in a given environment.
| Field | Type | Description |
| --- | --- | --- |
| `stacks`required | `object[]` | List of stacks in the environment |
| `stack_name` | `string` | Name of the stack deployed. |
| `stack_status`required | `string` | Current status of the stack. |
| `created_at`required | `string` | Creation time stamp. |
| `last_updated_at`required | `string` | Last update time stamp. |
##### Response `400``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Environment not found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `422``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Other responses
`401`
### Hello
`POST` `/hello-world`
#### Hello
`execute_query`
Hello World
Dummy hello world endpoint
##### Response
application/json Copy Ok.
```
{
"message": "ok"
}
```
##### Response `200``application/json`
1 fields
Ok.
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Hello message.Example `ok` |
### Products
`GET` `/product-deployments`
#### Retrieve products deployments
`getProductDeployments`
Retrieve product deployments
Retrieve all the environments in which the product is deployed with their Health API KEY. The authorization access token for using this service can be obtained from Comply Authentication
##### Response
400 application/json400 text/html
application/json Copy Bad request.
```
Bad request
```
text/html Copy Bad request.
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
3
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | X-API-KEY for using the service. |
| `Authorization` required | `string` header | `` | Authorization token. |
| `base_path` required | `string` query | `code-tester` | The base path of the product you want to query |
##### Response `200``application/json`
1 fields
Response body with the list of environments in which the product is deployed.
| Field | Type | Description |
| --- | --- | --- |
| `environments`required | `object[]` | List of environments with the base path given present. |
| `domain_name`required | `string` | Name of the stack. |
| `api_key`required | `string` | Health API KEY |
##### Response `400``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Environment not found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `422``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Other responses
`401`
### EnvironmentManager
`DELETE` `/products`
#### Delete deployed product
`deleteProductServices`
This service triggers the deletion of a given product, if no specific services are given all the services deployed for the given product name will be deleted. Deletion of a given service or services will remove the resources and will cause loss of data. Admin level permissions are necessary for deleting products from a Staircase environment, unless you are the owner of the environment. The authorization access token for using this service can be obtained from Comply Authentication
##### Request
application/json Copy
```
{
"product_name": "Test",
"services": [
{
"service_name": "service-code-tester"
}
]
}
```
##### Response
201400
application/json Copy Environment creation In-progress.
```
[
{
"status": "SUBMITTED"
}
]
```
text/html Copy Bad request.
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `Authorization` required | `string` header | `` | Authorization token, obtained through comply service. |
##### Request body`application/json`
2 fields
| Field | Type | Description |
| --- | --- | --- |
| `product_name`required | `string` | Name of the product to be deletedExample `Test` |
| `services` | `object[]` | List of services to be deleted |
| `service_name`required | `string` | Name of the service to be deletedExample `service-code-tester` |
##### Response `201``application/json`
1 fields
Environment creation In-progress.
| Field | Type | Description |
| --- | --- | --- |
| `status`required | `string` | Status of the deletion.Example `SUBMITTED` |
##### Response `400``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `401``application/json`
1 fields
Unauthorized
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access. |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Environment not found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `422``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `500``application/json`
1 fields
Environment creation failure.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
`GET` `/products`
#### Get Deployed Products
`getDeployedProducts`
Retrieve the products deployed in the environment
Get deployed products Retrieves a list of the products deployed in the environment with their respective components. The authorization access token for using this service can be obtained from Comply Authentication
##### Response
200400
application/json Copy Response body with the list of products and services deployed in the staircase environment.
```
[
[
{
"product_name": "Environment",
"services": [
{
"service_name": "environment-manager",
"status": "UPDATED"
},
{
"service_name": "environment-administrator",
"status": "UPDATED"
}
]
}
]
]
```
text/html Copy Bad request.
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `Authorization` required | `string` header | `` | Authorization token, obtained through comply service. |
##### Response `200``application/json`
2 fields
Response body with the list of products and services deployed in the staircase environment.
| Field | Type | Description |
| --- | --- | --- |
| `product_name`required | `string` | Product Name deployed in the staircase environment. |
| `services`required | `object[]` | List of services attached to the product. |
| `status`required | `string` | Deployment status of the service. |
| `service_name`required | `string` | Name of the service deployed. |
##### Response `400``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `401``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Product not found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
`GET` `/products/{product_name}`
#### Get Deployed Product
`getDeployedProductServices`
Retrieve the details of a product deployed in the environment
Get deployed products Retrieves the list of services deployed containing status and service name for the product name given, as log as it is deployed in the staircase environment. The authorization access token for using this service can be obtained from Comply Authentication
##### Response
200400
application/json Copy Response body with the list of services deployed in the staircase environment for the provided product name.
```
[
[
{
"service_name": "environment-manager",
"status": "UPDATED"
},
{
"service_name": "environment-administrator",
"status": "UPDATED"
}
]
]
```
text/html Copy Bad request.
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `Authorization` required | `string` header | `` | Authorization token, obtained through comply service. |
| `product_name` required | `string` path | `Environment` | Name of the product to query |
##### Response `200``application/json`
2 fields
Response body with the list of services deployed in the staircase environment for the provided product name.
| Field | Type | Description |
| --- | --- | --- |
| `status`required | `string` | Deployment status of the service. |
| `service_name`required | `string` | Name of the service deployed. |
##### Response `400``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `401``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Environment not found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
`GET` `/service-key`
#### Get Service Key
`get-service-key`
Get service key
Environment service API-KEY can be used for retrieving telemetry data. Health product accepts it as X-API-KEY header, enabling products and teams to querying metrics for products deployed in the environment. The authorization access token for using this service can be obtained from Comply Authentication
##### Response
text/html Copy Bad request.
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | X-API-KEY for using the service. |
| `Authorization` required | `string` header | `` | Authorization token, obtained through comply service. |
##### Response `200``application/json`
1 fields
Response body with the environment status and, environment details
| Field | Type | Description |
| --- | --- | --- |
| `service_key`required | `string` | UUID value of the service key. |
##### Response `400``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `401``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Not found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `500``application/json`
1 fields
Service key error.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
`GET` `/budgets`
#### Get Budgets
`get-budgets-list`
List of currently applied budgets for this environment.
List of currently applied budgets for this environment. It calculates only for resources tagged with "sc:product:name" tag with this value. Budget is always monthly.
##### Response `200``application/json`
1 fields
Response body with the environment current budgets per product.
| Field | Type | Description |
| --- | --- | --- |
| `budgets` | `object[]` | List of budgets per product. |
| `product`required | `string` | Product name. It calculates only for resources tagged with "sc:product:name" tag with this value. |
| `amount`required | `string` | Budget amount in US Dollars per month. |
`PATCH` `/budgets`
#### Update Budgets
`update-budgets`
Update the thresholds for the budgets.
Update the threshold for specific products.
##### Response
text/html Copy Bad request.
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Response `200``application/json`
1 fields
Response body with the environment updated budgets.
| Field | Type | Description |
| --- | --- | --- |
| `budgets` | `object[]` | List of budgets per product. |
| `product`required | `string` | Product name. It calculates only for resources tagged with "sc:product:name" tag with this value. |
| `amount`required | `string` | Budget amount in US Dollars per month. |
##### Response `400``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
### Reports
`GET` `/reports`
#### Get Cost Reports
`getCostReports`
Provides reports about AWS costs produced by Staircase Products deployed to Staircase Environments.
The unit type of the all costs in reports is presented in cents by default. You can change it to "USD" by passing it as a query parameter `costs_unit_type`.
If start_date and end_date are not specified, the default date range is the last 30 days.
##### Response
text/html Copy Bad request.
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
6
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `start_date` | `string` query | `2023-01-01` | Start date. |
| `end_date` | `string` query | `2023-02-01` | End date. |
| `granularity` | `string` query | `DAILY` | Granularity. |
| `customer_company_name` | `string` query | `Bank Of America` | Customer company name. Case insensitive. |
| `staircase_team` | `string` query | `Cerf` | Staircase team name. Case insensitive. |
| `costs_unit_type` | `string` query | `USD` | Costs unit type. If not specified, the default unit type is CENT. |
##### Response `200``application/json`
5 fields
Response body
| Field | Type | Description |
| --- | --- | --- |
| `date_range`required | `object` | The date range for which the report is applicable. |
| `start`required | `string` | The start date of the range in YYYY-MM-DD format. |
| `end`required | `string` | The end date of the range in YYYY-MM-DD format. |
| `costs_unit_type`required | `string` | The unit type of costs in reports.`CENT``USD`Example `USD` |
| `granularity` | `string` | The dates granularity of the report.`DAILY``MONTHLY``NONE`Example `DAILY` |
| `products`required | `object[]` | A list of Staircase products included in the report. Data bundles are united to a single "Data Bundles" product. |
| `product_name` | `string` | The name of the product. |
| `reports`required | `object[]` | A collection of cost reports, each corresponding to a single time period. If 'granularity' query parameter is not NONE, it might contain more than one report object. |
| `type`required | `string` | The type of report.`COSTS_PER_ENVIRONMENT_PER_PRODUCT` |
| `date_range` | `object` | The date range for which the report is applicable. |
| `start`required | `string` | The start date of the range in YYYY-MM-DD format. |
| `end`required | `string` | The end date of the range in YYYY-MM-DD format. |
| `result`required | `object[]` | An array of results, each representing a different environment. |
| `environment`required | `string` | The name or identifier of the environment. |
| `total_cost`required | `integer` | The total cost associated with this environment. |
| `costs_per_product_sum`required | `integer` | The sum of costs broken down per product. |
| `costs_per_product`required | `object` | A breakdown of costs per product. |
| `unknown_product_cost`required | `integer` | Costs associated with unknown or unclassified products. |
| `staircase_team`required | `string` | The name of the Staircase team owning the environment. |
| `customer_company_name`required | `string` | The name of the customer company owning the environment. |
##### Response `400``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `401``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
### Configurations
`POST` `/update-configurations`
#### Update configurations
`update-configurations`
Update Configurations
Update environment configurations validates the latest configurations of the environment and if they are not up-to-date it updates them.
##### Request
application/json Copy
```
{
"api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```
##### Response
text/html Copy Bad request.
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `Authorization` required | `string` header | `` | Authorization token, obtained through comply service. |
##### Request body`application/json`
1 fields
| Field | Type | Description |
| --- | --- | --- |
| `api_key`required | `string (uuid)` | API-KEY received via email upon account creationExample `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` |
##### Response `201``application/json`
1 fields
Environment creation In-progress.
| Field | Type | Description |
| --- | --- | --- |
| `staircase_environment` | `object` | Staircase Environment creation status. |
| `status`required | `string` | Status of the environment configurations update process.`UPDATED``UPDATE_FAILED``UPDATING` |
| `message`required | `string` | Information message for the given status |
##### Response `400``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `401``application/json`
1 fields
Unauthorized
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access. |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Environment not found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `422``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `500``application/json`
1 fields
Environment creation failure.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
`GET` `/get-configurations/{api_key}`
#### Get configurations
`get-configurations`
Get the environment configurations Fetch the status of the environment configurations.
##### Response
text/html Copy Bad request.
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `Authorization` required | `string` header | `` | Authorization token, obtained through comply service. |
| `api_key` required | `string` path | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Environment API-KEY |
##### Response `200``application/json`
11 fields
Response body with the environment status and, environment details
| Field | Type | Description |
| --- | --- | --- |
| `MFA_Enabled`required | `string` | Status of the user with MFA_Enabled configuration.`MISSING``OK` |
| `Login_Restricted`required | `string` | Status of the AWS console login restriction.`MISSING``OK` |
| `Main_Certificate`required | `string` | Status of the Main Certificate configuration.`MISSING``OK` |
| `Wild_Certificate`required | `string` | Status of the Wild Certificate configuration.`MISSING``OK` |
| `Email_Domain`required | `string` | Status of the Email Domain configuration.`MISSING``OK` |
| `DKIM_Verification`required | `string` | Status of the DKIM verification.`MISSING``OK` |
| `MX_Records`required | `string` | Status of the MX DNS records.`MISSING``OK` |
| `API_Gateway`required | `string` | Status of the API GW Configuration.`MISSING``OK` |
| `Health_Service_Key`required | `string` | Status of the Health service API key configuration.`MISSING``OK` |
| `VPC_Flow_Logs` | `string` | Status of the VPC Flow Log configuration.`MISSING``OK` |
| `CloudFront_Distribution`required | `string` | Status of the CloudFront distribution configuration.`MISSING``OK` |
##### Response `400``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `401``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Environment not found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `500``application/json`
1 fields
Server error.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
### Status
`GET` `/environment/delete/{id}`
#### Retrieve Cleaning Status
`getCleaningStatus`
Foo
##### Response
400404
text/html Copy Bad request.
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
application/json Copy Cleaning invocation was not found.
```
{
"status": "NOT_FOUND"
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `id` required | `string` path | `490kokf3-aa93-409f-b4e7-756e019d83f5` | The cleaning invocation ID. |
##### Response `200``application/json`
2 fields
Cleaning job invocation status.
| Field | Type | Description |
| --- | --- | --- |
| `status`required | `string` | Status of the cleaning job invocation.`FAILED``IN_PROGRESS``NOT_FOUND``RUNNING``SUCCEEDED` |
| `logs`required | `string` | Logs of the cleaning invocation. |
##### Response `400``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting an X-API-KEY. |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Cleaning invocation was not found.
| Field | Type | Description |
| --- | --- | --- |
| `status` | `string` | Status of the cleaning job.`NOT_FOUND` |
### Environment Creator
`POST` `/vendors/staircase/flows/env-create/jobs`
#### Invoke Create Environment Flow
`invokeCreateEnvironmentFlow`
This endpoint allows launching Create Environment Flow.
It is an asynchronous job, so response contains `job_id`, that allows to track the job's execution here. Result of the job will be sent to the `callback_url` specified in the appropriate field. If job finishes successfully, `job_status` will be "Completed"; `response_payload` will contain the `api_key`, `domain`, `subdomain` and `organization_id`, and it will look like this:
Show the rest
```
{
"job_id": "e26ffa3d-4ae6-4582-8982-5d61f8a75c54",
"job_status": "Completed",
"transaction_id": "01F7S0N7CQ31DZQYVSVPN66GNK",
"request_collection_id": "01F7S0X38J6R41HW279D8YP8KJ",
"response_collection_id": "01F7S0YSQPGW9WC51378PR7TM3",
"response_payload": {
"api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"domain": "organization-a1b2c3d4e5f6",
"subdomain": "organization-a1b2c3d4e5f6.staircaseapi.com",
"organization_id": "4321-4321-4321-4321-4321"
}
}
```
If job fails to complete, `job_status` will be "Failed" and `response_payload` will contain detailed information about failed job (`Error` and `Cause` fields), and will look like this:
```
{
"job_id": "98da2ca6-8fbb-4f00-bde9-91f8b33712f2",
"job_status": "Failed",
"transaction_id": "01FYRX3TTMKSR6XG070GA3MG17",
"request_collection_id": null,
"response_collection_id": null,
"response_payload": {
"Error": "CallVendorError",
"Cause": {
"errorMessage": {
"message": "A company_organization with company \"X\" and organization \"X-org-1\" already exists."
},
"errorType": "CallVendorError",
"requestId": "77a1db7e-12d4-42f3-887e-82387a2ca8cd"
}
},
"status_code": null
}
```
For testing, you can use webhook.site service. With this, you instantly get a unique, random URL that you can put into the `callback_url` field and use it to receive HTTP requests.
##### Request
application/json Copy
```
{
"transaction_id": "01F7S0N7CQ31DZQYVSVPN66GNK",
"callback_url": "https://webhook.site/cc87117a-36ee-4b8b-b098-e9cf209821a2",
"request_payload": {
"organization_name": "Org-1",
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@domain.com"
}
}
```
##### Response
202400
application/json Copy Request accepted
```
{
"job_id": "160701d5-a034-41db-aade-26e4134ac8bb",
"job_status": "Started"
}
```
application/json Copy Bad request
```
{
"message": {
"schema_type": [
"Must be one of: create, update."
]
}
}
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `product_name` required | `string` query | `environment-creator` | This parameter is required to be `environment-creator`. Anything else would cause a failure |
##### Request body`application/json`
5 fields
| Field | Type | Description |
| --- | --- | --- |
| `transaction_id`required | `string` | Transaction ID |
| `request_collection_id` | `string` | Request collection ID |
| `response_collection_id` | `string` | Response collection ID |
| `callback_url`required | `string (uri)` | Destination URL on which final result of the flow execution will be sent |
| `request_payload`required | `object` | Data that have to passed into the flow |
| `organization_name`required | `string` | Name of the Organization that Environment will belong to |
| `first_name`required | `string` | First Name of the owner of Account that Environment will belong to |
| `last_name`required | `string` | Last Name of the owner of Account that Environment will belong to |
| `email`required | `string` | Email of the owner of Account that Environment will belong to |
##### Response `202``application/json`
2 fields
Request accepted
| Field | Type | Description |
| --- | --- | --- |
| `job_id` | `string` | Execution ID |
| `job_status` | `string` | Execution status |
##### Response `400``application/json`
1 fields
Bad request
| Field | Type | Description |
| --- | --- | --- |
| `message` | `one of` | Either message or object with additional properties. |
##### Response `403``application/json`
2 fields
Forbidden
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Request forbidden -- authorization will not help |
| `url` | `string (url)` | Indicates at which url the error occurs |
##### Response `404``application/json`
1 fields
Partner or flow not found
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Nothing matches the given URI |
`GET` `/vendors/staircase/flows/env-create/jobs/{job_id}`
#### Retrieve Create Environment Flow Execution Status
`retrieveCreateEnvironmentFlowExecutionStatus`
Retrieve flow execution status of Create Environment flow
This endpoint allows getting status of the Create Environment Flow.
##### Response
200400
application/json Copy Execution status successfully retrieved
```
{
"status": "FAILED",
"executed_events": [
"GetCredentials",
"Wait1",
"Wait2"
],
"last_event": "Wait2",
"details": [
{
"event_id": 2,
"event_type": "stateEnteredEventDetails",
"event_name": "GetCredentials",
"timestamp": "2021-06-10 23:25:27.661000+03:00",
"previous_event_id": 0,
"input_details": {}
},
{
"event_id": 6,
"event_type": "stateExitedEventDetails",
"event_name": "GetCredentials",
"timestamp": "2021-06-10 23:25:30.280000+03:00",
"previous_event_id": 5
},
{
"event_id": 7,
"event_type": "stateEnteredEventDetails",
"event_name": "Wait1",
"timestamp": "2021-06-10 23:25:30.289000+03:00",
"previous_event_id": 6,
"input_details": {}
},
{
"event_id": 8,
"event_type": "stateExitedEventDetails",
"event_name": "Wait1",
"timestamp": "2021-06-10 23:25:40.289000+03:00",
"previous_event_id": 7
},
{
"event_id": 9,
"event_type": "stateEnteredEventDetails",
"event_name": "Wait2",
"timestamp": "2021-06-10 23:25:40.296000+03:00",
"previous_event_id": 8,
"input_details": {}
},
{
"event_id": 10,
"event_type": "executionFailedEventDetails",
"timestamp": "2021-06-10 23:25:40.296000+03:00",
"previous_event_id": 0,
"error": {
"type": "Runtime",
"cause": "An error occurred while executing the state 'Wait2' (entered at the event id #9). The SecondsPath parameter does not reference an input value: $.request_payload.sec"
}
}
],
"input": {
"callback_url": "https://rock.site/09876ercftvghnj3iy4738c-3crv/",
"transaction_id": "01FG3YHN4FCJ4EYW6326ZAQW6Y",
"response_collection_id": "01FG3YHR1TYXTAAZZHMTX50HQV",
"request_collection_id": "01FG3YHQW2TY3A2GVKX5SXAB4D"
},
"output": {
"response_payload": {
"api_key": "",
"domain": "organization-a1b2c3d4e5f6",
"subdomain": "organization-a1b2c3d4e5f6.staircaseapi.com",
"organization_id": "4321-4321-4321-432"
}
}
}
```
application/json Copy Bad request
```
{
"message": {
"schema_type": [
"Must be one of: create, update."
]
}
}
```
##### Parameters
6
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `job_id` required | `string (uuid)` path | `7c668252-d2ba-job-id-896d-1f73236287d9` | Execution ID |
| `product_name` required | `string` query | `environment-creator` | This parameter is required to be `environment-creator`. Anything else would cause a failure |
| `detailed` | `string` query | `false` | Returns detailed execution history including execution data if set to `true`. Default `false`. |
| `next_token` | `string` query | `oei09uo8yr7tvweyuni29eirv9kod` | If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. |
| `reverse_order` | `string` query | `true` | Returns events in ascending order of their timeStamp if set to `false`. Default is descending `true`. |
| `max_results` | `integer` query | `100` | The maximum number of results that are returned per call. You can use next-token to obtain further pages of results. The default is 50 and the maximum allowed page size is 1000. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum. |
##### Response `200``application/json`
6 fields
Execution status successfully retrieved
| Field | Type | Description |
| --- | --- | --- |
| `status` | `string` | Execution status`ABORTED``FAILED``RUNNING``SUCCEEDED``TIMED_OUT` |
| `executed_events` | `string[]` | List of executed events |
| `last_event` | `string` | Last executed event |
| `details` | `object[]` | Executed events details |
| `input` | `object` | Short data you used for invoking the flow. |
| `transaction_id`required | `string` | Transaction ID |
| `request_collection_id`required | `string` | Request collection ID |
| `response_collection_id`required | `string` | Response collection ID |
| `callback_url`required | `string (uri)` | Destination URL on which final result of the flow execution was configured to be sent |
| `output` | `object` | Short data of the output. |
| `response_payload`required | `object` | Response payload. |
| `api_key` | `string` | — |
| `domain` | `string` | — |
| `subdomain` | `string` | — |
| `organization_id` | `string` | — |
| `extraction_errors`required | `one of` | Extraction errors. |
##### Response `400``application/json`
1 fields
Bad request
| Field | Type | Description |
| --- | --- | --- |
| `message` | `one of` | Either message or object with additional properties. |
##### Response `403``application/json`
2 fields
Forbidden
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Request forbidden -- authorization will not help |
| `url` | `string (url)` | Indicates at which url the error occurs |
##### Response `404``application/json`
1 fields
Partner, flow or execution not found
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Nothing matches the given URI |
`POST` `/vendors/staircase/flows/env-create/jobs/{job_id}`
#### Terminate Create Environment Flow Execution
`terminateCreateEnvironmentFlowExecution`
Terminate execution of Create Environment Flow
This endpoint allows stopping execution of Create Environment Flow.
##### Response
201400
application/json Copy Execution successfully terminated
```
{
"job_id": "9348765c-2eda-46d6-9214-7119c175dc5f",
"status": "ABORTED",
"stop_date": "2021-06-25 13:15:34.447000+03:00"
}
```
application/json Copy Bad request
```
{
"message": {
"schema_type": [
"Must be one of: create, update."
]
}
}
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `job_id` required | `string (uuid)` path | `7c668252-d2ba-job-id-896d-1f73236287d9` | Execution ID |
| `product_name` required | `string` query | `environment-creator` | This parameter is required to be `environment-creator`. Anything else would cause a failure |
##### Response `201``application/json`
3 fields
Execution successfully terminated
| Field | Type | Description |
| --- | --- | --- |
| `job_id` | `string` | Execution job id. |
| `status` | `string` | Status of the execution. |
| `stop_date` | `string` | Stop date. |
##### Response `400``application/json`
1 fields
Bad request
| Field | Type | Description |
| --- | --- | --- |
| `message` | `one of` | Either message or object with additional properties. |
##### Response `403``application/json`
2 fields
Forbidden
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Request forbidden -- authorization will not help |
| `url` | `string (url)` | Indicates at which url the error occurs |
##### Response `404``application/json`
1 fields
Partner, flow or execution not found
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Nothing matches the given URI |
`GET` `/vendors/staircase/flows/env-create/executions`
#### List Create Environment Flow Executions
`listCreateEnvironmentFlowExecutions`
Retrieve flow executions status
This endpoint allows getting status of flow executions.
##### Response
200400
application/json Copy Executions list successfully retrieved
```
{
"executions": [
{
"job_id": "6b54387a-fe7e-4fb0-ad2a-40c70ebd0f1c",
"flow_name": "ocrolus-ide-classify-and-extract",
"status": "SUCCEEDED",
"start_date": "2021-06-25 13:34:56.441000+03:00",
"stop_date": "2021-06-25 13:37:31.348000+03:00"
},
{
"job_id": "a32f4f6b-a906-4b11-9f96-edaf1dcac592",
"flow_name": "ocrolus-ide-classify-and-extract",
"status": "ABORTED",
"start_date": "2021-06-25 13:06:42.681000+03:00",
"stop_date": "2021-06-25 13:15:34.447000+03:00"
},
{
"job_id": "57340187-45f2-41ea-984a-cdc731a2d7f0",
"flow_name": "ocrolus-ide-classify-and-extract",
"status": "FAILED",
"start_date": "2021-06-25 13:02:19.838000+03:00",
"stop_date": "2021-06-25 13:11:07.252000+03:00"
}
],
"next_token": "AAAAKgAAAAIAAAAAAAAAAcsQMPbdXoFFnzT2rEqFsqrT0zHE/qEYZz+7bsEqn/szszKZGF+UqlAFcP48NpKsyXcxMIaopLnNb398gvFSPLP1AeV3K35+eWnxTNf0J8w+v3jiBLuzY/EaIPtvKlsUP7d1ARcA5Z2pppZqUkDNXgOqxMQTZPAbmyBNST+OdPbMylcX275vZ/0X4PyPvxnYgp53L97rJ0JMcQT/2+/Y8NAJQxsUESi00tv9E/glloA4hyvPAuFW6rZL8VY5bU7kh4LiPL9BmOhKaN+0QazQxaJZJmStj6jN2F27v0FpSkyl+ENTy4nZrw40PlRzg6Es8gZjxouPRD9erBiTahioV4lW9jpIu82rXX4N6e6lK5sfN+p68qNorq+F7jp9LokkC3idROMs4iB4OX2rX7YguDIbgg0NZneQndTE+Opph7eXlxMAXMIbxpSgI5TYyCQIP1GjsE66dCPldJBoogFv9IIEnt/38ZLpyOwwQnGVOLw8O/ARwH+Ev52AJIVUGVNqTA=="
}
```
application/json Copy Bad request
```
{
"message": {
"schema_type": [
"Must be one of: create, update."
]
}
}
```
##### Parameters
4
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `product_name` required | `string` query | `environment-creator` | This parameter is required to be `environment-creator`. Anything else would cause a failure |
| `next_token` | `string` query | `p9208y937gtyuhoivju38hry0gvy3ruhifnc3kcd` | If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. |
| `status_filter` | `string` query | `ABORTED` | If specified, only list the executions whose current execution status matches the given filter. |
| `max_results` | `integer` query | `100` | The maximum number of results that are returned per call. You can use next-token to obtain further pages of results. The default is 50 and the maximum allowed page size is 1000. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum. |
##### Response `200``application/json`
2 fields
Executions list successfully retrieved
| Field | Type | Description |
| --- | --- | --- |
| `next_token` | `string` | Pagination token to get next results |
| `executions` | `object[]` | List of executions |
| `job_id` | `string` | Execution ID |
| `flow_name` | `string` | Flow name |
| `status` | `string` | Execution status |
| `start_date` | `string` | Execution start date |
| `stop_date` | `string` | Execution stop date |
##### Response `400``application/json`
1 fields
Bad request
| Field | Type | Description |
| --- | --- | --- |
| `message` | `one of` | Either message or object with additional properties. |
##### Response `403``application/json`
2 fields
Forbidden
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Request forbidden -- authorization will not help |
| `url` | `string (url)` | Indicates at which url the error occurs |
##### Response `404``application/json`
1 fields
Partner, flow or execution not found
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Nothing matches the given URI |
### Operations
`POST` `/activate-auth-token`
#### Activate auth token
`activate-auth-token`
Activates the authentication token on the given environment such token is used for performing operations of management in the environment where the environment product is deployed. IMPORTANT right after deploying environment manager this endpoint should be called, the environment token retrieved by the service should be stored as it is a one time only allowed operation
##### Request
application/json Copy
```
{
"api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```
##### Response
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
1
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | X-API-KEY for using the service. |
##### Request body`application/json`
1 fields
| Field | Type | Description |
| --- | --- | --- |
| `api_key`required | `string (uuid)` | API-KEY received via email upon account creationExample `` |
##### Response `200``application/json`
2 fields
Token activated.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Successful token activation message.`Auth Token activated successfully` |
| `token`required | `string` | Authorization TokenExample `` |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `401``application/json`
1 fields
Unauthorized
| Field | Type | Description |
| --- | --- | --- |
| `message` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access. |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Environment not found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `422``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `500``application/json`
1 fields
Environment creation failure.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
`POST` `/disable-environment`
#### Disable environment
`disableEnvironment`
Disable environment used to disable and delete all the resources of a staircase environment assigned to the API-KEY provided.
##### Request
application/jsonExample
application/json Copy
```
{
"api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"subdomain": "environment-manager"
}
```
application/json Copy
```
{
"api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"subdomain": "mycoolsubdomain"
}
```
##### Response
text/html Copy Bad request.
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | API-KEY for using the endpoint. |
| `Authorization` required | `string` header | `` | Authorization token. |
##### Request body`application/json`
2 fields
| Field | Type | Description |
| --- | --- | --- |
| `api_key`required | `string` | API-KEY assigned to the environment to be disabled |
| `subdomain`required | `string` | Subdomain assigned to the environment to be disabled |
##### Response `202``application/json`
2 fields
Environment disabled.
| Field | Type | Description |
| --- | --- | --- |
| `message`required | `string` | Disable process status message. |
| `status`required | `string` | Status of the disabling process. |
##### Response `400``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `401``application/json`
3 fields
Unauthorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
| `Message` | `string` | Access denied error message. |
##### Response `403``application/json`
3 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
| `Message` | `string` | Access denied error message. |
##### Response `404``application/json`
1 fields
Environment not found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `422``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `500``application/json`
1 fields
Environment disable failure.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
`POST` `/documentation-activate-key`
#### Documentation environment key activation
`activateKey`
This service activates your API key and enables you to preview Staircase product APIs.
##### Request
application/json Copy
```
{
"api_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```
##### Response
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Request body`application/json`
1 fields
| Field | Type | Description |
| --- | --- | --- |
| `api_key`required | `string` | API-KEY to be activated in the documentation environment.Example `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` |
##### Response `200``application/json`
3 fields
Key activated.
| Field | Type | Description |
| --- | --- | --- |
| `fqdn`required | `string` | Fully qualified domain name of the environment where the key was activated. |
| `status`required | `string` | Status of the key activation. |
| `message`required | `string` | Message about the key activation. |
##### Response `400``application/json`
1 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Forbidden
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Environment not found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `500``application/json`
1 fields
Key Activation error
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
`GET` `/env-tools/maintenance-access`
#### Maintenance access
Retrieve a set of temporal credential for the environment to perform maintenance or support tasks
##### Response
text/html Copy Bad Request
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
4
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | X-API-KEY for using the service |
| `Authorization` required | `string` header | `` | Authorizartion token |
| `resource_type` | `string` query | `logs` | resource type for which the access will be granted |
| `access_level` | `string` query | `read` | level of access to the resource |
##### Response `200``application/json`
3 fields
Temporal login credentials
| Field | Type | Description |
| --- | --- | --- |
| `username` | `string` | Username allowed for the temporal access. |
| `account_alias` | `string` | Account alias to be used for accessing. |
| `password` | `string` | One time Password. |
##### Response `400``application/json`
2 fields
Bad Request
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL of the documentation |
| `message` | `string` | Error message. |
##### Response `401``application/json`
2 fields
Access Denied
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting proper access |
| `message` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting proper access |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Environment not found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `422``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `500``application/json`
1 fields
Maintenance access failure.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
`GET` `/environment/{api_key}`
#### Get environment status
`get-environment`
Get environment Fetch environment status.
##### Response
text/html Copy Bad request.
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | X-API-KEY for using the service. |
| `api_key` required | `string` path | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | Environment API-KEY |
##### Response `400``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `401``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Environment not found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `500``application/json`
1 fields
Environment creation failure.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Other responses
`200`
`GET` `/list-environments`
#### List active environments
`list-environments`
List environments Fetch list of active environments.
##### Response
400 application/json400 text/html
application/json Copy Bad request.
```
Bad request
```
text/html Copy Bad request.
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
2
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx` | X-API-KEY for using the service. |
| `Authorization` required | `string` header | `` | Authorization token. |
##### Response `200``application/json`
1 fields
Response body with the list of child environment active.
| Field | Type | Description |
| --- | --- | --- |
| `environments`required | `object[]` | List of active child environments FQDN and service API-KEY |
| `fqdn` | `string` | Domain name of the environment. |
| `service-key` | `string` | API-KEY of the environment. |
##### Response `400``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Environment not found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `422``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `500``application/json`
1 fields
Server error
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Other responses
`401`
`GET` `/service-key/{api_key}`
#### Get service API-KEY
`get-service-key`
Get service key Fetch service key value.
##### Response
text/html Copy Bad request.
```
\r\n400 Bad Request\r\n\r\n400 Bad Request
\r\n\r\n\r\n
```
##### Parameters
3
| Parameter | Type | Example | Description |
| --- | --- | --- | --- |
| `x-api-key` required | `string` header | `` | X-API-KEY for using the service. |
| `Authorization` required | `string` header | `` | Authorization token. |
| `api_key` required | `string` path | `` | Environment API-KEY |
##### Response `200``application/json`
1 fields
Response body with the environment status and, environment details
| Field | Type | Description |
| --- | --- | --- |
| `service_key`required | `string` | UUID value of the service key. |
##### Response `400``application/json`
1 fields
Bad request.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `401``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `403``application/json`
2 fields
Not Authorized
| Field | Type | Description |
| --- | --- | --- |
| `url` | `string` | URL for getting access |
| `message` | `string` | Error message. |
##### Response `404``application/json`
1 fields
Not found
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
##### Response `500``application/json`
1 fields
Service key error.
| Field | Type | Description |
| --- | --- | --- |
| `error` | `string` | Error message. |
## Errors
`400``401``403``404``422``500`
## More in Distribution
- Previous product: Console
- Next product: Finance