v4

latestOpenAPI 3.0.0MIT2026-07-311494532.1 MB

Environments

Create an environment

Creates a new environment within the current organization. Environments allow you to manage different stages of your application development lifecycle. Each environment has its own set of API keys and configurations.

post/v1/environments

Headers

idempotency-keystring

A header for idempotency purposes

Request body

namestring required

Name of the environment to be created

parentIdstring

MongoDB ObjectId of the parent environment (optional)

colorstring required

Hex color code for the environment

Example request

{
  "name": "Production Environment",
  "parentId": "60d5ecb8b3b3a30015f3e1a1",
  "color": "#3498db"
}

Response

Created

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