List Connections | Coactive AI

curl https://api.coactive.ai/api/v0/connections \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "meta": {
    "page": {
      "current_page": 1,
      "limit": 10,
      "offset": 0
    },
    "links": {
      "current": "https://api.coactive.ai/api/v0/connections?offset=0&limit=10",
      "previous": "",
      "next": "https://api.coactive.ai/api/v0/connections?offset=10&limit=10"
    }
  },
  "data": [
    {
      "connection_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "api_connection_01",
      "type": "https_basic",
      "status": "pending",
      "config": {
        "hostname": "api.example.com",
        "username": "apiuser",
        "password": "securePass123"
      },
      "created_dt": "2024-01-15T09:30:00Z",
      "updated_dt": "2024-01-15T09:30:00Z",
      "description": "Primary API connection for data ingestion"
    }
  ]
}

List all connections with optional filtering

Authentication

AuthorizationBearer

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

Query parameters

statusenum or nullOptional

Filter by connection status

Allowed values:

connection_typeenum or nullOptional

Filter by connection type

Allowed values:

offsetintegerOptionalDefaults to 0

Number of items to skip

limitintegerOptionalDefaults to 100

Maximum number of items to return

Request

This endpoint expects a nullable list of strings.

Response

Successful Response

metaobject

Metadata for the set of data returned

datalist of objects

The paginated data

Errors

422

Unprocessable Entity Error