Skip to main content
GET
/
v1
/
environments
/
{environmentId}
Get an environment
curl --request GET \
  --url https://api.ctrlplane.dev/api/v1/environments/{environmentId}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "systemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "policyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "resourceSelector": {},
  "directory": "my/env/path",
  "createdAt": "2023-11-07T05:31:56Z",
  "metadata": {},
  "policy": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "priority": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "enabled": true,
    "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "targets": [
      {
        "deploymentSelector": {},
        "environmentSelector": {},
        "resourceSelector": {}
      }
    ],
    "denyWindows": [
      {
        "timeZone": "<string>",
        "rrule": {},
        "dtend": "2023-11-07T05:31:56Z"
      }
    ],
    "deploymentVersionSelector": {
      "name": "<string>",
      "deploymentVersionSelector": {},
      "description": "<string>"
    },
    "versionAnyApprovals": {
      "requiredApprovalsCount": 123
    },
    "versionUserApprovals": [
      {
        "userId": "<string>"
      }
    ],
    "versionRoleApprovals": [
      {
        "roleId": "<string>",
        "requiredApprovalsCount": 123
      }
    ],
    "concurrency": 2,
    "environmentVersionRollout": {
      "positionGrowthFactor": 123,
      "timeScaleInterval": 123,
      "rolloutType": "linear"
    },
    "maxRetries": 2
  }
}

Path Parameters

environmentId
string
required

UUID of the environment

Response

Successful response

id
string<uuid>
required
systemId
string<uuid>
required
name
string
required
directory
string
default:""
required

The directory path of the environment

Example:

"my/env/path"

createdAt
string<date-time>
required
description
string
policyId
string<uuid> | null
resourceSelector
object | null
metadata
object
policy
object