MImirurobotics
Devices

List

List devices.

get/devices

Request

  • Base URL
    https://api.mirurobotics.com/beta
  • URL
    https://api.mirurobotics.com/beta/devices
  • Auth
    API key in header X-API-Key

Query parameters

offsetinteger

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

limitinteger
Example:10

The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

order_byDeviceOrderBy[]

Sort order for the device results.

[
  "created_at:desc"
]
expandDeviceListExpansion[]

Fields to expand on each device in the list.

[
  "current_release"
]
idstring[]

The device IDs to filter by.

[
  "dev_123"
]
namestring[]

The device names to filter by.

[
  "My Device"
]
agent_versionstring[]

The agent versions to filter by.

[
  "v1.0.0"
]
current_release_idstring[]

The release IDs to filter devices by their current release.

[
  "rls_123"
]
group_idstring[]

The group IDs to filter devices by.

[
  "grp_123"
]
statusDeviceStatus[]

The device statuses to filter by.

[
  "online"
]

Response

Successfully listed the devices.

object'list' required

The object type, which is always list.

total_countinteger

The total number of items in the list. By default the total count is not returned. The total count must be expanded (using expand=total_count) to get the total number of items in the list.

limitinteger required

The maximum number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

offsetinteger required

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

has_moreboolean required

True if there are more items in the list to return. False if there are no more items to return.

Example response

{
  "object": "list",
  "data": [
    {
      "object": "device",
      "id": "dvc_123",
      "name": "My Device",
      "description": "Welder on line 3",
      "status": "online",
      "agent_version": "v1.0.0",
      "os": "linux",
      "hostname": "robot-1.local",
      "arch": "x86_64",
      "os_version": "Ubuntu 22.04",
      "kernel_version": "5.15.0-91-generic",
      "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",
      "group_id": "grp_123"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.