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
Get a connection
Gets a connection.
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.
Gets a connection.
Not available yet. Sylphx Connections is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.
- Path
GET https://api.sylphx.com/v1/orgs/acme/connections/connection - Scope
connections:read - Effect
read— nothing is written. - Collection connections
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the connection to get. Required. |
#Response
| 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. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#ConnectionSpec
| Field | Type | What it is |
|---|---|---|
provider | string | The provider this is an installation of. Required. |
external_id | string | The provider's id of the installation, for example a GitHub App installation id. Required. |
#ConnectionStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
state | ConnectionState | The installation's lifecycle state. Output only. One of pending, active, suspended, removed. |
account | ExternalAccount | The third-party account the provider is installed on. Output only. |
repository_selection | RepositorySelection | Whether the installation covers every repository or a selection. Output only. One of all, selected. |
permissions | map<string, string> | The permissions the account granted, for example {"contents": "read"}. Output only. |
events | string[] | The webhook events the installation delivers. Output only. |
install_time | timestamp | When the provider says the installation was created. Output only. |
suspend_time | timestamp | When the provider suspended the installation. Output only. |
verify_time | timestamp | When the status was last read back from the provider. Output only. |
#Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
#ExternalAccount
| Field | Type | What it is |
|---|---|---|
external_id | string | The provider's id of the account. Output only. |
login | string | The account's login, for example SylphxAI. Output only. |
kind | ExternalAccountKind | Whether the account is a person or an organization. Output only. One of user, organization. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/connections/connection" \
-H "Authorization: Bearer $SYLPHX_API_KEY"