Client API: Deployments: Env groups
The 3 Client API operations for env groups.
Part of Deployments.
Operations
Section titled Operations| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/client/deployments/{deployment_uuid}/env-groups |
List linked environment groups |
| POST | /api/v1/client/deployments/{deployment_uuid}/env-groups |
Link an environment group |
| DELETE | /api/v1/client/deployments/{deployment_uuid}/env-groups/{group_uuid} |
Unlink an environment group |
List linked environment groups
Section titled List linked environment groupsGET /api/v1/client/deployments/{deployment_uuid}/env-groups
The env groups linked to a deployment, in the order they were linked, which is the order they win in.
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
deployment_uuid |
path | string (uuid) | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Link an environment group
Section titled Link an environment groupPOST /api/v1/client/deployments/{deployment_uuid}/env-groups
Link one of the owner's env groups. Its values rank below the deployment's own and reach it with its next release.
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
deployment_uuid |
path | string (uuid) | yes |
Request body
Section titled Request bodyapplication/json (required)
| Field | Type | Required |
|---|---|---|
group |
string (uuid) | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
201 |
Success. |
422 |
The request is not valid. detail lists each problem. |
Unlink an environment group
Section titled Unlink an environment groupDELETE /api/v1/client/deployments/{deployment_uuid}/env-groups/{group_uuid}
Unlink an env group; a group that is not linked answers 404.
Authentication: an access token, sent as Authorization: Bearer <token>.
Parameters
Section titled Parameters| Name | In | Type | Required |
|---|---|---|---|
deployment_uuid |
path | string (uuid) | yes |
group_uuid |
path | string (uuid) | yes |
Responses
Section titled Responses| Status | Meaning |
|---|---|
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |