Pipelines /
Abort release flow run
Required permission
Project > Pipelines > General > Update
Path parameters
projectId
string requiredID of the project
pipelineId
string requiredID of the pipeline
stage
string requiredStage of the pipeline
runId
string requiredID of the release flow run
Response body
- {object}
Response object.
data
{object} requiredResult data.
apiVersion
string requiredThe version of the Northflank API to run the template against.
one ofv1arguments
{object}A set of arguments that can be referenced in a template using '${args.argumentName}'.
spec
(multiple options: oneOf) requiredA node representing an action to be performed as part of the template.
refs
{object}id
string requiredID of the release flow run
name
stringOptional name for the release flow run
description
stringOptional description for the release flow run
status
string requiredStatus of the template run
one ofpending, running, success, failure, aborted, abortingstartedAt
stringTimestamp the run started at.
concluded
boolean requiredWhether the run has concluded (aborted, success, failed)
concludedAt
stringTimestamp the run concluded at.
createdAt
string requiredTimestamp the run was created at.
updatedAt
string requiredTimestamp the run was last updated at.
POST /v1/projects/{projectId}/pipelines/{pipelineId}/release-flows/{stage}/runs/{runId}/abort
Example response
200 OK
JSON
{
"data": {
"apiVersion": "v1",
"arguments": {
"ARGUMENT_1": "value_1",
"ARGUMENT_2": "value_2"
},
"spec": {
"settings": {
"maxAttempts": 3,
"backoff": {
"type": "fixed",
"delay": 60
}
},
"kind": "Workflow",
"response": {
"status": "success",
"retries": {
"attempts": 1,
"maxAttempts": 3,
"timestamp": 1657296265
}
}
},
"id": "110ddb52-bdcd-482d-8ac2-05ba580afe2f",
"name": "Example run",
"description": "This is an example description",
"status": "success",
"startedAt": "2021-01-01 12:01:00.000Z",
"concluded": true,
"concludedAt": "2021-01-01 12:10:00.000Z",
"createdAt": "2021-01-01 12:00:00.000Z",
"updatedAt": "2021-01-01 12:00:00.000Z"
}
}