Skip to main content
GET
/
config_instances
/
{config_instance_id}
Python
from miru_platform_sdk import Miru

client = Miru(
    api_key="My API Key",
)
config_instance = client.config_instances.retrieve(
    config_instance_id="cfg_inst_123",
)
print(config_instance.id)
{
  "object": "config_instance",
  "id": "cfg_inst_123",
  "target_status": "created",
  "activity_status": "created",
  "error_status": "none",
  "status": "created",
  "relative_filepath": "/v1/motion-control.json",
  "created_at": "2021-01-01T00:00:00Z",
  "updated_at": "2021-01-01T00:00:00Z",
  "device_id": "dvc_123",
  "config_schema_id": "cfg_sch_123",
  "config_type_id": "cfg_type_123",
  "device": null,
  "config_schema": null,
  "content": {
    "enable_autonomy": true,
    "enable_remote_control": false,
    "max_payload_kg": 8.5,
    "preferred_speed_mode": "normal",
    "emergency_stop_sensitivity": 0.9,
    "telemetry": {
      "upload_interval_sec": 45,
      "heartbeat_interval_sec": 15
    }
  },
  "config_type": null
}
This API version has reached end of life. See supported versions.
ScopeRequired
config_instances:readYes

Authorizations

​
X-API-Key
string
header
required

The API key to use for authentication. Retrieve your API key from the Miru dashboard.

Path Parameters

​
config_instance_id
string
required

The unique identifier of the config instance.

Example:

"cfg_inst_123"

Query Parameters

​
expand[]
enum<string>[]

The fields to expand in the config instance.

Available options:
content,
config_schema,
device,
config_type

Response

200 - application/json

Successfully retrieved the config instance.

​
object
enum<string>
required
Available options:
config_instance
Example:

"config_instance"

​
id
string
required

ID of the config instance.

Example:

"cfg_inst_123"

​
target_status
enum<string>
required

Desired state of the config instance.

  • Created: config instance is created and can be deployed in the future
  • Deployed: config instance is available for consumption on the device
  • Removed: config instance is available for historical reference but cannot be deployed and is not active on the device
Available options:
created,
deployed,
removed
​
activity_status
enum<string>
required

Last known activity state of the config instance.

  • Created: config instance has been created and can be deployed in the future
  • Queued: config instance is waiting to be received by the device; will be deployed as soon as the device is online
  • Deployed: config instance is currently available for consumption on the device
  • Removed: the config instance is available for historical reference but cannot be deployed and is not active on the device
Available options:
created,
queued,
deployed,
removed
​
error_status
enum<string>
required

Last known error state of the config instance deployment.

  • None: there are no errors with the config instance deployment
  • Retrying: an error has been encountered and the agent is attempting to try again to reach the target status
  • Failed: a fatal error has been encountered; the config instance is archived and (if deployed) removed from the device
Available options:
none,
failed,
retrying
​
status
enum<string>
required

This status merges the 'activity_status' and 'error_status' fields, with error states taking precedence over activity states when errors are present. For example, if the activity status is 'deployed' but the error status is 'failed', the status is 'failed'. However, if the error status is 'none' and the activity status is 'deployed', the status is 'deployed'.

Available options:
created,
queued,
deployed,
removed,
failed,
retrying
​
relative_filepath
string
required

The file path to deploy the config instance relative to /srv/miru/config_instances. v1/motion-control.json would deploy to /srv/miru/config_instances/v1/motion-control.json.

Example:

"/v1/motion-control.json"

​
created_at
string<date-time>
required

The timestamp of when the config instance was created.

Example:

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

​
updated_at
string<date-time>
required

The timestamp of when the config instance was last updated.

Example:

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

​
device_id
string
required

ID of the device which the config instance is deployed to.

Example:

"dvc_123"

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

​
device
Base Device · object
required
Example:

null

​
config_schema
Config Schema · object
required

Expand the config schema using 'expand[]=config_schema' in the query string.

Example:

null

​
content
object
required

The configuration values associated with the config instance. Expand the content using 'expand[]=content' in the query string.

Example:
{
  "enable_autonomy": true,
  "enable_remote_control": false,
  "max_payload_kg": 8.5,
  "preferred_speed_mode": "normal",
  "emergency_stop_sensitivity": 0.9,
  "telemetry": {
    "upload_interval_sec": 45,
    "heartbeat_interval_sec": 15
  }
}
​
config_type
Config Type · object

Expand the config type using 'expand[]=config_type' in the query string.

Example:

null

Last modified on March 13, 2026