Sign in
Admin - Pipelines

Cancel Pipeline Task

Cancel a queued or running pipeline task.

Requires: pipelines.admin capability Sets status to FAILED with cancellation reason.

post/api/v1/admin/pipelines/{task_id}/cancel

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

task_idstring required

Headers

X-API-Keystring nullable

Response

Successful Response

idstring required
organization_idstring required
task_typestring required
statusstring required
priorityinteger required
sla_deadlinestring date-time nullable
sla_categorystring nullable
sla_remaining_msinteger nullable
sla_breachedboolean
estimated_tokensinteger nullable
actual_tokensinteger nullable
estimated_latency_msinteger nullable
duration_msinteger nullable
blocks_on_task_idstring nullable
blocked_by_quotaboolean
attemptsinteger
max_attemptsinteger
last_errorstring nullable
metadataobject nullable
trace_idstring nullable
created_atstring date-time required
started_atstring date-time nullable
completed_atstring date-time nullable
updated_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.