Skip to main content
A config instance, also known as a config or an instance, is a set of parameters used to modify the behavior of code. Config instances are stored as text files (e.g. JSON, YAML, etc.) which applications parse into a structured format for consumption.

​
Properties

​
object
The configuration values that are deployed to the device as a file, written in the config schema’s instance format.
​
string
The absolute file system path where the config instance is written on the device.Examples: /srv/miru/configs/v1/motion-control.json, /srv/miru/configs/safety.yaml
​
string
The key of the instance slot on the config schema that this instance fills.Examples: default, left-arm, right-arm
​
Config Schema
The config schema that the config instance must adhere to.Example: SCH-FmoDN

​
File formats

The formats a config instance may use are determined by the schema language of its config schema. Config schemas support the following file formats: Note that a schema’s format does not need to match the format of the config instance it validates. For example, a YAML-formatted JSON Schema can validate a JSON-formatted config instance.
YAML support requires Miru Agent v0.7.0 or newer

​
View a config instance

Config instances are viewed from the places they appear—a device’s config editor, a release’s staging area, or a device’s deployment history. To download a config instance’s content as a file, use the

​
Create a config instance

Config instances are created for you whenever configs are deployed from the dashboard, such as when staging a deployment or deploying from a device’s config editor.
Last modified on August 18, 2026