Environments
Get an environment
Environments
Get an environment
GET
/
v1
/
environments
/
{environmentId}
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",
"resourceFilter": {},
"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"
}
}Path Parameters
UUID of the environment
Response
200
application/json
Successful response
The policy ID
The system ID
The name of the policy
The approval requirement of the policy
Available options:
manual, automatic If a policy depends on an environment, whether or not the policy requires all, some, or optional successful releases in the environment
Available options:
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
Available options:
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/environments/{environmentId}{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"systemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"policyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"resourceFilter": {},
"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"
}
}