Skip to main content
GET
curl (Linux)

Authorizations

Authorization
string
header
required

The token from the agent's discovery file (%ProgramData%\Miru\device-api\device-api.json on Windows). Required over loopback TCP (127.0.0.1:6478 by default on Windows) and accepted by every route; not used over the Unix socket.

Response

200 - application/json

Successfully retrieved the device.

object
enum<string>
required

The object type, which is always device.

Available options:
device
Example:

"device"

id
string
required

ID of the device.

Example:

"dvc_123"

name
string
required

Name of the device.

Example:

"My Device"

status
enum<string>
required

The status of the device.

  • Online: The miru agent is connected
  • Offline: The miru agent is disconnected (e.g. network issues, device is powered off, etc.)
Available options:
online,
offline
last_synced_secs_ago
integer<int64> | null
required

Seconds since the device last synced, as measured by the agent when it built this response, or null if it hasn't synced since the agent last started.

Required range: x >= 0
Example:

42

last_connected_secs_ago
integer<int64> | null
required

Seconds since the device last connected to the backend, as measured by the agent when it built this response, or null if it hasn't connected since the agent last started.

Required range: x >= 0
Example:

3600

last_disconnected_secs_ago
integer<int64> | null
required

Seconds since the device last disconnected from the backend, as measured by the agent when it built this response, or null if it hasn't disconnected since the agent last started.

Required range: x >= 0
Example:

3605