AI1

Audit log3

Branches13

Change requests4

Decision5

Deployment workflows3

Deployments4

Document19

Environment6

Evaluation1

Group4

Infrastructure1

Integration5

Invitation1

Member7

Organisation1

Personal access token5

Profile3

Project9

Projects1

Release13

Roles4

Security3

System1

Templates4

Test events5

User8

Deployment workflows

Cancel deployment workflow run

Cancel an in-progress or waiting deployment workflow run.

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

Request

The document declares no server URL.
Auth
- HTTP bearer
- or HTTP internal
TypeScript
https://skmtc.dev/gorules/apis/gorules-agent-api/docs/api/projects/:projectId/runs/:runId/cancel/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdstring uuid required

Project unique identifier

runIdstring uuid required

Deployment workflow run unique identifier

Request body

commentstring required

Reason for cancelling the workflow run

Response

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

Changes

No recorded changes to this operation across all 1 revision of this API.