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 connection_providers
Every sylphx connections connection_providers command: its argument, its flags and a run line.
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.
#begin-registration
Begins an expiring, one-use GitHub manifest registration ceremony. Open registration_url to POST the bound, prefilled manifest to GitHub. github_organization selects organization ownership. The state-authorized callback is GET /v1/connections/github-manifest:callback?state=...&code=... and returns only provider metadata and an installation URL.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx connections connection-providers begin-registration orgs/acmePOST https://api.sylphx.com/v1/orgs/acme/connection_providers:beginRegistration · scope connections:admin · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--connection-provider-id | string | Explicit immutable provider identity. Required. |
--signing-key | string | Unused environment-scoped public Keys target in this organization. Required. |
--webhook-secret | string | Environment-scoped Secrets custody target in this organization. Required. |
--github-manifest | json | Permissions, events and the declared platform webhook destination. Required. |
--expected-github-app-slug | string | Slug whose literal wrapped-import path has been enrolled in custody. Renaming the App at GitHub causes the callback to refuse before import. Required. |
--github-organization | string | GitHub organization that will own the App; unset selects a personal account. |
#adopt
Adopts an existing GitHub App whose non-exportable custody already exists. The server observes public SPKI metadata and verifies signed GET /app before atomically registering the SIGN Key and provider. No private key is accepted.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx connections connection-providers adopt orgs/acmePOST https://api.sylphx.com/v1/orgs/acme/connection_providers:adopt · scope connections:admin · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--connection-provider-id | string | Explicit immutable provider identity. Required. |
--github-app | json | Existing App identity and unused full environment-scoped SIGN Key target. An optional webhook_secret must already name this organization's Secret. Required. |
--reason | string | Accountable operator's reason for adopting the existing App. Required. |
#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. |
#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; force forgets its local connections only.
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 forget every child Resource; without it a parent with children fails with INVALID_STATE. This never uninstalls the App at GitHub. |
--yes | bool | Do not ask before this destructive call. |