Menu
Platform
AI
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
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
sylphx access envs
Every sylphx access envs 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 envs commands of Sylphx Access, as the CLI spells them: the same
calls as the envs API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#get
Gets an environment.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx access envs get orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production · scope access:read · effect read · Request, response and examples
#list
Lists environments in a project.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx access envs list orgs/acme/projects/shopGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs · 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 environment. Access assigns the id.
CLI
sylphx access envs create --parent orgs/acme/projects/shop --spec.slug … --spec.mode livePOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs · scope access:admin · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--parent | string | The parent to create in; defaults to the linked project or the key's scope. |
--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 | Unique within the project, for example production. Required. |
--spec.mode | enum | Live or test; a test key never touches a live environment. Required. One of live, test. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#update
Updates an environment.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx access envs update orgs/acme/projects/shop/envs/production --spec.slug …PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production · 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 | Unique within the project, for example production. Required. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#delete
Deletes an environment.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx access envs delete orgs/acme/projects/shop/envs/production --yesDELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production · 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. |
--yes | bool | Do not ask before this destructive call. |