Menu
Platform
AI
Analytics
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
sylphx access orgs
Every sylphx access orgs command: its argument, its flags and a run line.
This method is not served on the public API.
api.sylphx.comdoes 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.
The orgs commands of Sylphx Access, as the CLI spells them: the same
calls as the orgs API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#get
Gets an org.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx access orgs get orgs/acmeGET https://api.sylphx.com/v1/orgs/acme · scope access:read · effect read · Request, response and examples
#list
Lists orgs the caller can see.
CLI
sylphx access orgs listGET https://api.sylphx.com/v1/orgs · scope access:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | At most this many; default 50, clamped to 1000. |
--page-token | string | next_page_token of the previous page. |
--filter | string | AIP-160 filter over labels, filterable spec fields, and Ready. |
--order-by | string | AIP-132 ordering over filterable fields. |
#create
Creates an org. Access assigns the id.
CLI
sylphx access orgs create --spec.slug …POST https://api.sylphx.com/v1/orgs · scope access:admin · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.slug | string | Globally unique handle, resolved to the id by clients, never the server. Required. |
--spec.api-version | string | The API version (YYYY-MM-DD) requests are served at when neither the request nor the key pins one. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#update
Updates an org.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx access orgs update orgs/acme --spec.slug …PATCH https://api.sylphx.com/v1/orgs/acme · scope access:admin · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--meta.labels | key=value | Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value. |
--meta.annotations | key=value | Caller-writable, unindexed annotations. Repeat the flag for each value. |
--meta.display-name | string | Caller-writable human-readable name. |
--spec.slug | string | Globally unique handle, resolved to the id by clients, never the server. Required. |
--spec.api-version | string | The API version (YYYY-MM-DD) requests are served at when neither the request nor the key pins one. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#delete
Deletes an org and everything in it. Deletion cascades through every service, so it returns an Operation.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx access orgs delete orgs/acme --yesDELETE https://api.sylphx.com/v1/orgs/acme · scope access:admin · effect destructive · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--etag | string | Delete only if the current etag matches. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--force | bool | Also delete every child Resource; without it a parent with children fails with FAILED_PRECONDITION. |
--no-wait | bool | Return the call at once instead of waiting for it to finish. |
--yes | bool | Do not ask before this destructive call. |