Skip to content
Console
Menu

Alerts and status pages

App store purchases

Credits

Knowledge

KV

Notifications

Organizations

Storage

Workflows

API reference

Getting Started

Authentication

KV Store

List connections

Lists an org's connections.

Lists an org's connections.

  • Path GET https://api.sylphx.com/v1/orgs/acme/connections
  • Scope connections:read
  • Effect read — nothing is written.
  • Collection connections
  • Query page_size, page_token, filter, order_by
  • Pagination the answer carries connections and, when there is more, next_page_token

#Request

FieldTypeWhat it is
parentstringThe org to list in. Required.
page_sizeint32At most this many; default 50, clamped to 1000.
page_tokenstringnext_page_token of the previous page.
filterstringAIP-160 filter over labels and filterable fields.
order_bystringAIP-132 ordering over filterable fields.

#Response

FieldTypeWhat it is
connectionsConnection[]The page.
next_page_tokenstringThe token of the next page; empty on the last page.

#Connection

FieldTypeWhat it is
namestringorgs/{org}/connections/{connection}.
uidstringcnx_<cell><ulid>. Output only.
metaResourceMetaResource metadata.
specConnectionSpecDesired state. Required.
statusConnectionStatusObserved state. Output only.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong 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_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#ConnectionSpec

FieldTypeWhat it is
providerstringThe provider this is an installation of; unset for Web Push.
external_idstringThe provider's id of the installation, for example a GitHub App installation id. Unset for Web Push.
web_pushWebPushConfigWeb Push assertion configuration. Mutually exclusive with provider and external_id. The Connection kind cannot change after creation.

#ConnectionStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
stateConnectionStateThe installation's lifecycle state. Output only. One of pending, active, suspended, removed.
accountExternalAccountThe third-party account the provider is installed on. Output only.
repository_selectionRepositorySelectionWhether the installation covers every repository or a selection. Output only. One of all, selected.
permissionsmap<string, string>The permissions the account granted, for example {"contents": "read"}. Output only.
eventsstring[]The webhook events the installation delivers. Output only.
install_timetimestampWhen the provider says the installation was created. Output only.
suspend_timetimestampWhen the provider suspended the installation. Output only.
verify_timetimestampWhen the status was last read back from the provider. Output only.

#WebPushConfig

FieldTypeWhat it is
keystringEnabled, generated SIGN/ec_p256_sha256 Key in the Connection organization. Required.
contactstringOperator contact, a mailto: or HTTPS URI; used as the JWT subject. Required.

#Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

#ExternalAccount

FieldTypeWhat it is
external_idstringThe provider's id of the account. Output only.
loginstringThe account's login, for example SylphxAI. Output only.
kindExternalAccountKindWhether the account is a person or an organization. Output only. One of user, organization.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl "https://api.sylphx.com/v1/orgs/acme/connections" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"