Request run cancellation

POST

/api/v1/runs/{id}/cancel

• Generated server url

Cancels pending work or persists cancellation intent for a running attempt after CANCEL permission. The response includes a mode-specific sink warning. Protected mutations require the session cookie and CSRF header.

Authorizations

• csrfHeader
• sessionCookie

Parameters

Path Parameters

id

required

string format: uuid

Run identifier.

Responses

200

Run cancelled or cancellation requested

Durable result of a run cancellation request.

object

runId

Run identifier.

string format: uuid

status

Resulting durable cancellation state.

string

Allowed values: PENDING RUNNING SUCCEEDED FAILED CANCEL_REQUESTED CANCELLED RETRY_SCHEDULED CANCEL_REQUESTED CANCELLED

warning

Mode-specific warning about the possible sink state.

string

401

Authentication is required or credentials are invalid.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object

detail

string

instance

string format: uri-reference

status

integer format: int32

title

string

type

string format: uri-reference

403

The authenticated identity lacks the required permission.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object

detail

string

instance

string format: uri-reference

status

integer format: int32

title

string

type

string format: uri-reference

404

The requested resource does not exist or is not visible.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object

detail

string

instance

string format: uri-reference

status

integer format: int32

title

string

type

string format: uri-reference

409

The request conflicts with the current resource or run state.

RFC 7807 problem response. Dynamic detail text is credential-redacted.

object

detail

string

instance

string format: uri-reference

status

integer format: int32

title

string

type

string format: uri-reference