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
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}. |
uid | string | org_<cell><ulid>; equals the name segment. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | OrgSpec | Desired state. Required. |
status | OrgStatus | Observed 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.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets an org. |
GET | list | Lists orgs the caller can see. |
POST | create | Creates an org. Access assigns the id. |
PATCH | update | Updates an org. |
DELETE | delete | Deletes 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