v1

latestOpenAPI 3.1.02026-08-04118425322.0 KB

connections > connections

Test Connection

Test a connection to verify it works correctly

post/api/v0/connections/{connection_name_or_id}/test

string uuid required

string required

The connection name or UUID

Authorizationstring required

Bearer authentication

locationstring

Specific location to use to test the connection

update_stateboolean

Set to true update the status of the connection, false to dry run

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