Skip to main content
POST
Cancel deployment workflow run

Authorizations

Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

projectId
string<uuid>
required

Project unique identifier

runId
string<uuid>
required

Deployment workflow run unique identifier

Body

application/json
comment
string
required

Reason for cancelling the workflow run

Minimum string length: 1

Response

200 - application/json

Cancelled deployment workflow run

Cancelled deployment workflow run

id
string<uuid>
required

Workflow run unique identifier

name
string | null
required

Workflow run name

status
enum<string>
required

Current status of the workflow run

Available options:
in_progress,
completed,
cancelled,
waiting,
failure
releaseId
string<uuid>
required

Associated release ID

projectId
string<uuid>
required

Project ID

createdById
string<uuid>
required

ID of user who created the run

createdAt
string
required

Timestamp when the run was created

runVersion
enum<string> | null

Workflow run version

Available options:
v2,
null
release
object | null

Associated release

createdBy
object | null

User who created the run

completedAt
string | null

Timestamp when the run was completed

cancelledById
string<uuid> | null

ID of user who cancelled the run

cancelledBy
object | null

User who cancelled the run

cancelledComment
string | null

Cancellation reason

jobs
object[]

List of jobs in the workflow run