Get

GET

config_schemas

{config_schema_id}

Get

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

import requests

url = "https://api.mirurobotics.com/beta/config_schemas/{config_schema_id}"

headers = {
    "Miru-Version": "<miru-version>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.mirurobotics.com/beta/config_schemas/{config_schema_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_schemas/{config_schema_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_schemas/{config_schema_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_schemas/{config_schema_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_schemas/{config_schema_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_schema",
  "id": "cfg_sch_123",
  "digest": "sha256:1234567890",
  "os": "linux",
  "config_type_name": "Motion Control",
  "instance_slots": [
    {
      "key": "default",
      "name": "Default",
      "filepath": "/srv/miru/configs/v1/motion-control.json",
      "required": true
    }
  ],
  "instance_format": "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"
}

Scope	Required
`config_schemas: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-10-28.everglades"

Path Parameters

config_schema_id

string

required

The unique identifier of the config schema.

Example:

"cfg_sch_123"

Query Parameters

expand

enum<string>[]

Fields to expand on the config schema resource.

Available options:

documents,

config_type

Example:

["documents"]

Response

200 - application/json

Successfully retrieved the config schema.

object

enum<string>

required

The object type, which is always config_schema.

Available options:

config_schema

Example:

"config_schema"

string

required

ID of the config schema.

Example:

"cfg_sch_123"

digest

string

required

The digest of the config schema.

Example:

"sha256:1234567890"

enum<string>

required

The operating system family this config schema targets, derived from its instance slot filepaths, which must all agree. A schema created without instance_slots gets a default slot at a Unix path, so it is linux. Read-only: clients cannot set it.

Available options:

linux,

windows

Example:

"linux"

config_type_name

string

required

The name of the config type.

Example:

"Motion Control"

instance_slots

Instance Slot · object[]

required

The file system destinations this config schema writes to. Every config schema has at least one slot. Slots share the schema's validation and differ only in where the file is written; a file needing different validation is a different config type, not a slot. Slot keys and filepaths must each be unique within the schema, and slot filepaths must be unique across every config schema in a release.

Minimum array length: 1

Show child attributes

Example:

[
  {
    "key": "default",
    "name": "Default",
    "filepath": "/srv/miru/configs/v1/motion-control.json",
    "required": true
  }
]

instance_format

enum<string>

required

The serialization format of config content. A config instance is written to the device filesystem in this format.

json: standard JSON.
yaml: YAML 1.2.
jsonc: JSON with comments (JSON plus // and /* */ comment syntax).
xml: XML.
csv: comma-separated values (RFC 4180).
text: plain, unstructured text with no specific format.

Available options:

json,

yaml,

jsonc,

xml,

csv,

text

created_at

string<date-time>

required

Timestamp of when the config schema was created.

Example:

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

updated_at

string<date-time>

required

Timestamp of when the config schema was last updated.

Example:

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

config_type_id

string

required

ID of the config type.

Example:

"cfg_typ_123"

language

enum<string>

required

Available options:

jsonschema,

cue,

opaque

Example:

"jsonschema"

format

enum<string>

required

Available options:

json,

yaml,

cue

documents

Schema Document · object[]

Expand the config schema documents using expand=documents in the query string.

Show child attributes

Example:

[
  {
    "id": "doc_123",
    "name": "main.json",
    "data": "{\n  \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n  \"type\": \"object\"\n}\n"
  }
]

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

⌘I

Get

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

import requests

url = "https://api.mirurobotics.com/beta/config_schemas/{config_schema_id}"

headers = {
    "Miru-Version": "<miru-version>",
    "X-API-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.mirurobotics.com/beta/config_schemas/{config_schema_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_schemas/{config_schema_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_schemas/{config_schema_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_schemas/{config_schema_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_schemas/{config_schema_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_schema",
  "id": "cfg_sch_123",
  "digest": "sha256:1234567890",
  "os": "linux",
  "config_type_name": "Motion Control",
  "instance_slots": [
    {
      "key": "default",
      "name": "Default",
      "filepath": "/srv/miru/configs/v1/motion-control.json",
      "required": true
    }
  ],
  "instance_format": "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"
}

Calibrations

Components

Component Aspects

Component Roles

Config Instances

Config Schemas

Config Types

Deployments

Devices

Provisioning Tokens

Git Commits

Groups

Principals

Releases

Authorizations

Headers

Path Parameters

Query Parameters

Response