Skip to main content
POST
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 synced the device.

code
enum<string>
required

The result of attempting to sync the device.

Available options:
success,
network_connection_error,
in_cooldown
message
string
required

The message of the result.

Example:

"The device is in cooldown and can sync again in 25 seconds."

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:

120

last_attempted_sync_secs_ago
integer<int64>
required

Seconds since the device last attempted to sync, as measured by the agent when it built this response.

Required range: x >= 0
Example:

5

in_cooldown
boolean
required

Whether the device is currently in cooldown.

Example:

true

cooldown_ends_in_secs
integer<int64>
required

Seconds until the cooldown ends, rounded up, as measured by the agent when it built this response. 0 exactly when in_cooldown is false.

Required range: x >= 0
Example:

25