Get release flow run details | Pipelines | Northflank API docs
v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Pipelines /

Get release flow run details

Get information about the given release flow run

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

    • runId

      string required

      ID of the release flow run

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}'.

        • spec

          (multiple options: oneOf) required

          A node representing an action to be performed as part of the template.

        • refs

          {object}

          • id

            string required

            ID of the release flow run

          • name

            string

            Optional name for the release flow run

          • description

            string

            Optional description for the release flow run

          • status

            string required

            Status of the template run

            one of
            pending, running, success, failure, aborted, aborting

          • startedAt

            string

            Timestamp the run started at.

          • concluded

            boolean required

            Whether the run has concluded (aborted, success, failed)

          • concludedAt

            string

            Timestamp the run concluded at.

          • createdAt

            string required

            Timestamp the run was created at.

          • updatedAt

            string required

            Timestamp the run was last updated at.

      API
      CLI
      JS Client

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

      Example response

      200 OK

      Details about a release flow run.

      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"
  }
}

      © 2024 Northflank Ltd. All rights reserved.

      northflank.comTermsPrivacyfeedback@northflank.com