Create - Miru

POST

/

config_types

Create

curl --request POST \
  --url https://api.mirurobotics.com/beta/config_types \
  --header 'Content-Type: application/json' \
  --header 'Miru-Version: <miru-version>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "My Config Type",
  "slug": "my-config-type"
}
'

import requests

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

payload = {
    "name": "My Config Type",
    "slug": "my-config-type"
}
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({name: 'My Config Type', slug: 'my-config-type'})
};

fetch('https://api.mirurobotics.com/beta/config_types', 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_types",
  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([
    'name' => 'My Config Type',
    'slug' => 'my-config-type'
  ]),
  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_types"

	payload := strings.NewReader("{\n  \"name\": \"My Config Type\",\n  \"slug\": \"my-config-type\"\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_types")
  .header("Miru-Version", "<miru-version>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My Config Type\",\n  \"slug\": \"my-config-type\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"name\": \"My Config Type\",\n  \"slug\": \"my-config-type\"\n}"

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

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

Scope	Required
`config_types: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 type resource.

Available options:

created_by,

archived_by

Example:

["created_by"]

Body

application/json

name

string

required

The name of the config type.

Example:

"My Config Type"

slug

string

required

An immutable, code-friendly name for the config type.

Example:

"my-config-type"

Response

200 - application/json

Successfully created the config type.

object

enum<string>

required

The object type, which is always config_type.

Available options:

config_type

Example:

"config_type"

id

string

required

ID of the config type.

Example:

"cfg_123"

name

string

required

Name of the config type.

Example:

"My Config Type"

slug

string

required

An immutable, code-friendly name for the config type.

Example:

"my-config-type"

created_at

string<date-time>

required

Timestamp of when the config type was created.

Example:

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

updated_at

string<date-time>

required

Timestamp of when the config type was last updated.

Example:

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

created_by_id

string

required

ID of the principal who created the config type.

Example:

"usr_123"

archived_at

string<date-time> | null

required

Timestamp of when the config type was archived. Null if the config type is not archived.

Example:

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

archived_by_id

string | null

required

ID of the principal who archived the config type. Null if the config type is not archived or was archived before this field was recorded.

Example:

"usr_123"

created_by

Principal · object

The principal who created the config type. 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"
}

archived_by

Principal · object | null

The principal who archived the config type. Null if archived_by_id is null. Expand using expand=archived_by in the query string.

Show child attributes

Example:

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

⌘I

Create

curl --request POST \
  --url https://api.mirurobotics.com/beta/config_types \
  --header 'Content-Type: application/json' \
  --header 'Miru-Version: <miru-version>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "My Config Type",
  "slug": "my-config-type"
}
'

import requests

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

payload = {
    "name": "My Config Type",
    "slug": "my-config-type"
}
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({name: 'My Config Type', slug: 'my-config-type'})
};

fetch('https://api.mirurobotics.com/beta/config_types', 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_types",
  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([
    'name' => 'My Config Type',
    'slug' => 'my-config-type'
  ]),
  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_types"

	payload := strings.NewReader("{\n  \"name\": \"My Config Type\",\n  \"slug\": \"my-config-type\"\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_types")
  .header("Miru-Version", "<miru-version>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My Config Type\",\n  \"slug\": \"my-config-type\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"name\": \"My Config Type\",\n  \"slug\": \"my-config-type\"\n}"

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

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