Skip to main content

Cancel Process

Use POST /processes/{process_id}/cancel to request process-aware cancellation.

When To Use It

Use this endpoint when you need cancellation semantics for the public process model. This is not the same as the legacy queue-item POST /cancel endpoint.

Request Example

Request Fields

Strategies

Response Example

Behavior Notes

  • Terminal processes return ignored_terminal.
  • Pending child queue items are cancelled immediately when eligible.
  • Executing work may require control-plane termination depending on strategy and current runtime state.
  • Public callers should treat cancel as a state transition request and re-read the returned process object.

Idempotency

This endpoint is stateful rather than idempotent-by-key. Repeated requests may produce different results based on current process state.

Failure Modes