v1

latestOpenAPI 3.1.02026-08-04118425322.0 KB
connections > connections

Get Connection

Retrieve a connection by name or ID

get/api/v0/connections/{connection_name_or_id}

Path parameters

string uuid required
OR
string required

The connection name or UUID

Headers

Authorizationstring required

Bearer authentication

Response

Successful Response

connection_idstring uuid required

The unique identifier for the connection

namestring required

The connection name

descriptionstring nullable

The connection description

type'https_basic' | 'https_bearer' | 'aws_iam_role' required

The type of connection

status'pending' | 'ready' | 'error' required

The status of a connection

created_dtstring date-time required

When the connection was created

updated_dtstring date-time required

When the connection was last updated