Skip to content
Console
Menu

Getting Started

Authentication

KV Store

sylphx hosting service_rollouts

Every sylphx hosting service_rollouts command: its argument, its flags and a run line.

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.

The service_rollouts commands of Sylphx Hosting, as the CLI spells them: the same calls as the service_rollouts API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

Not available yet. Sylphx Hosting is declared in the registry but no backend serves it: every command answers 501 with the problem code UNIMPLEMENTED.

#get

Gets a rollout.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx hosting service-rollouts get orgs/acme/projects/shop/envs/production/services/service/service_rollouts/rollout

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

#list

Lists rollouts in a service.

PARENT — optional: the CLI fills it from the linked project or the key's scope when it is left out.

CLI

Shell
sylphx hosting service-rollouts list orgs/acme/projects/shop/envs/production/services/service

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

Flags

FlagTypeWhat it does
--page-sizeintAt most this many; default 50, clamped to 1000.
--page-tokenstringnext_page_token of the previous page.
--filterstringAIP-160 filter over labels, filterable fields, and Ready.
--order-bystringAIP-132 ordering over filterable fields.

#create

Creates a rollout.

ID — The id segment of the new Resource's name; the server assigns one when omitted.

CLI

Shell
sylphx hosting service-rollouts create --parent orgs/acme/projects/shop/envs/production/services/service

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

Flags

FlagTypeWhat it does
--parentstringThe parent to create in; defaults to the linked project or the key's scope.
--meta.labelskey=valueCaller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
--meta.annotationskey=valueCaller-writable, unindexed annotations. Repeat the flag for each value.
--meta.display-namestringCaller-writable human-readable name.
--spec.releasestringThe Release to roll out. Unset rolls out the Service's current generation; a previous Release rolls back.
--dry-runboolValidate and print the result without writing (validate_only).

#pause

Holds a Rollout at its current wave.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx hosting service-rollouts pause orgs/acme/projects/shop/envs/production/services/service/service_rollouts/rollout

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

Flags

FlagTypeWhat it does
--etagstringAct only if the current etag matches.
--dry-runboolValidate and print the result without writing (validate_only).

#resume

Resumes a paused Rollout.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx hosting service-rollouts resume orgs/acme/projects/shop/envs/production/services/service/service_rollouts/rollout

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

Flags

FlagTypeWhat it does
--etagstringAct only if the current etag matches.
--dry-runboolValidate and print the result without writing (validate_only).

#abort

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

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell
sylphx hosting service-rollouts abort orgs/acme/projects/shop/envs/production/services/service/service_rollouts/rollout --yes

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

Flags

FlagTypeWhat it does
--etagstringAct only if the current etag matches.
--dry-runboolValidate and print the result without writing (validate_only).
--yesboolDo not ask before this destructive call.