Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Connection providers
A ConnectionProvider is a third-party integration an org operates, for example the *Sylphx* GitHub App owned by `sylphx-platform`.
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.
A ConnectionProvider is a third-party integration an org operates, for example the Sylphx GitHub App owned by sylphx-platform. Its signing key lives in Sylphx Keys and only the credential service uses it; its webhook secret lives in Sylphx Secrets.
Service Sylphx Connections · Resource type connections.sylphx.com/ConnectionProvider · Name pattern orgs/{org}/connection_providers/{connection_provider} · Shape spec_status
Not available yet. Sylphx Connections is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.
#Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/connection_providers/{connection_provider}. |
uid | string | cnp_<cell><ulid>. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | ConnectionProviderSpec | Desired state. Required. |
status | ConnectionProviderStatus | Observed state. Output only. |
#Methods
Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a connection provider. |
GET | list | Lists an org's connection providers. |
POST | create | Creates a connection provider. |
PATCH | update | Updates a connection provider. |
DELETE | delete | Deletes a connection provider; it must have no connections. |
#get
Gets a connection provider.
GET https://api.sylphx.com/v1/orgs/acme/connection_providers/connection-provider · scope connections:read · effect read · not available yet · Request, response and examples
#list
Lists an org's connection providers.
GET https://api.sylphx.com/v1/orgs/acme/connection_providers · scope connections:read · effect read · not available yet · paginated · Request, response and examples
#create
Creates a connection provider.
POST https://api.sylphx.com/v1/orgs/acme/connection_providers · scope connections:admin · effect write · not available yet · Request, response and examples
#update
Updates a connection provider.
PATCH https://api.sylphx.com/v1/orgs/acme/connection_providers/connection-provider · scope connections:admin · effect write · not available yet · Request, response and examples
#delete
Deletes a connection provider; it must have no connections.
DELETE https://api.sylphx.com/v1/orgs/acme/connection_providers/connection-provider · scope connections:admin · effect destructive · not available yet · Request, response and examples