POST
/
v1
/
environments
curl --request POST \
  --url https://api.ctrlplane.dev/api/v1/environments \
  --header 'Content-Type: application/json' \
  --data '{
  "directory": "my/env/path",
  "systemId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "resourceFilter": {},
  "policyId": "<string>",
  "releaseChannels": [
    "<string>"
  ],
  "metadata": {}
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "systemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "policyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resourceFilter": {},
  "directory": "my/env/path",
  "createdAt": "2023-11-07T05:31:56Z",
  "metadata": {},
  "policy": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "systemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "approvalRequirement": "manual",
    "successType": "some",
    "successMinimum": 123,
    "concurrencyLimit": 123,
    "rolloutDuration": 123,
    "minimumReleaseInterval": 123,
    "releaseSequencing": "wait"
  }
}

Body

application/json
systemId
string
required
name
string
required
directory
string
default:

The directory path of the environment

Example:

"my/env/path"

description
string
resourceFilter
object
policyId
string
releaseChannels
string[]
metadata
object

Response

200
application/json
Environment created successfully
id
string
required
systemId
string
required
name
string
required
directory
string
default:
required

The directory path of the environment

Example:

"my/env/path"

createdAt
string
required
description
string
policyId
string | null
resourceFilter
object | null
metadata
object
policy
object