v4

OpenAPI 3.0.0MIT2026-07-311494532.1 MB

Environments

Update an environment

Update an environment by its unique identifier environmentId. You can modify the environment name, identifier, color, and other configuration settings.

put/v1/environments/{environmentId}

Path parameters

environmentIdstring required

The unique identifier of the environment

Headers

idempotency-keystring

A header for idempotency purposes

Request body

namestring

identifierstring

parentIdstring

colorstring

Response

_idstring required

Unique identifier of the environment

namestring required

Name of the environment

_organizationIdstring required

Organization ID associated with the environment

identifierstring required

Unique identifier for the environment

type'dev' | 'prod' nullable

Type of the environment

_parentIdstring

Parent environment ID

slugstring

URL-friendly slug for the environment

Example response

{
  "_id": "60d5ecb8b3b3a30015f3e1a1",
  "name": "Production Environment",
  "_organizationId": "60d5ecb8b3b3a30015f3e1a2",
  "identifier": "prod-env-01",
  "type": "prod",
  "apiKeys": [
    {
      "key": "sk_test_1234567890abcdef",
      "_userId": "60d5ecb8b3b3a30015f3e1a4",
      "hash": "hash_value_here"
    }
  ],
  "_parentId": "60d5ecb8b3b3a30015f3e1a3",
  "slug": "production"
}