Skip to content
Console
On this page

Rollouts

A Rollout is the progress of one Release through its waves, derived from the cell status the Release controller reports.

A Rollout is the progress of one Release through its waves, derived from the cell status the Release controller reports.

Service Sylphx Release · Resource type release.sylphx.com/Rollout · Name pattern orgs/{org}/projects/{project}/envs/{env}/rollouts/{rollout} · Shape record

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/rollouts/{rollout}.
uidstringrol_<cell><ulid>. Output only.
metaResourceMetaResource metadata. Output only.
releasestringThe Release rolling out. Output only.
stateRolloutStateThe rollout's lifecycle state. Output only. One of waiting, in_progress, succeeded, failed, superseded.
wavesWave[]The waves, in order. Output only.
current_waveint32The index of the wave in progress, from 0. Output only.
start_timetimestampWhen the first wave started. Output only.
end_timetimestampWhen the rollout finished. Output only.
halt_reasonstringA customer-safe reason the rollout halted. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets a rollout.
GETlistLists rollouts in an environment.

get

Gets a rollout.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/rollouts/rollout · scope release:read · effect read · Request, response and examples

list

Lists rollouts in an environment.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/rollouts · scope release:read · effect read · paginated · Request, response and examples