Create

POST

config_schemas

Create

curl --request POST \
  --url https://api.mirurobotics.com/beta/config_schemas \
  --header 'Content-Type: application/json' \
  --header 'Miru-Version: <miru-version>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "config_type_ref": {
    "id": "cfg_123",
    "slug": "my-config-type"
  },
  "language": "jsonschema",
  "documents": [
    {
      "name": "motion-control.json",
      "data": "<string>"
    }
  ],
  "instance_slots": [
    {
      "key": "controller_2",
      "name": "Controller 2",
      "filepath": "/var/local/forge/configuration/robot_drivers/controller_2/topic_list.yaml",
      "required": true,
      "description": "Topic list for the second motor controller."
    }
  ]
}
'

import requests

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

payload = {
    "config_type_ref": {
        "id": "cfg_123",
        "slug": "my-config-type"
    },
    "language": "jsonschema",
    "documents": [
        {
            "name": "motion-control.json",
            "data": "<string>"
        }
    ],
    "instance_slots": [
        {
            "key": "controller_2",
            "name": "Controller 2",
            "filepath": "/var/local/forge/configuration/robot_drivers/controller_2/topic_list.yaml",
            "required": True,
            "description": "Topic list for the second motor controller."
        }
    ]
}
headers = {
    "Miru-Version": "<miru-version>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Miru-Version': '<miru-version>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    config_type_ref: {id: 'cfg_123', slug: 'my-config-type'},
    language: 'jsonschema',
    documents: [{name: 'motion-control.json', data: '<string>'}],
    instance_slots: [
      {
        key: 'controller_2',
        name: 'Controller 2',
        filepath: '/var/local/forge/configuration/robot_drivers/controller_2/topic_list.yaml',
        required: true,
        description: 'Topic list for the second motor controller.'
      }
    ]
  })
};

fetch('https://api.mirurobotics.com/beta/config_schemas', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'config_type_ref' => [
        'id' => 'cfg_123',
        'slug' => 'my-config-type'
    ],
    'language' => 'jsonschema',
    'documents' => [
        [
                'name' => 'motion-control.json',
                'data' => '<string>'
        ]
    ],
    'instance_slots' => [
        [
                'key' => 'controller_2',
                'name' => 'Controller 2',
                'filepath' => '/var/local/forge/configuration/robot_drivers/controller_2/topic_list.yaml',
                'required' => true,
                'description' => 'Topic list for the second motor controller.'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"config_type_ref\": {\n    \"id\": \"cfg_123\",\n    \"slug\": \"my-config-type\"\n  },\n  \"language\": \"jsonschema\",\n  \"documents\": [\n    {\n      \"name\": \"motion-control.json\",\n      \"data\": \"<string>\"\n    }\n  ],\n  \"instance_slots\": [\n    {\n      \"key\": \"controller_2\",\n      \"name\": \"Controller 2\",\n      \"filepath\": \"/var/local/forge/configuration/robot_drivers/controller_2/topic_list.yaml\",\n      \"required\": true,\n      \"description\": \"Topic list for the second motor controller.\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mirurobotics.com/beta/config_schemas")
  .header("Miru-Version", "<miru-version>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"config_type_ref\": {\n    \"id\": \"cfg_123\",\n    \"slug\": \"my-config-type\"\n  },\n  \"language\": \"jsonschema\",\n  \"documents\": [\n    {\n      \"name\": \"motion-control.json\",\n      \"data\": \"<string>\"\n    }\n  ],\n  \"instance_slots\": [\n    {\n      \"key\": \"controller_2\",\n      \"name\": \"Controller 2\",\n      \"filepath\": \"/var/local/forge/configuration/robot_drivers/controller_2/topic_list.yaml\",\n      \"required\": true,\n      \"description\": \"Topic list for the second motor controller.\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mirurobotics.com/beta/config_schemas")

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

request = Net::HTTP::Post.new(url)
request["Miru-Version"] = '<miru-version>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"config_type_ref\": {\n    \"id\": \"cfg_123\",\n    \"slug\": \"my-config-type\"\n  },\n  \"language\": \"jsonschema\",\n  \"documents\": [\n    {\n      \"name\": \"motion-control.json\",\n      \"data\": \"<string>\"\n    }\n  ],\n  \"instance_slots\": [\n    {\n      \"key\": \"controller_2\",\n      \"name\": \"Controller 2\",\n      \"filepath\": \"/var/local/forge/configuration/robot_drivers/controller_2/topic_list.yaml\",\n      \"required\": true,\n      \"description\": \"Topic list for the second motor controller.\"\n    }\n  ]\n}"

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

{
  "object": "config_schema",
  "id": "cfg_sch_123",
  "digest": "sha256:1234567890",
  "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:write`	Yes

Consider using the Miru CLI in a CI/CD pipeline to create config schemas instead of calling this endpoint directly.

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-08-17.everglades"

Query Parameters

expand

enum<string>[]

Fields to expand on the config schema resource.

Available options:

documents,

config_type

Example:

["documents"]

Body

application/json

config_type_ref

Config Type Reference · object

required

A reference to a config type. At least one of id or slug must be provided. When both are provided, id takes precedence and slug is ignored.

Show child attributes

language

enum<string>

required

Available options:

jsonschema,

cue,

opaque

Example:

"jsonschema"

format

enum<string>

required

Available options:

json,

yaml,

cue

documents

Schema Document · object[]

required

The schema document files.

Show child attributes

instance_slots

Instance Slot · object[]

The file system destinations this config schema writes to. Slot keys and filepaths must each be unique within the schema, and slot filepaths must be unique across every config schema in a release. Optional: when omitted, the server creates a single required slot with key default, name Default, and a filepath of /srv/miru/configs/<config_type_slug>.<json|yaml> derived from the config type slug and the schema format. When provided, the array must contain at least one slot.

Minimum array length: 1

Show child attributes

instance_format

enum<string>

The on-disk format used when a config instance is written to the device filesystem.

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

Available options:

json,

yaml,

jsonc,

xml,

text

git_commit

Git Commit Request · object

The git commit to link to this config schema.

Show child attributes

Response

200 - application/json

Successfully created 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"

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 on-disk format used when a config instance is written to the device filesystem.

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

Available options:

json,

yaml,

jsonc,

xml,

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

Last modified on August 17, 2026

⌘I

Create

curl --request POST \
  --url https://api.mirurobotics.com/beta/config_schemas \
  --header 'Content-Type: application/json' \
  --header 'Miru-Version: <miru-version>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "config_type_ref": {
    "id": "cfg_123",
    "slug": "my-config-type"
  },
  "language": "jsonschema",
  "documents": [
    {
      "name": "motion-control.json",
      "data": "<string>"
    }
  ],
  "instance_slots": [
    {
      "key": "controller_2",
      "name": "Controller 2",
      "filepath": "/var/local/forge/configuration/robot_drivers/controller_2/topic_list.yaml",
      "required": true,
      "description": "Topic list for the second motor controller."
    }
  ]
}
'

import requests

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

payload = {
    "config_type_ref": {
        "id": "cfg_123",
        "slug": "my-config-type"
    },
    "language": "jsonschema",
    "documents": [
        {
            "name": "motion-control.json",
            "data": "<string>"
        }
    ],
    "instance_slots": [
        {
            "key": "controller_2",
            "name": "Controller 2",
            "filepath": "/var/local/forge/configuration/robot_drivers/controller_2/topic_list.yaml",
            "required": True,
            "description": "Topic list for the second motor controller."
        }
    ]
}
headers = {
    "Miru-Version": "<miru-version>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Miru-Version': '<miru-version>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    config_type_ref: {id: 'cfg_123', slug: 'my-config-type'},
    language: 'jsonschema',
    documents: [{name: 'motion-control.json', data: '<string>'}],
    instance_slots: [
      {
        key: 'controller_2',
        name: 'Controller 2',
        filepath: '/var/local/forge/configuration/robot_drivers/controller_2/topic_list.yaml',
        required: true,
        description: 'Topic list for the second motor controller.'
      }
    ]
  })
};

fetch('https://api.mirurobotics.com/beta/config_schemas', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'config_type_ref' => [
        'id' => 'cfg_123',
        'slug' => 'my-config-type'
    ],
    'language' => 'jsonschema',
    'documents' => [
        [
                'name' => 'motion-control.json',
                'data' => '<string>'
        ]
    ],
    'instance_slots' => [
        [
                'key' => 'controller_2',
                'name' => 'Controller 2',
                'filepath' => '/var/local/forge/configuration/robot_drivers/controller_2/topic_list.yaml',
                'required' => true,
                'description' => 'Topic list for the second motor controller.'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"config_type_ref\": {\n    \"id\": \"cfg_123\",\n    \"slug\": \"my-config-type\"\n  },\n  \"language\": \"jsonschema\",\n  \"documents\": [\n    {\n      \"name\": \"motion-control.json\",\n      \"data\": \"<string>\"\n    }\n  ],\n  \"instance_slots\": [\n    {\n      \"key\": \"controller_2\",\n      \"name\": \"Controller 2\",\n      \"filepath\": \"/var/local/forge/configuration/robot_drivers/controller_2/topic_list.yaml\",\n      \"required\": true,\n      \"description\": \"Topic list for the second motor controller.\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mirurobotics.com/beta/config_schemas")
  .header("Miru-Version", "<miru-version>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"config_type_ref\": {\n    \"id\": \"cfg_123\",\n    \"slug\": \"my-config-type\"\n  },\n  \"language\": \"jsonschema\",\n  \"documents\": [\n    {\n      \"name\": \"motion-control.json\",\n      \"data\": \"<string>\"\n    }\n  ],\n  \"instance_slots\": [\n    {\n      \"key\": \"controller_2\",\n      \"name\": \"Controller 2\",\n      \"filepath\": \"/var/local/forge/configuration/robot_drivers/controller_2/topic_list.yaml\",\n      \"required\": true,\n      \"description\": \"Topic list for the second motor controller.\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mirurobotics.com/beta/config_schemas")

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

request = Net::HTTP::Post.new(url)
request["Miru-Version"] = '<miru-version>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"config_type_ref\": {\n    \"id\": \"cfg_123\",\n    \"slug\": \"my-config-type\"\n  },\n  \"language\": \"jsonschema\",\n  \"documents\": [\n    {\n      \"name\": \"motion-control.json\",\n      \"data\": \"<string>\"\n    }\n  ],\n  \"instance_slots\": [\n    {\n      \"key\": \"controller_2\",\n      \"name\": \"Controller 2\",\n      \"filepath\": \"/var/local/forge/configuration/robot_drivers/controller_2/topic_list.yaml\",\n      \"required\": true,\n      \"description\": \"Topic list for the second motor controller.\"\n    }\n  ]\n}"

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

{
  "object": "config_schema",
  "id": "cfg_sch_123",
  "digest": "sha256:1234567890",
  "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"
}

Config Instances

Config Schemas

Config Types

Deployments

Devices

Provisioning Tokens

Git Commits

Groups

Principals

Releases

Authorizations

Headers

Query Parameters

Body

Response