Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Get a release
Gets a release.
This method is not served on the public API.
api.sylphx.comdoes 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.
Gets a release.
Not available yet. Sylphx Release is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.
- 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
| Field | Type | What it is |
|---|---|---|
name | string | The name of the release to get. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/releases/{release}. |
uid | string | rel_<cell><ulid>. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | ReleaseSpec | Desired state. Required. |
status | ReleaseStatus | Observed state. Output only. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong 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_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#ReleaseSpec
| Field | Type | What it is |
|---|---|---|
members | ReleaseMember[] | The workloads, each by artifact digest. A member that names a tag or an unverified Artifact is refused. Required. |
rollout_policy | RolloutPolicy | How the Release rolls out. |
#ReleaseStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
state | ReleaseState | The Release's lifecycle state. Output only. One of pending, rolling_out, live, failed, superseded, rejected. |
rollout | string | The rollout carrying this Release. Output only. |
previous_release | string | The Release that was live when this one was admitted. Output only. |
successor | string | The Release that replaced this one. Output only. |
member_statuses | ReleaseMemberStatus[] | Per-member convergence. Output only. |
live_time | timestamp | When every cell first served the Release. Output only. |
#ReleaseMember
| Field | Type | What it is |
|---|---|---|
workload | string | The workload's name in the environment, for example api: the owning service's Resource id (a Hosting service, a Workflows worker,...). Required. |
artifact | string | The Artifact to run, by digest. Required. |
config | map<string, string> | Plain configuration values delivered as environment variables. Never a secret value: those are Secret bindings. |
secrets | SecretPin[] | The Secret bindings the workload receives, each pinned to a version. |
placement | Placement | Where the workload runs. |
#RolloutPolicy
| Field | Type | What it is |
|---|---|---|
bake_duration | duration | How long each wave bakes, healthy, before the next starts; default 10 minutes. |
halt_on_failure | bool | Halt the rollout when a wave's health gate fails; default true. |
skip_waves | bool | Skip the waves and apply to every cell together: break-glass only, and refused for any other principal. |
#Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
#ReleaseMemberStatus
| Field | Type | What it is |
|---|---|---|
workload | string | The workload. Output only. |
observed_digest | string | The digest the cells report running. Output only. |
converged_cell_count | int32 | How many cells run the member at this Release. Output only. |
cell_count | int32 | How many cells the member is placed on. Output only. |
#SecretPin
| Field | Type | What it is |
|---|---|---|
binding | string | The binding. Required. |
version | string | The version it delivers; unset pins the binding's resolved version at admission. |
#Placement
| Field | Type | What it is |
|---|---|---|
regions | string[] | Regions allowed, for example fsn1; empty means any. |
cells | string[] | Specific cells, for example fs01; empty means any matching cell. |
attributes | map<string, string> | Required cell attributes, for example {"substrate": "metal"}. |
replicas | int32 | Replicas per cell; default 1. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
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"