Team / Rollout Strategies /

List gradual rollout strategies

Lists the gradual rollout strategies belonging to the team, newest first.

Required permission

Account > Platform > GradualRollouts > Read

Query parameters

per_page
integer
The number of results to display per request. Maximum of 100 results per page.
page
integer
The page number to access.
cursor
string
The cursor returned from the previous page of results, used to request the next page.

Response body

{object}
Response object.

data
{object} required
Result data.

strategies
[array] required
An array of gradual rollout strategies, newest first.

{object}

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}

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

pagination
{object} required
Data about the endpoint pagination.

hasNextPage
boolean required
Is there another page of results available?
cursor
string
The cursor to access the next page of results.
count
number required
The number of results returned by this request.

API

CLI

JS Client

GET /v1/gradual-rollout-strategies

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

Example response

200 OK

A list of gradual rollout strategies.

JSON

{
  "data": {
    "strategies": [
      {
        "id": "example-identifier",
        "name": "example-name",
        "type": "canary"
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}