Skip to content
Console
Menu

Generated Assets

Workflows

Getting Started

Authentication

KV Store

Service enablements

A ServiceEnablement says whether one service is enabled on a Project: the project's keys reach a service only while it is enabled…

A ServiceEnablement says whether one service is enabled on a Project: the project's keys reach a service only while it is enabled (onboarding spec §3.2). It is project-scoped, applies to every environment of the project, and is named by the service id (data, hosting,...): the rows are fixed by the platform's service list, so there is no create or delete, and an update writes spec.enabled.

Service Sylphx Access · Resource type access.sylphx.com/ServiceEnablement · Name pattern orgs/{org}/projects/{project}/service_enablements/{service_enablement} · Shape spec_status

#Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/service_enablements/{service}.
uidstringThe service id; equals the name segment. Output only.
metaResourceMetaResource metadata.
specServiceEnablementSpecDesired state. Required.
statusServiceEnablementStatusObserved 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 enablement.
GETlistLists the service enablements of a project, one per service.
PATCHupdateEnables or disables a service on a project (spec.enabled).

#get

Gets a service enablement.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/service_enablements/service-enablement · scope access:read · effect read · Request, response and examples

#list

Lists the service enablements of a project, one per service.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/service_enablements · scope access:read · effect read · paginated · Request, response and examples

#update

Enables or disables a service on a project (spec.enabled).

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/service_enablements/service-enablement · scope access:admin · effect write · Request, response and examples