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
Connections
A Connection is one installation of a ConnectionProvider on a third-party account, for example the *Sylphx* App installed on a GitHub…
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 Connection is one installation of a ConnectionProvider on a third-party account, for example the Sylphx App installed on a GitHub organization. The Connections controller confirms it with the provider through the credential service before it is Ready.
Service Sylphx Connections · Resource type connections.sylphx.com/Connection · Name pattern orgs/{org}/connections/{connection} · 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}/connections/{connection}. |
uid | string | cnx_<cell><ulid>. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | ConnectionSpec | Desired state. Required. |
status | ConnectionStatus | 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. |
GET | list | Lists an org's connections. |
POST | create | Records an installation; the controller confirms it with the provider. |
PATCH | update | Updates a connection's metadata. |
DELETE | delete | Forgets a connection. The installation itself is removed at the provider. |
#get
Gets a connection.
GET https://api.sylphx.com/v1/orgs/acme/connections/connection · scope connections:read · effect read · not available yet · Request, response and examples
#list
Lists an org's connections.
GET https://api.sylphx.com/v1/orgs/acme/connections · scope connections:read · effect read · not available yet · paginated · Request, response and examples
#create
Records an installation; the controller confirms it with the provider.
POST https://api.sylphx.com/v1/orgs/acme/connections · scope connections:write · effect write · not available yet · long-running · Request, response and examples
#update
Updates a connection's metadata.
PATCH https://api.sylphx.com/v1/orgs/acme/connections/connection · scope connections:write · effect write · not available yet · long-running · Request, response and examples
#delete
Forgets a connection. The installation itself is removed at the provider.
DELETE https://api.sylphx.com/v1/orgs/acme/connections/connection · scope connections:write · effect destructive · not available yet · long-running · Request, response and examples