Skip to content
Console
On this page

Services

A Service is one deployable workload: pushed code builds, ships as a Release in waves, serves on its routes, and idles to zero when unused.

A Service is one deployable workload: pushed code builds, ships as a Release in waves, serves on its routes, and idles to zero when unused.

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

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/services/{service}.
uidstringsvc_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specServiceSpecDesired state, omitted when no immutable public projection is available.
statusServiceStatusObserved state. Output only.
projection_incompleteboolTrue when some desired inputs or serving observations are unavailable. Output only.
unavailable_fieldsstring[]Field paths not established by retained evidence. 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.

MethodCallWhat it does
GETgetGets a service.
GETlistLists services in a environment.
POSTcreateCreates a service. The Operation is done when the controller settles it.
PATCHupdateUpdates a service.
DELETEdeleteDeletes a service.

get

Gets a service.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service · scope hosting:read · effect read · Request, response and examples

list

Lists services in a environment.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services · scope hosting:read · effect read · paginated · Request, response and examples

create

Creates a service. The Operation is done when the controller settles it.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services · scope hosting:write · effect write · not available yet · long-running · Request, response and examples

update

Updates a service.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service · scope hosting:write · effect write · not available yet · long-running · Request, response and examples

delete

Deletes a service.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/services/service · scope hosting:write · effect destructive · not available yet · long-running · Request, response and examples