v1

latestOpenAPI 3.0.02026-07-2634192196.8 KB

environments

Update an environment

Updates an environment with the given environment ID. You can update the name, description, and limit settings.

post/environments/{id}

Path parameters

idstring required

Headers

X-API-Versionstring required

Management API version.

Request body

namestring

Name for the 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 set to "none")

Response

Updated 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"
  }
}