---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Releases"
description: "The `releases` collection of Sylphx Release: A Release is an immutable desired state of an environment's workloads."
type: reference
product: platform
summary: "A Release is an immutable desired state of an environment's workloads."
updated: 2026-09-28
order: 900
---

> **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

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

## 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.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/releases#get) | Gets a release. |
| `GET` | [`list`](/docs/api/releases#list) | Lists releases in an environment, newest first by default. |
| `POST` | [`create`](/docs/api/releases#create) | Creates 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](/docs/api/releases/get)

## 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](/docs/api/releases/list)

## 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](/docs/api/releases/create)