v1

latestOpenAPI 3.0.02026-07-2634192196.8 KB

environments

Create an environment

Creates a new environment for the workspace associated with the Management API key. Maximum number of environments in defined by your plan limits. If you need additional environments, contact our support team.

post/environments

Headers

X-API-Versionstring required

Management API version.

Request body

namestring required

Name for the new environment

descriptionstring

Description for the environment

limit_mode'none' | 'restrict' | 'notify'

Limit mode for the environment

limit_valuenumber

Limit value for the environment (required when limitMode is not "none")

Response

Created environment object.

Example response

{
  "data": {
    "id": "ae_rrETjdWcfqI6AFsk",
    "name": "Default environment",
    "description": "Production environment",
    "limit_value": 100000,
    "restricted_at": "2024-05-31T01:24:39.506Z",
    "created_at": "2024-05-31T01:24:39.506Z",
    "updated_at": "2024-05-31T01:24:39.506Z"
  }
}