Create Connection | Coactive AI

Create a new connection to an external data source

AuthorizationBearer

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

This endpoint expects an object.

CreateHTTPSBasicAuthConnectionRequestobjectRequired

CreateHTTPSBearerAuthConnectionRequestobjectRequired

CreateAWSConnectionRequestobjectRequired

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 \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "api_connection_01",
>	"config": {
>	"hostname": "api.example-service.com",
>	"username": "api_user",
>	"password": "S3cureP@ssw0rd!"
>	}
>	}'

1	{
2	"connection_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
3	"name": "api_connection_01",
4	"type": "https_basic",
5	"status": "pending",
6	"config": {
7	"hostname": "api.example-service.com",
8	"username": "api_user",
9	"password": "S3cureP@ssw0rd!"
10	},
11	"created_dt": "2024-01-15T09:30:00Z",
12	"updated_dt": "2024-01-15T09:30:00Z",
13	"description": "Connection to Example Service API with basic auth"
14	}