Config Instances

Get

Retrieve a config instance by ID.

get/config_instances/{config_instance_id}

Request

Base URL
https://api.mirurobotics.com/beta
URL
https://api.mirurobotics.com/beta/config_instances/{config_instance_id}
Auth
API key in header X-API-Key

Path parameters

config_instance_idstring required

Example:cfg_inst_123

The unique identifier of the config instance.

Query parameters

expandConfigInstanceExpansion[]

Fields to expand on the config instance resource.

[
  "content"
]

Response

Successfully retrieved the config instance.

object'config_instance' required

The object type, which is always config_instance.

idstring required

ID of the config instance.

config_type_namestring required

The name of the config type.

filepathstring required

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

slot_keystring 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.

created_atstring date-time required

The timestamp of when the config instance was created.

config_schema_idstring required

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

config_type_idstring required

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

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.

Get