GET
/
v1
/
systems
/
{systemId}
Get a system
curl --request GET \
  --url https://api.ctrlplane.dev/api/v1/systems/{systemId}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "environments": [
    {
      "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",
        "systemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "description": "<string>",
        "approvalRequirement": "manual",
        "successType": "some",
        "successMinimum": 123,
        "concurrencyLimit": 123,
        "rolloutDuration": 123,
        "minimumReleaseInterval": 123,
        "releaseSequencing": "wait"
      }
    }
  ],
  "deployments": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "slug": "<string>",
      "description": "<string>",
      "systemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "jobAgentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "jobAgentConfig": {},
      "retryCount": 123,
      "timeout": 123
    }
  ]
}

Path Parameters

systemId
string<uuid>
required

UUID of the system

Response

200 - application/json

System retrieved successfully

id
string<uuid>
required

The system ID

workspaceId
string<uuid>
required

The workspace ID of the system

name
string
required

The name of the system

slug
string
required

The slug of the system

description
string

The description of the system

environments
object[]
deployments
object[]