Console

Start

Platform

App store purchases

Auth

Builds

Database

Flags

Hosting

Jobs and cron

Localization

Monitoring

Network

Notifications

Organizations

Payments

Queues

Events

Realtime

Runners

Sandboxes

Storage

Webhooks

Workflows

Getting Started

Installation

Authentication

AI Services

KV Store

Overview

Webhooks

Deploy & Infrastructure

Reference

On this page

Request
Service
ResourceMeta
ServiceSpec
ServiceSource
ServiceScaling
ServiceHealth
Response
ProblemDetails
OperationProgress
Condition
Errors
Examples

Reference

Update a service

Updates a service.

Checked 2026-09-28

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.

Updates a service.

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 PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service
Scope hosting:write
Effect write — a successful call changes state.
Collection services
Query update_mask, allow_missing, validate_only
Operation answers with an Operation; the result is Service

#Request

Field	Type	What it is
`service`	`Service`	The service to update; `name` identifies it. Required.
`update_mask`	`field_mask`	The fields to write; unset writes every populated field.
`allow_missing`	`bool`	Create the Resource when it does not exist (declarative upsert).
`validate_only`	`bool`	Validate and return the result without writing anything.

#Service

Field	Type	What it is
`name`	`string`	`orgs/{org}/projects/{project}/envs/{env}/services/{service}`.
`meta`	`ResourceMeta`	Resource metadata.
`spec`	`ServiceSpec`	Desired state. Required.

#ResourceMeta

Field	Type	What it is
`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.

#ServiceSpec

Field	Type	What it is
`source`	`ServiceSource`	What the Service runs. Required.
`command`	`string`	Overrides the image's command.
`port`	`int32`	The port the application listens on; the public edge stays 443.
`exposure`	`ServiceExposure`	Who can reach the Service; default PUBLIC. One of `public`, `internal`.
`size`	`InstanceSize`	The size of each instance; default the plan's. One of `nano`, `micro`, `small`, `standard`, `large`, `xlarge`, `xxlarge`.
`scaling`	`ServiceScaling`	Instance bounds.
`health`	`ServiceHealth`	How instances are probed.
`env`	`map<string, string>`	Plain environment variables. Secret values bind through `secret_env`, never here.
`secret_env`	`map<string, string>`	Environment variables bound to Sylphx Secrets: variable name to Secret name. The value never enters the spec.
`regions`	`string[]`	Regions to run in; default the project's home region.

#ServiceSource

Field	Type	What it is
`source_link`	`string`	Build from this SourceLink's repository on every push to `branch`. One of the `source` group.
`image`	`string`	Run this Artifact, by digest: `registry.sylphx.net/<path>@sha256:<hex>`. One of the `source` group.
`branch`	`string`	The branch that ships to this Service; default the SourceLink's production branch. Ignored for `image`.
`build`	`ServiceBuild`	How Build turns the source into an image. Ignored for `image`.

#ServiceScaling

Field	Type	What it is
`min_instances`	`int32`	Instances kept running with no traffic; 0 idles to zero and wakes on request.
`max_instances`	`int32`	Instances at most; 0 means the plan's limit.

#ServiceHealth

Field	Type	What it is
`protocol`	`HealthProtocol`	How to probe. Required. One of `http`, `tcp`.
`path`	`string`	The HTTP path to probe when `protocol` is HTTP.
`startup_timeout`	`duration`	How long a new instance may take to pass its first probe.

#Response

Field	Type	What it is
`name`	`string`	`{parent-of-target}/operations/{operation}`.
`target`	`string`	The name of the Resource being changed.
`target_generation`	`int64`	The generation this Operation waits for.
`verb`	`OperationVerb`	What the Operation does. One of `create`, `update`, `delete`, `custom`.
`custom_verb`	`string`	The custom method verb when `verb` is CUSTOM, for example `revoke`.
`done`	`bool`	Whether the Operation has finished.
`create_time`	`timestamp`	When the Operation started.
`end_time`	`timestamp`	When the Operation finished.
`response`	`any`	The settled Resource (or Empty for a delete). One of the `result` group.
`error`	`ProblemDetails`	The failure, as the one error body. One of the `result` group.
`progress`	`OperationProgress`	Progress while not `done`.

#ProblemDetails

Field	Type	What it is
`type`	`string`	`https://sylphx.com/docs/errors/<code in kebab-case>`.
`title`	`string`	A short customer-safe summary of the problem class.
`status`	`int32`	The HTTP status, fixed by `grpc_status`.
`detail`	`string`	A customer-safe explanation of this occurrence. Never contains SQL, stack traces, internal hostnames, or another tenant's data.
`instance`	`string`	The request id (`Sylphx-Request-Id`).
`code`	`string`	The stable UPPER_SNAKE code, one of ErrorCode without its prefix.
`grpc_status`	`string`	One of the 16 canonical gRPC status names, for example `ABORTED`.
`retryable`	`bool`	Whether the same request may be retried.
`effect`	`ErrorEffect`	What the failed call committed. One of `none`, `applied`, `unknown`.
`retry_after_ms`	`int64`	How long to wait before retrying, when the server knows.
`details`	`any[]`	Typed details such as PreconditionFailure or EntitlementDenial.

#OperationProgress

Field	Type	What it is
`percent`	`int32`	Percent complete, when the controller can tell.
`message`	`string`	A customer-safe progress message.
`conditions`	`Condition[]`	The target's conditions when this progress was read.

#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.
UNKNOWN_FIELD — The request has a field the schema does not know.
INVALID_FIELD — A field failed validation.
ETAG_MISMATCH — The etag sent does not match the Resource's current etag.
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 PATCH "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"orgs/acme/projects/shop/envs/production/services/service","spec":{"source":{}}}'

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links