Connections

Endpoints for managing connections

Get all connections

get

This endpoint retrieves all connections.

Authorizations

Query parameters

sort-fieldstringOptional

The field to sort by.

sort-directionstringOptional

The direction to sort (asc or desc).

page-sizeintegerOptional

The number of connections per page.

current-pageintegerOptional

The current page number.

item-countintegerOptional

The total number of items.

Responses

200

A list of connections

application/json

401

Unauthorized.

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/connections HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

[]

Get a connection by ID

get

This endpoint retrieves a connection by its id.

Authorizations

Path parameters

idstringRequired

The connection id of the connection to retrieve.

Responses

200

Connection record retrieved successfully

application/json

401

Unauthorized.

404

Connection not found

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/connections/{id} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{}