v1
ApplicationAPI & CLI
Northflank docs for LLMs
API
CLI
JS Client

Team / Rollout Strategies /

Get gradual rollout strategy

Gets details of the given gradual rollout strategy.

Required permission

Account > Platform > GradualRollouts > Read

Path parameters

    • gradualRolloutStrategyId

      string required
      ID of the gradual rollout strategy

Response body

  • {object}
    Response object.

    • data

      {object} required
      Result data.

      • id

        string required
        Identifier for the gradual rollout strategy

      • name

        string required
        Name of the gradual rollout strategy

      • type

        string required
        Type of the gradual rollout strategy
        one of
        canary

      • options

        {object}

        • triggers

          {object}

          • releaseFromTemplate

            boolean | null

          • releaseFromReleaseFlow

            boolean | null

          • releaseFromCD

            boolean | null

          • releaseFromUI

            boolean | null

          • releaseFromApi

            boolean | null

        • blockDeploymentOnActiveRollout

          boolean | null

      • details

        {object} required

        • canaryStrategy

          string required
          one of
          percentage, header

        • config

          (multiple options: oneOf)
          • {object}

            • canaryPercentage

              integer required
              min
              0
              max
              100

            • stablePercentage

              integer required
              min
              0
              max
              100

            OR

          • {object}

            • stableHeader

              {object}

              • headerName

                string required
                min length
                1

              • headerValue

                string required
                min length
                1

            • canaryHeader

              {object}

              • headerName

                string required
                min length
                1

              • headerValue

                string required
                min length
                1
API
CLI
JS Client

GET /v1/gradual-rollout-strategies/{gradualRolloutStrategyId}

GET /v1/teams/{teamId}/gradual-rollout-strategies/{gradualRolloutStrategyId}

Example response

200 OK

Details about the gradual rollout strategy.

JSON

{
  "data": {
    "id": "example-identifier",
    "name": "example-name",
    "type": "canary"
  }
}

© 2026 Northflank Ltd. All rights reserved.

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