Update release flow | Pipelines | Northflank API docs
v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Pipelines /

Update release flow

Updates a release flow

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

Request body

  • {object}

    • content

      {object} required

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

              OR

            • {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

      • paused

        boolean

        Whether triggers are paused for this release flow. If true, Git triggers and webhook triggers will not run the release flow.

    API
    CLI
    JS Client

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

    Example request

    Request body
    curl
    curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"content":{"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","paused":false}' \
  https://api.northflank.com/v1/projects/{projectId}/pipelines/{pipelineId}/release-flows/{stage}

    Example response

    200 OK

    success

    © 2024 Northflank Ltd. All rights reserved.

    northflank.comTermsPrivacyfeedback@northflank.com