Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

Releases

A Release is an immutable desired state of an environment's workloads.

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 Release is an immutable desired state of an environment's workloads. Writing a newer Release supersedes the live one; a rollback is a new Release naming older digests.

Service Sylphx Release · Resource type release.sylphx.com/Release · Name pattern orgs/{org}/projects/{project}/envs/{env}/releases/{release} · Shape spec_status

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

#Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/releases/{release}.
uidstringrel_<cell><ulid>. Output only.
metaResourceMetaResource metadata.
specReleaseSpecDesired state. Required.
statusReleaseStatusObserved 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 release.
GETlistLists releases in an environment, newest first by default.
POSTcreateCreates a release: admits it and rolls it out in waves. The Operation is done when the release is live or halted.

#get

Gets a release.

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

#list

Lists releases in an environment, newest first by default.

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

#create

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

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/releases · scope release:write · effect write · not available yet · long-running · Request, response and examples