Skip to content
Console
Menu

Queues

Workflows

Getting Started

Authentication

KV Store

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.

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

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

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/services/{service}.
uidstringsvc_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specServiceSpecDesired state. Required.
statusServiceStatusObserved 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.

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 · not available yet · 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 · not available yet · 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