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}

name
string
type
string required
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
(multiple options: oneOf) required

{object}

canaryStrategy
string required
one of
percentage, header
config
(multiple options: oneOf) required

{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

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 'undefined' \
  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"
  }
}