v1

latestOpenAPI 3.1.02026-07-261344388.3 KB

Deployment workflows

Cancel deployment workflow run

Cancel an in-progress or waiting deployment workflow run.

post/api/projects/{projectId}/runs/{runId}/cancel

projectIdstring uuid required

Project unique identifier

runIdstring uuid required

Deployment workflow run unique identifier

commentstring required

Reason for cancelling the workflow run

Cancelled deployment workflow run

idstring uuid required

Workflow run unique identifier

namestring nullable required

Workflow run name

status'in_progress' | 'completed' | 'cancelled' | 'waiting' | 'failure' required

Current status of the workflow run

runVersion'v2' | 'null' nullable

Workflow run version

releaseIdstring uuid required

Associated release ID

projectIdstring uuid required

Project ID

createdByIdstring uuid required

ID of user who created the run

createdAtstring required

Timestamp when the run was created

completedAtstring nullable

Timestamp when the run was completed

cancelledByIdstring uuid nullable

ID of user who cancelled the run

cancelledCommentstring nullable

Cancellation reason