Skip to content
Console
On this page

Service rollouts

A Rollout moves one Service generation to its Release in waves (one canary cell, one cell, one region, all); every step is fenced by the…

This method is not served on the public API. api.sylphx.com does 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.

A Rollout moves one Service generation to its Release in waves (one canary cell, one cell, one region, all); every step is fenced by the Service generation at the moment of write, and no wave advances without fresh recorded evidence.

Service Sylphx Hosting · Resource type hosting.sylphx.com/Rollout · Name pattern orgs/{org}/projects/{project}/envs/{env}/services/{service}/service_rollouts/{rollout} · Shape spec_status

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/services/{service}/service_rollo uts/{rollout}.
uidstringrol_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specRolloutSpecDesired state. Required.
statusRolloutStatusObserved state. 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 a service.
POSTcreateCreates a rollout.
POSTpauseHolds a Rollout at its current wave.
POSTresumeResumes a paused Rollout.
POSTabortStops a Rollout; the cells it reached return to the previous Release.

get

Gets a rollout.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service/service_rollouts/rollout · scope hosting:read · effect read · not available yet · Request, response and examples

list

Lists rollouts in a service.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service/service_rollouts · scope hosting:read · effect read · not available yet · paginated · Request, response and examples

create

Creates a rollout.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service/service_rollouts · scope hosting:write · effect write · not available yet · Request, response and examples

pause

Holds a Rollout at its current wave.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service/service_rollouts/rollout:pause · scope hosting:write · effect write · not available yet · validate_only · Request, response and examples

resume

Resumes a paused Rollout.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service/service_rollouts/rollout:resume · scope hosting:write · effect write · not available yet · validate_only · Request, response and examples

abort

Stops a Rollout; the cells it reached return to the previous Release.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service/service_rollouts/rollout:abort · scope hosting:write · effect destructive · not available yet · validate_only · Request, response and examples