Test Connection | Coactive AI

Test a connection to verify it works correctly

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

connection_name_or_idstringRequired

The connection name or UUID

This endpoint expects an object.

locationstringOptionalDefaults to /

Specific location to use to test the connection

update_statebooleanOptionalDefaults to true

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

Successful Response

connection_idstringformat: "uuid"

The unique identifier for the connection

namestringformat: "^[a-z0-9][a-z0-9_]+[a-z0-9]"3-255 characters

The connection name

typeenum

The type of connection

statusenum

The current status of the connection

configobject

The connection configuration

created_dtstringformat: "date-time"

When the connection was created

updated_dtstringformat: "date-time"

When the connection was last updated

descriptionstring or null

The connection description

422

Unprocessable Entity Error

$	curl -X POST https://api.coactive.ai/api/v0/connections/string/test \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"connection_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3	"name": "api_connection_01",
4	"type": "https_basic",
5	"status": "ready",
6	"config": {
7	"hostname": "api.example.com",
8	"username": "apiuser",
9	"password": "S3cureP@ssw0rd"
10	},
11	"created_dt": "2024-01-15T09:30:00Z",
12	"updated_dt": "2024-04-20T11:45:00Z",
13	"description": "Primary API connection for data ingestion"
14	}