Cancel pending update work on every screen the deployment reaches

POST

/api/v1/update-deployments/{id}/cancel

const url = 'https://example.com/api/v1/update-deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel';
const options = {method: 'POST'};

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

curl --request POST \
  --url https://example.com/api/v1/update-deployments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/cancel

Requires an Owner or Administrator with CSRF and write scope. Cancels active or paused work. Installed updates stay installed.

Parameters

Path Parameters

required

string format: uuid

Responses

200

Cancelled

application/json

object

data

required

object

required

string format: uuid

status

required

string

Allowed values: cancelled

Example

{
  "data": {
    "status": "cancelled"
  }
}

403

Reaches screens outside the caller’s scope

404

Scoped callers only - unknown or reaching no screen in scope

409

Already complete, or unknown to an unscoped caller