Skip to content
Console
On this page

List rollouts

Lists rollouts in an environment.

Lists rollouts in an environment.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/rollouts
  • Scope release:read
  • Effect read — nothing is written.
  • Collection rollouts
  • Query page_size, page_token, filter, order_by
  • Pagination the answer carries rollouts and, when there is more, next_page_token

Request

FieldTypeWhat it is
parentstringThe environment to list in. Required.
page_sizeint32At most this many; default 50, clamped to 1000.
page_tokenstringnext_page_token of the previous page.
filterstringAIP-160 filter over labels and filterable fields.
order_bystringAIP-132 ordering over filterable fields.

Response

FieldTypeWhat it is
rolloutsRollout[]The page.
next_page_tokenstringThe token of the next page; empty on the last page.

Rollout

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.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

Wave

FieldTypeWhat it is
scopeWaveScopeWhat the wave covers. Output only. One of canary, cell, region, all.
cellsstring[]The cells in the wave. Output only.
stateRolloutStateThe wave's lifecycle state. Output only. One of waiting, in_progress, succeeded, failed, superseded.
healthy_cell_countint32How many of the wave's cells report the Release converged and healthy. Output only.
start_timetimestampWhen the wave started. Output only.
end_timetimestampWhen the wave passed its health gate or failed. Output only.

Errors

Every error arrives in the body Errors describes.

Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/rollouts" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"