Skills
Log in

Abort release flow run

Abort the given release flow run

Required permission

Project > Pipelines > General > Update

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.
      • name

        string
        Optional name of the run.
      • description

        string
        Optional description of the run.
      • apiVersion

        string
        Template API version.
      • spec

        (multiple options: anyOf)
      • project

        {object}
        • ref

          string
        • skipNodeExecution

          (multiple options: anyOf)
          • boolean
          • OR

          • string
            one of
            true, false
        • detailsHidden

          boolean required
        • kind

          string required
        • spec

          {object} required
          • response

            {object}
            • status

              string
            • startTime

              number
            • endTime

              number
            • duration

              number
            • attempts

              number
            • data

              {object}
              • id

                string
              • name

                string
              • _id

                string
          • _id

            string
          • id

            string
          • internalId

            string
          • type

            string
          • name

            string
          • pipelineId

            string
        • templateId

          string
          Identifier of the template, when available.
        • environmentId

          string
          Identifier of the preview environment, when available.
        • status

          string required
          Status of the template run
          one of
          pending, running, success, failure, aborted, aborting, queued, unknown, skipped, waiting, retrying, async_wait, approval_wait
        • concluded

          boolean required
          Whether execution has concluded.
        • startedAt

          string
          When execution started.
        • concludedAt

          string
          When execution concluded.
        • createdAt

          string required
          When the run was created.
        • updatedAt

          string required
          When the run was last updated.
        • detailsHidden

          boolean required
          Run details include available public results. Sensitive inputs and results are omitted.
        • _id

          string
        • internalId

          string
        • entityId

          string
        • entityType

          string
        • projectId

          string
        • pipelineId

          string
        • userId

          string
        • environmentName

          string
        • expiresAt

          string
        • deleted

          boolean
        • phase

          string
        • templateVersionSha

          string
        • commitSHA

          string
        • hasDiff

          boolean
        • content

          {object}
          • name

            string
          • description

            string
          • apiVersion

            string
          • spec

            (multiple options: anyOf)
          • project

            {object}
            • ref

              string
            • skipNodeExecution

              (multiple options: anyOf)
              • boolean
              • OR

              • string
                one of
                true, false
            • detailsHidden

              boolean required
            • kind

              string required
            • spec

              {object} required
              • response

                {object}
                • status

                  string
                • startTime

                  number
                • endTime

                  number
                • duration

                  number
                • attempts

                  number
                • data

                  {object}
                  • id

                    string
                  • name

                    string
                  • _id

                    string
              • _id

                string
              • id

                string
              • internalId

                string
              • type

                string
              • name

                string
              • pipelineId

                string
          • template

            {object}
            • _id

              string
            • id

              string required
            • internalId

              string
            • type

              string
            • name

              string
            • pipelineId

              string
          • pipeline

            {object}
            • _id

              string
            • id

              string required
            • internalId

              string
            • type

              string
            • name

              string
            • pipelineId

              string
            • stage

              string
          • run

            {object}
            • _id

              string
            • id

              string required
            • internalId

              string
            • type

              string
            • name

              string
            • pipelineId

              string
          • auditLog

            {object}
            • _id

              string
          • runContext

            {object}
            • origin

              string
            • userId

              string
            • user

              {object}
              • _id

                string
            • sha

              string
            • branch

              string
            • pullRequestId

              (multiple options: anyOf)
              • string
              • OR

              • integer
            • matchedFile

              string
            • trigger

              {object}
              • globalSecretInternalId

                string
          • pendingApprovals

            [array]
            • {object}
              • nodePath

                string required
              • user

                string required
          • id

            string required
            Identifier of the run.

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

      POST /v1/teams/{teamId}/projects/{projectId}/pipelines/{pipelineId}/release-flows/{stage}/runs/{runId}/abort

      Example response

      200 OK

      Details about the aborting run.

      JSON

      {
        "data": {
          "name": "Production deployment",
          "description": "Deploy the latest release.",
          "status": "success",
          "concluded": true,
          "startedAt": "2026-01-01T12:00:00.000Z",
          "concludedAt": "2026-01-01T12:01:00.000Z",
          "createdAt": "2026-01-01T12:00:00.000Z",
          "updatedAt": "2026-01-01T12:01:00.000Z",
          "id": "110ddb52-bdcd-482d-8ac2-05ba580afe2f"
        }
      }

      © 2026 Northflank Ltd. All rights reserved.

      northflank.com / Terms / Privacy / feedback@northflank.com