Skip to content
Console
On this page

Releases

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

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

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/releases/{release}.
uidstringrel_<cell><ulid>. Output only.
metaResourceMetaResource metadata.
specReleaseSpecDesired state, omitted when immutable input evidence is unavailable.
statusReleaseStatusObserved state. Output only.
servicesReleaseServiceArtifact[]Per-service artifact provenance from the immutable Release members. Output only.
projection_incompleteboolTrue when some immutable inputs or serving observations are unavailable. Output only.
unavailable_fieldsstring[]Field paths not established by retained evidence; absence is not an empty spec. Output only.
source_shastringThe immutable Release source, distinct from each carried artifact's source. 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.
POSTdeployDeploys through the existing redeploy writer. An explicit commit can start missing native builds and provision declared resources, then refuse with commit_not_fully_built before recording a Release. That response returns no pending operation or build IDs; read progress before resubmitting. Without commit, reuse live members, or the newest recorded commit if no live Release exists. With no prior Release, require an explicit commit. A recorded Release still needs normal admission and post-merge proof. The Operation is done once the Release is recorded; its status.state then follows admission and rollout.
POSTrollbackRolls the environment back without a build: a new Release, admitted at once, carrying the exact artifacts and configuration versions of the newest earlier Release that served and differs from the live one, or of release. The database is not rolled back. The Operation is done once the Release is recorded; its status.state then follows the rollout.

get

Gets a 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.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/releases · scope release:read · effect read · 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

deploy

Deploys through the existing redeploy writer. An explicit commit can start missing native builds and provision declared resources, then refuse with commit_not_fully_built before recording a Release. That response returns no pending operation or build IDs; read progress before resubmitting. Without commit, reuse live members, or the newest recorded commit if no live Release exists. With no prior Release, require an explicit commit. A recorded Release still needs normal admission and post-merge proof. The Operation is done once the Release is recorded; its status.state then follows admission and rollout.

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

rollback

Rolls the environment back without a build: a new Release, admitted at once, carrying the exact artifacts and configuration versions of the newest earlier Release that served and differs from the live one, or of release. The database is not rolled back. The Operation is done once the Release is recorded; its status.state then follows the rollout.

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