Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-22399194.2 KB
Devices

Update

Update a device by ID.

patch/devices/{device_id}

Path parameters

device_idstring required
Example:dvc_123

The unique identifier of the device.

Query parameters

expandDeviceExpansion[]

Fields to expand on the device resource.

[
  "current_release"
]

Request body

namestring

The new name of the device. If excluded from the request, the device name is not updated.

Example request

{
  "name": "Robot 1"
}

Response

Successfully updated the device.

object'device' required

The object type, which is always device.

idstring required

ID of the device.

namestring required

Name of the device.

status'inactive' | 'activating' | 'online' | 'offline' required

The status of the device.

  • Inactive: The miru agent has not yet been installed / authenticated
  • Activating: The miru agent is currently being installed / authenticated (should only last for a few seconds)
  • Online: The miru agent has successfully pinged the server within the last 60 seconds.
  • Offline: The miru agent has not successfully pinged the server within the last 60 seconds (e.g. network issues, device is powered off, etc.)
agent_versionstring nullable required

The version of the agent the device is running.

last_connected_atstring date-time nullable required

Timestamp of when the device was last made an initial connection (this is not the same as the last time the device was seen).

last_disconnected_atstring date-time nullable required

Timestamp of when the device was last disconnected (this is not the same as the last time the device was seen).

created_atstring date-time required

Timestamp of when the device was created.

updated_atstring date-time required

Timestamp of when the device was last updated.

Example response

{
  "object": "device",
  "id": "dvc_123",
  "name": "My Device",
  "status": "online",
  "agent_version": "v1.0.0",
  "last_connected_at": "2021-01-01T00:00:00Z",
  "last_disconnected_at": null,
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z"
}