Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Get a rollout
Gets a rollout.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
Gets a rollout.
Not available yet. Sylphx Release is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/rollouts/rollout - Scope
release:read - Effect
read— nothing is written. - Collection rollouts
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the rollout to get. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/rollouts/{rollout}. |
uid | string | rol_<cell><ulid>. Output only. |
meta | ResourceMeta | Resource metadata. Output only. |
release | string | The Release rolling out. Output only. |
state | RolloutState | The rollout's lifecycle state. Output only. One of waiting, in_progress, succeeded, failed, superseded. |
waves | Wave[] | The waves, in order. Output only. |
current_wave | int32 | The index of the wave in progress, from 0. Output only. |
start_time | timestamp | When the first wave started. Output only. |
end_time | timestamp | When the rollout finished. Output only. |
halt_reason | string | A customer-safe reason the rollout halted. Output only. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong 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_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#Wave
| Field | Type | What it is |
|---|---|---|
scope | WaveScope | What the wave covers. Output only. One of canary, cell, region, all. |
cells | string[] | The cells in the wave. Output only. |
state | RolloutState | The wave's lifecycle state. Output only. One of waiting, in_progress, succeeded, failed, superseded. |
healthy_cell_count | int32 | How many of the wave's cells report the Release converged and healthy. Output only. |
start_time | timestamp | When the wave started. Output only. |
end_time | timestamp | When the wave passed its health gate or failed. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/rollouts/rollout" \
-H "Authorization: Bearer $SYLPHX_API_KEY"