Skip to content
Console
On this page

Orgs

An Org is the one Sylphx account: created once, billed once.

An Org is the one Sylphx account: created once, billed once.

Service Sylphx Access · Resource type access.sylphx.com/Org · Name pattern orgs/{org} · Shape spec_status

Fields

FieldTypeWhat it is
namestringorgs/{org}.
uidstringorg_<cell><ulid>; equals the name segment. Output only.
metaResourceMetaResource metadata.
specOrgSpecDesired state. Required.
statusOrgStatusObserved 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 an org.
GETlistLists orgs the caller can see.
POSTcreateCreates an org. Access assigns the id.
PATCHupdateUpdates an org.
DELETEdeleteDeletes an org and everything in it. Deletion cascades through every service, so it returns an Operation.

get

Gets an org.

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

list

Lists orgs the caller can see.

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

create

Creates an org. Access assigns the id.

POST https://api.sylphx.com/v1/orgs · scope access:admin · effect write · Request, response and examples

update

Updates an org.

PATCH https://api.sylphx.com/v1/orgs/acme · scope access:admin · effect write · Request, response and examples

delete

Deletes an org and everything in it. Deletion cascades through every service, so it returns an Operation.

DELETE https://api.sylphx.com/v1/orgs/acme · scope access:admin · effect destructive · long-running · Request, response and examples