Skip to content
Console
Menu

Getting Started

Authentication

KV Store

On this page

sylphx release releases

Every sylphx release releases 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 releases commands of Sylphx Release, as the CLI spells them: the same calls as the releases API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

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

#get

Gets a release.

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

CLI

Shell
sylphx release releases get orgs/acme/projects/shop/envs/production/releases/release

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

#list

Lists releases in an environment, newest first by default.

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

CLI

Shell
sylphx release releases list orgs/acme/projects/shop/envs/production

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/releases · scope release: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 and filterable fields.
--order-bystringAIP-132 ordering over filterable fields.

#create

Creates a release: admits it and rolls it out in waves. The Operation is done when the release is live or halted.

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

CLI

Shell
sylphx release releases create --parent orgs/acme/projects/shop/envs/production

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/releases · scope release: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.membersjsonThe workloads, each by artifact digest. A member that names a tag or an unverified Artifact is refused. Required. Repeat the flag for each value.
--spec.rollout-policy.bake-durationdurationHow long each wave bakes, healthy, before the next starts; default 10 minutes.
--spec.rollout-policy.halt-on-failureboolHalt the rollout when a wave's health gate fails; default true.
--spec.rollout-policy.skip-wavesboolSkip the waves and apply to every cell together: break-glass only, and refused for any other principal.
--dry-runboolValidate and print the result without writing (validate_only).
--no-waitboolReturn the call at once instead of waiting for it to finish.