Connection Definitions

Retrieve Connection Definition

get/v1/connection-definitions/{id}

Request

  • Base URL: https://api.withone.ai
  • URL: https://api.withone.ai/v1/connection-definitions/{id}
  • Auth: API key in header X-One-Secret

Path parameters

idstring required

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

Connection definition ID

Query parameters

showAuthenticationboolean

Response

Connection definition

_idinteger required
activeboolean required
authSecretsstring[] required
authenticationstring nullable
changeLogChangeLog required
createdAtstring date-time required
deletedboolean required
idstring required

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

keystring required
namestring required
oauthboolean required
platformstring required
platformVersionstring required
status'not_available' | 'beta' | 'alpha' | 'generally_available' required
tagsstring[] required
type'api' | 'databasesql' | 'databasenosql' | 'filesystem' | 'stream' | 'custom' required
updatedAtstring date-time required
versionstring required

Changes

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