Abort an in-flight rollout

POST

/api/v1/deployments/{id}/rollback

const url = 'http://localhost:3000/api/v1/deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rollback';
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'},
  body: '{"reason":"Canary devices reported repeated container crashes"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:3000/api/v1/deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rollback \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "reason": "Canary devices reported repeated container crashes" }'

Aborts the in-flight rollout and marks it rolled back. This does not redeploy a previous application version.

Authorizations

api-key
bearer

Parameters

Path Parameters

required

string format: uuid

Deployment UUID

Request Body^required

application/json

object

reason

Operator-supplied reason for the rollback, recorded in the audit trail

string

<= 500 characters

Example

Canary devices reported repeated container crashes

Responses

200

Rollback triggered successfully

403

Forbidden — caller lacks required permission

404

Deployment not found