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
Pause a service rollout
Holds a Rollout at its current wave.
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.
Holds a Rollout at its current wave.
Not available yet. Sylphx Hosting is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service/service_rollouts/rollout:pause - Scope
hosting:write - Effect
write— a successful call changes state. - Collection service_rollouts
- Validate-only
validate_only=trueruns every check and writes nothing
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the rollout. Required. |
etag | string | Act only if the current etag matches. |
validate_only | bool | Validate without acting. |
#Response
| 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. |
#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. |
#RolloutSpec
| Field | Type | What it is |
|---|---|---|
release | string | The Release to roll out. Unset rolls out the Service's current generation; a previous Release rolls back. |
service_generation | int64 | The Service generation this Rollout ships; a write from an older generation is rejected. Output only. |
#RolloutStatus
| 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 | RolloutState | Where the Rollout is. Output only. One of pending, progressing, paused, succeeded, aborted, failed, superseded. |
wave | RolloutWave | The wave now serving the new Release. Output only. One of canary, cell, region, all. |
cells | string[] | The cells serving the new Release. Output only. |
start_time | timestamp | When the first wave started. Output only. |
end_time | timestamp | When the Rollout reached a final state. Output only. |
#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. |
#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.ETAG_MISMATCH— The etag sent does not match the Resource's current etag.INVALID_STATE— The Resource is in a state that forbids the call.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service/service_rollouts/rollout:pause" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'