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
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
sylphx connections connections
Every sylphx connections connections command: its argument, its flags and a run line.
The connections commands of Sylphx Connections, as the CLI spells them: the same
calls as the connections API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#get
Gets a connection.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx connections connections get orgs/acme/connections/connectionGET https://api.sylphx.com/v1/orgs/acme/connections/connection · scope connections:read · effect read · Request, response and examples
#list
Lists an org's connections.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx connections connections list orgs/acmeGET https://api.sylphx.com/v1/orgs/acme/connections · scope connections: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 and filterable fields. |
--order-by | string | AIP-132 ordering over filterable fields. |
#create
Records an installation; the controller confirms it with the provider.
ID — The id segment of the new Resource's name; the server assigns one when omitted.
CLI
sylphx connections connections create --parent orgs/acme --spec.provider … --spec.external-id …POST https://api.sylphx.com/v1/orgs/acme/connections · scope connections:write · 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.provider | string | The provider this is an installation of. Required. |
--spec.external-id | string | The provider's id of the installation, for example a GitHub App installation id. Required. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--no-wait | bool | Return the call at once instead of waiting for it to finish. |
#update
Updates a connection's metadata.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx connections connections update orgs/acme/connections/connectionPATCH https://api.sylphx.com/v1/orgs/acme/connections/connection · scope connections:write · 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. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
--no-wait | bool | Return the call at once instead of waiting for it to finish. |
#delete
Forgets a connection. The installation itself is removed at the provider.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx connections connections delete orgs/acme/connections/connection --yesDELETE https://api.sylphx.com/v1/orgs/acme/connections/connection · scope connections:write · 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). |
--no-wait | bool | Return the call at once instead of waiting for it to finish. |
--yes | bool | Do not ask before this destructive call. |