Create

POST

config_instances

Create

curl --request POST \
  --url https://api.mirurobotics.com/beta/config_instances \
  --header 'Content-Type: application/json' \
  --header 'Miru-Version: <miru-version>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "config_schema_id": "cfg_sch_123",
  "content": {
    "format": "json",
    "data": "{\n  \"enable_autonomy\": true,\n  \"enable_remote_control\": true,\n  \"max_payload_kg\": 10.0\n}\n"
  },
  "slot_key": "controller_2"
}
'

import requests

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

payload = {
    "config_schema_id": "cfg_sch_123",
    "content": {
        "format": "json",
        "data": "{
  \"enable_autonomy\": true,
  \"enable_remote_control\": true,
  \"max_payload_kg\": 10.0
}
"
    },
    "slot_key": "controller_2"
}
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_schema_id: 'cfg_sch_123',
    content: {
      format: 'json',
      data: '{\n  "enable_autonomy": true,\n  "enable_remote_control": true,\n  "max_payload_kg": 10.0\n}\n'
    },
    slot_key: 'controller_2'
  })
};

fetch('https://api.mirurobotics.com/beta/config_instances', 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",
  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_schema_id' => 'cfg_sch_123',
    'content' => [
        'format' => 'json',
        'data' => '{
  "enable_autonomy": true,
  "enable_remote_control": true,
  "max_payload_kg": 10.0
}
'
    ],
    'slot_key' => 'controller_2'
  ]),
  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_instances"

	payload := strings.NewReader("{\n  \"config_schema_id\": \"cfg_sch_123\",\n  \"content\": {\n    \"format\": \"json\",\n    \"data\": \"{\\n  \\\"enable_autonomy\\\": true,\\n  \\\"enable_remote_control\\\": true,\\n  \\\"max_payload_kg\\\": 10.0\\n}\\n\"\n  },\n  \"slot_key\": \"controller_2\"\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_instances")
  .header("Miru-Version", "<miru-version>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"config_schema_id\": \"cfg_sch_123\",\n  \"content\": {\n    \"format\": \"json\",\n    \"data\": \"{\\n  \\\"enable_autonomy\\\": true,\\n  \\\"enable_remote_control\\\": true,\\n  \\\"max_payload_kg\\\": 10.0\\n}\\n\"\n  },\n  \"slot_key\": \"controller_2\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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_schema_id\": \"cfg_sch_123\",\n  \"content\": {\n    \"format\": \"json\",\n    \"data\": \"{\\n  \\\"enable_autonomy\\\": true,\\n  \\\"enable_remote_control\\\": true,\\n  \\\"max_payload_kg\\\": 10.0\\n}\\n\"\n  },\n  \"slot_key\": \"controller_2\"\n}"

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",
  "slot_key": "default",
  "created_at": "2021-01-01T00:00:00Z",
  "config_schema_id": "cfg_sch_123",
  "config_type_id": "cfg_typ_123",
  "created_by_id": "usr_123"
}

Scope	Required
`config_instances:write`	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-11-04.everglades"

Query Parameters

expand

enum<string>[]

Fields to expand on the config instance resource.

Available options:

content,

config_schema,

config_type,

created_by

Example:

["content"]

Body

application/json

config_schema_id

string

required

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

Example:

"cfg_sch_123"

content

Instance Content · object

required

Show child attributes

Example:

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

slot_key

string

The slot of the config schema this instance is bound to. Optional when the schema has exactly one slot. Must match the key of one of the slots declared by the config schema.

Example:

"controller_2"

Response

200 - application/json

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

slot_key

string

required

The key of the config schema slot this instance is bound to. Must match the key of one of the slots declared by this instance's config schema.

Example:

"controller_2"

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"

created_by_id

string

required

ID of the principal who created the config instance.

Example:

"usr_123"

created_by

Principal · object

The principal who created the config instance. Expand using expand=created_by in the query string.

Show child attributes

Example:

{
  "object": "principal",
  "id": "api_key_123",
  "name": "My CI/CD Key",
  "type": "api_key"
}

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",
  "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",
  "created_by_id": "usr_123"
}

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",
  "created_by_id": "usr_123",
  "archived_at": null,
  "archived_by_id": null
}

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

⌘I

Create

curl --request POST \
  --url https://api.mirurobotics.com/beta/config_instances \
  --header 'Content-Type: application/json' \
  --header 'Miru-Version: <miru-version>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "config_schema_id": "cfg_sch_123",
  "content": {
    "format": "json",
    "data": "{\n  \"enable_autonomy\": true,\n  \"enable_remote_control\": true,\n  \"max_payload_kg\": 10.0\n}\n"
  },
  "slot_key": "controller_2"
}
'

import requests

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

payload = {
    "config_schema_id": "cfg_sch_123",
    "content": {
        "format": "json",
        "data": "{
  \"enable_autonomy\": true,
  \"enable_remote_control\": true,
  \"max_payload_kg\": 10.0
}
"
    },
    "slot_key": "controller_2"
}
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_schema_id: 'cfg_sch_123',
    content: {
      format: 'json',
      data: '{\n  "enable_autonomy": true,\n  "enable_remote_control": true,\n  "max_payload_kg": 10.0\n}\n'
    },
    slot_key: 'controller_2'
  })
};

fetch('https://api.mirurobotics.com/beta/config_instances', 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",
  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_schema_id' => 'cfg_sch_123',
    'content' => [
        'format' => 'json',
        'data' => '{
  "enable_autonomy": true,
  "enable_remote_control": true,
  "max_payload_kg": 10.0
}
'
    ],
    'slot_key' => 'controller_2'
  ]),
  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_instances"

	payload := strings.NewReader("{\n  \"config_schema_id\": \"cfg_sch_123\",\n  \"content\": {\n    \"format\": \"json\",\n    \"data\": \"{\\n  \\\"enable_autonomy\\\": true,\\n  \\\"enable_remote_control\\\": true,\\n  \\\"max_payload_kg\\\": 10.0\\n}\\n\"\n  },\n  \"slot_key\": \"controller_2\"\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_instances")
  .header("Miru-Version", "<miru-version>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"config_schema_id\": \"cfg_sch_123\",\n  \"content\": {\n    \"format\": \"json\",\n    \"data\": \"{\\n  \\\"enable_autonomy\\\": true,\\n  \\\"enable_remote_control\\\": true,\\n  \\\"max_payload_kg\\\": 10.0\\n}\\n\"\n  },\n  \"slot_key\": \"controller_2\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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_schema_id\": \"cfg_sch_123\",\n  \"content\": {\n    \"format\": \"json\",\n    \"data\": \"{\\n  \\\"enable_autonomy\\\": true,\\n  \\\"enable_remote_control\\\": true,\\n  \\\"max_payload_kg\\\": 10.0\\n}\\n\"\n  },\n  \"slot_key\": \"controller_2\"\n}"

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",
  "slot_key": "default",
  "created_at": "2021-01-01T00:00:00Z",
  "config_schema_id": "cfg_sch_123",
  "config_type_id": "cfg_typ_123",
  "created_by_id": "usr_123"
}

Fleet

Config Management

Administration

Authorizations

Headers

Query Parameters

Body

Response