Skip to main content
GET
/
devices
Python
from miru_server_sdk import Miru

client = Miru(
    api_key="My API Key",
)
devices = client.devices.list()
print(devices)
{
  "object": "list",
  "total_count": 123,
  "limit": 10,
  "offset": 0,
  "has_more": false,
  "data": [
    {
      "object": "device",
      "id": "dvc_123",
      "name": "My Device",
      "status": "inactive",
      "last_connected_at": "2021-01-01T00:00:00Z",
      "last_disconnected_at": "2021-01-01T00:00:00Z",
      "created_at": "2021-01-01T00:00:00Z",
      "updated_at": "2021-01-01T00:00:00Z"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

The API key to use for authentication. Retrieve your API key from the Miru dashboard.

Query Parameters

​
offset
integer
default:0

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

Required range: x >= 0
​
limit
integer
default:10

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

Required range: 1 <= x <= 100
​
order_by
enum<string>
default:created_at:desc

The order to sort the devices.

Available options:
id:asc,
id:desc,
created_at:desc,
created_at:asc
​
expand[]
enum<string>[]

The fields to expand in the device list.

Available options:
total_count
​
id
string

The device ID to filter by.

Example:

"dev_123"

​
name
string

The device name to filter by.

Example:

"My Device"

​
agent_version
string

The agent version to filter by.

Example:

"v1.0.0"

​
current_release_id
string

The current release ID to filter by.

Example:

"rls_123"

Response

200 - application/json

Successfully listed the devices.

​
object
enum<string>
required
Available options:
list
Example:

"list"

​
total_count
integer<int64>
required

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.

​
limit
integer
default:10
required

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

Required range: 1 <= x <= 100
​
offset
integer
default:0
required

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

Required range: x >= 0
​
has_more
boolean
required

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

Example:

false

​
data
Base Device · object[]