Pipelines /

Get release flow

Gets details about a release flow

Required permission

Project > Pipelines > General > Read

Path parameters

projectId
string required
ID of the project
pipelineId
string required
ID of the pipeline
stage
string required
Stage of the pipeline

Response body

{object}
Response object.

data
{object} required
Result data.

apiVersion
string required
The version of the Northflank API to run the template against.
one of
v1
arguments
{object}
A set of arguments that can be referenced in a template using '${args.argumentName}'.

richInputs
[array]
An array of rich UI override inputs for the Release Flow template.

(multiple options: oneOf)
A node representing a rich UI override for the Release Flow template.

{object}

BranchCommitSelector input

kind
string required
The kind of input.
one of
BranchCommitSelector
spec
{object} required
The specification for the BranchCommitSelector input.

{object}

BuildSelector input

kind
string required
The kind of input.
one of
BuildSelector
spec
{object} required
The specification for the BuildSelector input.

spec
(multiple options: oneOf) required
A node representing an action to be performed as part of the template.
concurrencyPolicy
string
Defines the concurrency behaviour of the template with respect to parallel runs.
one of
allow, queue, forbid
stage
string
The stage of the pipeline this release flow belongs to.
status
string required
Status of the template run
one of
pending, running, success, failure, aborted, aborting
paused
boolean required
Whether triggers are paused for this release flow. If true, Git triggers and webhook triggers will not run the release flow.
createdAt
string required
Timestamp the template was created at.
updatedAt
string required
Timestamp the template was last updated at.

API

CLI

JS Client

GET /v1/projects/{projectId}/pipelines/{pipelineId}/release-flows/{stage}

Example response

200 OK

Details about a release flow.

JSON

{
  "data": {
    "apiVersion": "v1",
    "arguments": {
      "ARGUMENT_1": "value_1",
      "ARGUMENT_2": "value_2"
    },
    "richInputs": [
      {
        "kind": "BranchCommitSelector",
        "spec": {
          "required": false,
          "inputs": {
            "source": "build-service"
          },
          "outputs": {
            "branch": "TARGET_BRANCH",
            "buildSha": "TARGET_COMMIT"
          }
        }
      }
    ],
    "spec": {
      "kind": "Workflow"
    },
    "concurrencyPolicy": "allow",
    "stage": "Development",
    "status": "success",
    "paused": false,
    "createdAt": "2021-01-01 12:00:00.000Z",
    "updatedAt": "2021-01-01 12:00:00.000Z"
  }
}