---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Service rollouts"
description: "The `service_rollouts` collection of Sylphx Hosting: A Rollout moves one Service generation to its Release in waves (one canary cell, one cell, one region, all); every step is fenced by the Service generation at the moment of write, and no…"
type: reference
product: hosting
summary: "A Rollout moves one Service generation to its Release in waves (one canary cell, one cell, one region, all); every step is fenced by the…"
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 Rollout moves one Service generation to its Release in waves (one canary cell, one cell, one region, all); every step is fenced by the Service generation at the moment of write, and no wave advances without fresh recorded evidence.

**Service** Sylphx Hosting · **Resource type** `hosting.sylphx.com/Rollout` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/services/{service}/service_rollouts/{rollout}` · **Shape** `spec_status`

**Not available yet.** Sylphx Hosting 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}/services/{service}/service_rollo uts/{rollout}`. |
| `uid` | `string` | `rol_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `RolloutSpec` | Desired state. Required. |
| `status` | `RolloutStatus` | 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/service_rollouts#get) | Gets a rollout. |
| `GET` | [`list`](/docs/api/service_rollouts#list) | Lists rollouts in a service. |
| `POST` | [`create`](/docs/api/service_rollouts#create) | Creates a rollout. |
| `POST` | [`pause`](/docs/api/service_rollouts#pause) | Holds a Rollout at its current wave. |
| `POST` | [`resume`](/docs/api/service_rollouts#resume) | Resumes a paused Rollout. |
| `POST` | [`abort`](/docs/api/service_rollouts#abort) | Stops a Rollout; the cells it reached return to the previous Release. |

## get

Gets a rollout.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service/service_rollouts/rollout` · scope `hosting:read` · effect `read` · not available yet · [Request, response and examples](/docs/api/service_rollouts/get)

## list

Lists rollouts in a service.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service/service_rollouts` · scope `hosting:read` · effect `read` · not available yet · paginated · [Request, response and examples](/docs/api/service_rollouts/list)

## create

Creates a rollout.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service/service_rollouts` · scope `hosting:write` · effect `write` · not available yet · [Request, response and examples](/docs/api/service_rollouts/create)

## pause

Holds a Rollout at its current wave.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service/service_rollouts/rollout:pause` · scope `hosting:write` · effect `write` · not available yet · validate_only · [Request, response and examples](/docs/api/service_rollouts/pause)

## resume

Resumes a paused Rollout.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service/service_rollouts/rollout:resume` · scope `hosting:write` · effect `write` · not available yet · validate_only · [Request, response and examples](/docs/api/service_rollouts/resume)

## abort

Stops a Rollout; the cells it reached return to the previous Release.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service/service_rollouts/rollout:abort` · scope `hosting:write` · effect `destructive` · not available yet · validate_only · [Request, response and examples](/docs/api/service_rollouts/abort)
