Get

GET

devices

{device_id}

Python

import os
from miru_platform_sdk import Miru

client = Miru(
    api_key=os.environ.get("MIRU_API_KEY"),  # This is the default and can be omitted
)
device = client.devices.retrieve(
    device_id="dvc_123",
)
print(device.id)

curl --request GET \
  --url https://api.mirurobotics.com/beta/devices/{device_id} \
  --header 'Miru-Version: <miru-version>' \
  --header 'X-API-Key: <api-key>'

const options = {
  method: 'GET',
  headers: {'Miru-Version': '<miru-version>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.mirurobotics.com/beta/devices/{device_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mirurobotics.com/beta/devices/{device_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Miru-Version: <miru-version>",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mirurobotics.com/beta/devices/{device_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Miru-Version", "<miru-version>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.mirurobotics.com/beta/devices/{device_id}")
  .header("Miru-Version", "<miru-version>")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mirurobotics.com/beta/devices/{device_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Miru-Version"] = '<miru-version>'
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
}

Scope	Required
`devices:read`	Yes

Authorizations

X-API-Key

string

header

required

The API key to use for authentication.

Headers

Miru-Version

string

required

The API version the client was built against.

Example:

"2026-05-06.rainier"

Path Parameters

device_id

string

required

The unique identifier of the device.

Example:

"dvc_123"

Query Parameters

expand

enum<string>[]

Fields to expand on the device resource.

Available options:

current_deployment,

current_release

Example:

["current_release"]

Response

200 - application/json

Successfully retrieved the device.

object

enum<string>

required

The object type, which is always device.

Available options:

device

Example:

"device"

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.

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.)

Available options:

inactive,

activating,

online,

offline

agent_version

string | null

required

The version of the agent the device is running.

Example:

"v1.0.0"

last_connected_at

string<date-time> | null

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).

Example:

"2021-01-01T00:00:00Z"

last_disconnected_at

string<date-time> | null

required

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

Example:

"2021-01-01T00:00:00Z"

created_at

string<date-time>

required

Timestamp of when the device was created.

Example:

"2021-01-01T00:00:00Z"

updated_at

string<date-time>

required

Timestamp of when the device was last updated.

Example:

"2021-01-01T00:00:00Z"

current_deployment

Deployment · object | null

The current deployment for the device.

Show child attributes

Example:

{
  "object": "deployment",
  "id": "dpl_123",
  "description": "Deployment for the motion control config instance",
  "status": "staged",
  "activity_status": "staged",
  "error_status": "none",
  "target_status": "staged",
  "device_id": "dvc_123",
  "release_id": "rls_123",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}

current_release

Release · object | null

The current release for the device.

Show child attributes

Example:

{
  "object": "release",
  "id": "rls_123",
  "version": "v1.0.0",
  "git_commit_id": "git_commit_123",
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-01T00:00:00Z"
}

Last modified on May 27, 2026

UpdateUpdate a device by ID.

⌘I

Python

import os
from miru_platform_sdk import Miru

client = Miru(
    api_key=os.environ.get("MIRU_API_KEY"),  # This is the default and can be omitted
)
device = client.devices.retrieve(
    device_id="dvc_123",
)
print(device.id)

curl --request GET \
  --url https://api.mirurobotics.com/beta/devices/{device_id} \
  --header 'Miru-Version: <miru-version>' \
  --header 'X-API-Key: <api-key>'

const options = {
  method: 'GET',
  headers: {'Miru-Version': '<miru-version>', 'X-API-Key': '<api-key>'}
};

fetch('https://api.mirurobotics.com/beta/devices/{device_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mirurobotics.com/beta/devices/{device_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Miru-Version: <miru-version>",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mirurobotics.com/beta/devices/{device_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Miru-Version", "<miru-version>")
	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.mirurobotics.com/beta/devices/{device_id}")
  .header("Miru-Version", "<miru-version>")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mirurobotics.com/beta/devices/{device_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Miru-Version"] = '<miru-version>'
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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"
}

Config Instances

Config Schemas

Config Types

Deployments

Devices

Provisioning Tokens

Git Commits

Principals

Releases

Authorizations

Headers

Path Parameters

Query Parameters

Response