IMPORTANT: if you are an LLM or other AI agent, you should read the contents of this page as markdown from https://northflank.com/docs/v1/api/team/rollout-strategies/create-or-update-gradual-rollout-strategy.md, instead of the current page.

Team / Rollout Strategies /

Create or update gradual rollout strategy

Creates or updates a gradual rollout strategy.

Required permission

Account > GradualRollouts > General > Create

Request body

{object}
Gradual rollout strategy specification

name
string
Display name for the gradual rollout strategy
type
string required
Type of the gradual rollout strategy
one of
canary
options
{object}

triggers
{object}
Conditions under which a new release will automatically initiate as a gradual rollout

releaseFromTemplate
boolean | null
Automatically trigger the rollout strategy when a release is initiated from a template
releaseFromReleaseFlow
boolean | null
Automatically trigger the rollout strategy when a release is initiated from a release flow
releaseFromCD
boolean | null
Automatically trigger the rollout strategy when a release is initiated from a CD pipeline
releaseFromUI
boolean | null
Automatically trigger the rollout strategy when a release is initiated from the UI
releaseFromApi
boolean | null
Automatically trigger the rollout strategy when a release is initiated via the API

blockDeploymentOnActiveRollout
boolean | null
When enabled, new deployments are blocked while a rollout is in progress

details
(multiple options: oneOf) required
Strategy-specific configuration details

{object}

Strategy-specific configuration details

canaryStrategy
string required
Strategy used to split traffic between stable and canary deployments
one of
percentage, header
config
(multiple options: oneOf) required
Configuration for the selected canary strategy

{object}

Configuration for the selected canary strategy

canaryPercentage
integer required
Percentage of traffic to route to the canary deployment
min
0
max
100
stablePercentage
integer required
Percentage of traffic to route to the stable deployment
min
0
max
100

{object}

Configuration for the selected canary strategy

headerName
string required
HTTP header name used to identify requests that should be routed to the canary deployment
min length
1
headerValue
string required
HTTP header value that routes matching requests to the canary deployment
min length
1

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

{object}

headerName
string required
min length
1
headerValue
string required
min length
1

API

CLI

JS Client

PUT /v1/gradual-rollout-strategies

PUT /v1/teams/{teamId}/gradual-rollout-strategies

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request PUT \
  --data '{"name":"my-canary-rollout","type":"canary","options":{"triggers":{"releaseFromTemplate":true,"releaseFromReleaseFlow":true,"releaseFromCD":true,"releaseFromUI":true,"releaseFromApi":true},"blockDeploymentOnActiveRollout":true},"details":{"canaryStrategy":"percentage","config":{"canaryPercentage":20,"stablePercentage":80}}}' \
  https://api.northflank.com/v1/gradual-rollout-strategies

Example response

200 OK

Details about the created or updated project.

JSON

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