Skip to main content
POST
Cancel a pipeline run of a pipeline repository

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

repository_id
string<uuid>
required

The connected pipeline repository.

run_id
string<uuid>
required

The pipeline run.

Query Parameters

force
boolean
default:false

Conclude the run now without waiting for its steps to stop.

Response

The run, cancelled or cancelling.

One pipeline run of a repository.

id
string<uuid>
required

The pipeline run id.

run_id
string<uuid>
required

The execution run id the pipeline run drives.

organisation_id
string<uuid>
required
repository_id
string<uuid>
required
application_id
string<uuid> | null
required
cluster_id
string<uuid> | null
required

The CI cluster the run was pinned to; null before placement.

definition_id
string<uuid>
required
run_number
integer
required

Per-repository run number.

trigger
enum<string>
required
Available options:
push,
pull_request,
tag,
schedule,
manual,
api,
agent,
rerun,
merge_train
trigger_ref
string
required
head_sha
string
required
base_sha
string
required
pull_request_number
integer | null
required
is_fork
boolean
required
concurrency_group
string
required
status
enum<string>
required
Available options:
queued,
running,
concluded
outcome
string | null
required

success, failure, cancelled, timed_out, skipped or infra_error once concluded; null before.

error_class
string | null
required
error_message
string | null
required
requested_by
string
required
rerun_of_run_id
string<uuid> | null
required
superseded_by_run_id
string<uuid> | null
required
superseded_by_run_number
integer | null
required
cancelled_by
string | null
required
cancel_reason
string | null
required
cancelled_at
string<date-time> | null
required
cancelling
boolean
required

A cancel was requested and the run has not concluded yet.

authority_state
string | null
required
authority_hash
string | null
required
authority_definition_id
string<uuid> | null
required
queued_at
string<date-time>
required
started_at
string<date-time> | null
required
finished_at
string<date-time> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
display_title
string | null
required
head_branch
string | null
required
merged_pull_request_number
integer | null
required
head_tree_sha
string | null
required
promotion_outcome
string | null
required
promotion_message
string | null
required
promoted_from_run_id
string<uuid> | null
required
paths_unverified
string

Why path filters could not be verified; omitted when they were.

full_run_source
string

What asked for a full run; omitted for an ordinary run.

full_run_requested_by
string
full_run_message
string
target_environments
string[]
merge_train_members_verified
boolean
reservation
object

The CI capacity a run reserved, and what it was observed to use.