Skip to content
Console
Menu

Alerts and status pages

App store purchases

Credits

Knowledge

KV

Notifications

Organizations

Storage

Workflows

API reference

Getting Started

Authentication

KV Store

Get a release

Gets a release.

Gets a release.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/releases/release
  • Scope release:read
  • Effect read — nothing is written.
  • Collection releases

#Request

FieldTypeWhat it is
namestringThe name of the release to get. Required.

#Response

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.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#ReleaseSpec

FieldTypeWhat it is
membersReleaseMember[]The workloads, each by artifact digest. A member that names a tag or an unverified Artifact is refused. Required.
rollout_policyRolloutPolicyHow the Release rolls out.

#ReleaseStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
stateReleaseStateThe Release's lifecycle state. Output only. One of pending, rolling_out, live, failed, superseded, rejected.
rolloutstringThe rollout carrying this Release. Output only.
previous_releasestringThe Release that was live when this one was admitted. Output only.
successorstringThe Release that replaced this one. Output only.
member_statusesReleaseMemberStatus[]Per-member convergence. Output only.
live_timetimestampWhen the controller recorded its live milestone; not an all-Cell observation. Output only.
current_releasestringThe environment's selected live pointer, independent of this record's state. This lifecycle selection is not evidence of current traffic convergence. Output only.
reasonstringAn allow-listed customer-safe lifecycle reason, without internal error text. Output only.
served_hostnamesstring[]The current live Release's serving hostnames, read from reconciled Routes bound to this environment's Domains; empty on non-current Releases. Output only.

#ReleaseServiceArtifact

FieldTypeWhat it is
service_namestringThe service's name in this environment. Output only.
artifact_digeststringThe immutable artifact digest selected for this service. Output only.
source_shastringThe exact source commit that produced the selected artifact; empty if unknown. Output only.

#ReleaseMember

FieldTypeWhat it is
workloadstringThe workload's name in the environment, for example api: the owning service's Resource id (a Hosting service, a Workflows worker,...). Required.
artifactstringThe Artifact to run, by digest. Required.
configmap<string, string>Plain configuration values delivered as environment variables. Never a secret value: those are Secret bindings.
secretsSecretPin[]The Secret bindings the workload receives, each pinned to a version.
placementPlacementWhere the workload runs.

#RolloutPolicy

FieldTypeWhat it is
bake_durationdurationHow long each wave bakes, healthy, before the next starts; default 10 minutes.
halt_on_failureboolHalt the rollout when a wave's health gate fails; default true.
skip_wavesboolSkip the waves and apply to every cell together: break-glass only, and refused for any other principal.

#Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

#ReleaseMemberStatus

FieldTypeWhat it is
workloadstringThe workload. Output only.
observed_digeststringThe digest the cells report running. Output only.
converged_cell_countint32How many cells run the member at this Release. Output only.
cell_countint32How many cells the member is placed on. Output only.

#SecretPin

FieldTypeWhat it is
bindingstringThe binding. Required.
versionstringThe version it delivers; unset pins the binding's resolved version at admission.

#Placement

FieldTypeWhat it is
regionsstring[]Regions allowed, for example fsn1; empty means any.
cellsstring[]Specific cells, for example fs01; empty means any matching cell.
attributesmap<string, string>Required cell attributes, for example {"substrate": "metal"}.
replicasint32Replicas per cell; default 1.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/releases/release" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"