Clients API

The clients API operates on Canvus clients connected to the server.

Note

Clients will not expose themselves for API access by default. This has to be enabled on each client explicitly.

List Clients

Gets all clients connected to the server.

GET /clients

Attribute Type Required Description

---

subscribe (query) boolean no See api_streaming

curl -H "Private-Token: <access token>" https://canvus.example.com/api/v1/clients

Example response:

[
  {
    "access": "rw",
    "id": "e5cad8d4-7051-4051-97bc-13e41fd81ca7",
    "installation_name": "hp-z420",
    "state": "normal",
    "version": "3.0.0 [3837d3aa9]"
  }
]

Single Client

Gets a single client.

GET /clients/:id

curl -H "Private-Token: <access token>" https://canvus.example.com/api/v1/clients/e5cad8d4-7051-4051-97bc-13e41fd81ca7

Example response:

{
  "access": "rw",
  "id": "e5cad8d4-7051-4051-97bc-13e41fd81ca7",
  "installation_name": "hp-z420",
  "state": "normal",
  "version": "3.0.0 [3837d3aa9]"
}