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 connections connection_providers
Every sylphx connections connection_providers 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 connection_providers commands of Sylphx Connections, as the CLI spells them: the same
calls as the connection_providers API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
Not available yet. Sylphx Connections is declared in the registry but no backend serves it: every command answers 501 with the problem code UNIMPLEMENTED.
#get
Gets a connection provider.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx connections connection-providers get orgs/acme/connection_providers/connection-providerGET https://api.sylphx.com/v1/orgs/acme/connection_providers/connection-provider · scope connections:read · effect read · Request, response and examples
#list
Lists an org's connection providers.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx connections connection-providers list orgs/acmeGET https://api.sylphx.com/v1/orgs/acme/connection_providers · 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
Creates a connection provider.
ID — The id segment of the new Resource's name; the server assigns one when omitted.
CLI
sylphx connections connection-providers create --parent orgs/acmePOST https://api.sylphx.com/v1/orgs/acme/connection_providers · scope connections: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.github-app.app-id | int | The App's numeric id. |
--spec.github-app.slug | string | The App's slug, for example sylphx. |
--spec.github-app.client-id | string | The App's OAuth client id. |
--spec.github-app.signing-key | string | The imported, non-exportable SIGN Key (RS256) that signs App assertions; only the credential service may use it. |
--spec.github-app.webhook-secret | string | The Secret holding the webhook secret that verifies deliveries. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#update
Updates a connection provider.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx connections connection-providers update orgs/acme/connection_providers/connection-providerPATCH https://api.sylphx.com/v1/orgs/acme/connection_providers/connection-provider · scope connections: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.github-app.slug | string | The App's slug, for example sylphx. |
--spec.github-app.client-id | string | The App's OAuth client id. |
--spec.github-app.signing-key | string | The imported, non-exportable SIGN Key (RS256) that signs App assertions; only the credential service may use it. |
--spec.github-app.webhook-secret | string | The Secret holding the webhook secret that verifies deliveries. |
--dry-run | bool | Validate and print the result without writing (validate_only). |
#delete
Deletes a connection provider; it must have no connections.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx connections connection-providers delete orgs/acme/connection_providers/connection-provider --yesDELETE https://api.sylphx.com/v1/orgs/acme/connection_providers/connection-provider · scope connections: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. |