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
UUID of the system
Response
The system ID
The workspace ID of the system
The name of the system
The slug of the system
The description of the system
The directory path of the environment
"my/env/path"
The policy ID
The system ID
The name of the policy
The approval requirement of the policy
manual, automatic If a policy depends on an environment, whether or not the policy requires all, some, or optional successful releases in the environment
some, all, optional If a policy depends on an environment, the minimum number of successful releases in the environment
The duration of the rollout in milliseconds
The minimum interval between releases in milliseconds
If a new release is created, whether it will wait for the current release to finish before starting, or cancel the current release
wait, cancel The description of the policy
The maximum number of concurrent releases in the environment
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
}
]
}