Clients

get

Get the latest status of all clients on this network.

Includes:

• Resident status, which is the platform counterpart for the client that handles control commands.
• Connections, which are transports from the client to the platform. Note there can be multiple active connections for a single client.
• Provide status

Authorizations

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /network/clients HTTP/1.1
Host: api.bringyour.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "clients": [
    {
      "client_id": "text",
      "device_id": "text",
      "network_id": "text",
      "description": "text",
      "device_name": "text",
      "device_spec": "text",
      "create_time": "text",
      "auth_time": "text",
      "resident": {
        "client_id": "text",
        "instance_id": "text",
        "resident_id": "text",
        "resident_host": "text",
        "resident_service": "text",
        "resident_block": "text",
        "resident_internal_ports": [
          1
        ]
      },
      "provide_mode": 1,
      "connections": [
        {
          "client_id": "text",
          "connection_id": "text",
          "connect_time": "text",
          "disconnect_time": "text",
          "connection_host": "text",
          "connection_service": "text",
          "connection_block": null
        }
      ]
    }
  ]
}