---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Connections"
description: "The `connections` collection of Sylphx Connections: A Connection is one installation of a ConnectionProvider on a third-party account, for example the *Sylphx* App installed on a GitHub organization."
type: reference
product: platform
summary: "A Connection is one installation of a ConnectionProvider on a third-party account, for example the *Sylphx* App installed on a GitHub…"
updated: 2026-09-28
order: 900
---

> **This method is not served on the public API.** `api.sylphx.com` does 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`](/docs/api/connections#get) | Gets a connection. |
| `GET` | [`list`](/docs/api/connections#list) | Lists an org's connections. |
| `POST` | [`create`](/docs/api/connections#create) | Records an installation; the controller confirms it with the provider. |
| `PATCH` | [`update`](/docs/api/connections#update) | Updates a connection's metadata. |
| `DELETE` | [`delete`](/docs/api/connections#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](/docs/api/connections/get)

## 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](/docs/api/connections/list)

## 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](/docs/api/connections/create)

## 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](/docs/api/connections/update)

## 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](/docs/api/connections/delete)