Skip to main content
POST
Cancel pipeline run
Use the runId returned by the trigger pipeline run API. The status field in the response is one of:
  • cancelling: Prophecy is stopping the run.
  • cancelled: The run was stopped.
  • already_finished: The run had already completed.
descendantsCancelled counts runs of other pipelines that this run had started. A 404 response with run_not_found means the run ID is unknown or belongs to a different fabric.

Headers

X-AUTH-TOKEN
string
required

Prophecy access token

Path Parameters

runId
string
required

ID of the pipeline run to stop, as returned by the trigger pipeline run API.

Body

application/json
fabricId
integer<int64>
required

ID of the fabric the run is on. Send it as a number, without quotes.

Response

Cancellation request accepted

runId
string

Unique identifier of the pipeline run.

status
enum<string>

Outcome of the cancellation request.

Available options:
cancelling,
cancelled,
already_finished
runStatus
string

Execution status of the pipeline run at the time of the request.

descendantsCancelled
integer

Number of runs of other pipelines that this run had started and that were cancelled.

message
string

Message that explains the outcome of the request.