Get

GET

config_instances

{config_instance_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
)
config_instance = client.config_instances.retrieve(
    config_instance_id="cfg_inst_123",
)
print(config_instance.id)

curl --request GET \
  --url https://api.mirurobotics.com/beta/config_instances/{config_instance_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/config_instances/{config_instance_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/config_instances/{config_instance_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/config_instances/{config_instance_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/config_instances/{config_instance_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/config_instances/{config_instance_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": "config_instance",
  "id": "cfg_inst_123",
  "config_type_name": "Motion Control",
  "filepath": "/srv/miru/configs/v1/motion-control.json",
  "created_at": "2021-01-01T00:00:00Z",
  "config_schema_id": "cfg_sch_123",
  "config_type_id": "cfg_typ_123"
}

Scope	Required
`config_instances: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

config_instance_id

string

required

The unique identifier of the config instance.

Example:

"cfg_inst_123"

Query Parameters

expand

enum<string>[]

Fields to expand on the config instance resource.

Available options:

content,

config_schema,

config_type

Example:

["content"]

Response

200 - application/json

Successfully retrieved the config instance.

object

enum<string>

required

The object type, which is always config_instance.

Available options:

config_instance

Example:

"config_instance"

string

required

ID of the config instance.

Example:

"cfg_inst_123"

config_type_name

string

required

The name of the config type.

Example:

"Motion Control"

filepath

string

required

The absolute file system path where this config instance is written.

Example:

"/srv/miru/configs/v1/motion-control.json"

created_at

string<date-time>

required

The timestamp of when the config instance was created.

Example:

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

config_schema_id

string

required

ID of the config schema which the config instance must adhere to.

Example:

"cfg_sch_123"

config_type_id

string

required

ID of the config type which the config instance (and its schema) is a part of.

Example:

"cfg_type_123"

config_schema

Config Schema · object

Expand the config schema using 'expand=config_schema' in the query string.

Show child attributes

Example:

{
  "object": "config_schema",
  "id": "cfg_sch_123",
  "digest": "sha256:1234567890",
  "config_type_name": "Motion Control",
  "instance_filepath": "/srv/miru/configs/v1/motion-control.json",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z",
  "config_type_id": "cfg_typ_123",
  "language": "jsonschema",
  "format": "json"
}

config_type

Config Type · object

Expand the config type using 'expand=config_type' in the query string.

Show child attributes

Example:

{
  "object": "config_type",
  "id": "cfg_typ_123",
  "name": "Motion Control",
  "slug": "motion-control",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z"
}

content

Instance Content · object

The configuration values associated with the config instance. Expand the content using 'expand=content' in the query string.

Show child attributes

Example:

{
  "format": "json",
  "data": "{\n  \"enable_autonomy\": true,\n  \"enable_remote_control\": true,\n  \"max_payload_kg\": 10.0\n}\n"
}

Last modified on May 27, 2026

ListList config instances.

⌘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
)
config_instance = client.config_instances.retrieve(
    config_instance_id="cfg_inst_123",
)
print(config_instance.id)

curl --request GET \
  --url https://api.mirurobotics.com/beta/config_instances/{config_instance_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/config_instances/{config_instance_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/config_instances/{config_instance_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/config_instances/{config_instance_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/config_instances/{config_instance_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/config_instances/{config_instance_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": "config_instance",
  "id": "cfg_inst_123",
  "config_type_name": "Motion Control",
  "filepath": "/srv/miru/configs/v1/motion-control.json",
  "created_at": "2021-01-01T00:00:00Z",
  "config_schema_id": "cfg_sch_123",
  "config_type_id": "cfg_typ_123"
}

Config Instances

Config Schemas

Config Types

Deployments

Devices

Provisioning Tokens

Git Commits

Principals

Releases

Authorizations

Headers

Path Parameters

Query Parameters

Response