Skip to main content
GET
/
v1
/
connections
List Connections
curl --request GET \
  --url https://api.cyberdesk.io/v1/connections \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "websocket_id": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "connected_at": "2023-11-07T05:31:56Z",
      "disconnected_at": "2023-11-07T05:31:56Z",
      "last_ping": "2023-11-07T05:31:56Z",
      "status": "connected",
      "ip_address": "<string>",
      "user_agent": "<string>"
    }
  ],
  "total": 123,
  "skip": 123,
  "limit": 123
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
machine_id
string<uuid> | null

Filter by machine ID

​
status
enum<string> | null

Filter by connection status

Available options:
connected,
disconnected,
error
​
skip
integer
default:0
Required range: x >= 0
​
limit
integer
default:100
Required range: 1 <= x <= 1000

Response

Successful Response

​
items
ConnectionResponse · object[]
required
​
total
integer
required
​
skip
integer
required
​
limit
integer
required