Sign in
Deployment group

Update deployment group

Updates a deployment group's status or strategy data.

patch/deployment_group/{id}

Path parameters

idstring required

The ID of the deployment group to update.

Request body

statusstring

Status of the deployment group.

Note: See Deployments for more information.

Example request

{
  "status": "running",
  "strategy_data": {
    "switched_traffic": 30,
    "desired_switched_traffic": 50,
    "amount_instances_to_wait": 5,
    "healthy_instances": 3,
    "launched_instances": 5,
    "switch_traffic_step": true
  }
}

Response

The operation was successful.

idstring required

The ID of the deployment group.

status'creating_approval' | 'creating_approval_denied' | 'creating' | 'waiting_for_instances' | 'running' | 'finalizing' | 'finalized' | 'cancelling' | 'cancelled' | 'failed' | 'rolling_back' | 'rolled_back' | 'deleting' | 'deleted' required

Status of the deployment group.

Note: See Deployments for more information.

application_idstring required

The ID of the application the deployment group belongs to.

release_idstring required

The ID of the release associated with the deployment.

deployments_amountinteger required

Number of deployments in the group

created_bystring required

The user ID of the creator of the deployment group.

updated_bystring required

The user ID of the last person who updated the deployment group.

created_atstring date-time required

The ISO-8601 UTC timestamp of when the deployment group was created.

updated_atstring date-time required

The ISO-8601 UTC timestamp of when the deployment group was last updated.

Example response

{
  "id": "1",
  "status": "running",
  "deployments": [
    {
      "strategy": "blue_green",
      "strategy_data": {
        "switched_traffic": 30,
        "desired_switched_traffic": 50,
        "amount_instances_to_wait": 5,
        "healthy_instances": 3,
        "launched_instances": 5,
        "switch_traffic_step": true
      }
    }
  ],
  "scopes": [
    {
      "name": "AR - Staging"
    }
  ],
  "strategy_data": {
    "switched_traffic": 30,
    "desired_switched_traffic": 50,
    "amount_instances_to_wait": 5,
    "healthy_instances": 3,
    "launched_instances": 5,
    "switch_traffic_step": true
  },
  "application_id": "6789",
  "release_id": "5678",
  "deployments_amount": 5,
  "created_at": "2023-10-01T12:34:56Z",
  "updated_at": "2023-10-01T12:34:56Z"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.