Connections

Retrieve Connection

Returns details for a single connection, including its platform, status, and connection key.

get/v1/connections/{id}

Request

  • Base URL: https://api.withone.ai
  • URL: https://api.withone.ai/v1/connections/{id}
  • Auth: one of:
    • API key in header X-One-Secret
    • OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: user:connections:read)
    • OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: org:connections:read)
    • OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: project:connections:read)

Path parameters

idstring uuid required

Connection ID

Headers

X-One-Organization-Idstring uuid

Selects the tenant this request acts in. Omit it to act in your personal scope.

X-One-Project-Idstring uuid

Selects the tenant this request acts in. Omit it to act in your personal scope.

Response

Connection details

activeboolean required
changeLogChangeLog required
connectionDefinitionIdstring required

Prefixed ID with 'conn_def' prefix (e.g., 'conn_def_1C'), also accepts raw integer

connectionOauthDefIdstring

Prefixed ID with 'conn_oauth_def' prefix (e.g., 'conn_oauth_def_1C'), also accepts raw integer

createdAtstring date-time required
deletedboolean required
environment'test' | 'live' required
expiresAtstring date-time nullable
expiresIninteger nullable
groupstring required
idstring uuid required
identitystring nullable
identityType'organization' | 'user' | 'team' | 'project'
imagestring nullable
keystring required
namestring nullable
platformstring required
platformVersionstring required
secretIdstring uuid required
state'operational' | 'degraded' | 'failed' | 'unknown' required
tagsstring[] required
titlestring nullable
type'api' | 'databasesql' | 'databasenosql' | 'filesystem' | 'stream' | 'custom' required
updatedAtstring date-time required
userIdstring uuid required
versionstring required
webhookSecretIdstring uuid nullable

Changes

No recorded changes to this operation across all 1 revision of this API.