GET
/
config_instances
List
curl --request GET \
  --url https://{host}/{version}/config_instances \
  --header 'X-API-Key: <api-key>'
{
  "object": "list",
  "total_count": 123,
  "limit": 50,
  "offset": 1,
  "has_more": false,
  "data": [
    {
      "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,
      "config_type": 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
        }
      }
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

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

Query Parameters

​
offset
integer
default:0

The offset of the items to return. An offset of 10 with a limit of 10 returns items 11-20.

Required range: x >= 0
​
limit
integer
default:10

The number of items to return. A limit of 15 with an offset of 0 returns items 1-15.

Required range: 1 <= x <= 100
​
order_by
enum<string>
default:created_at:desc
Available options:
created_at:desc,
created_at:asc
​
expand[]
enum<string>[]

The fields to expand in the config instance list

​
id
string

The config instance ID to filter by

Example:

"cfg_inst_123"

​
target_status
enum<string>

The config instance target status to filter by

Available options:
created,
validated,
deployed,
removed
​
activity_status
enum<string>

The config instance activity status to filter by

Available options:
created,
validating,
validated,
queued,
deployed,
removed
​
error_status
enum<string>

The config instance error status to filter by

Available options:
none,
failed,
retrying
​
device_id
string

The device ID to filter by

Example:

"dvc_123"

​
config_schema_id
string

The config schema ID to filter by

Example:

"cfg_sch_123"

​
config_type_id
string

The config type ID to filter by

Example:

"cfg_typ_123"

Response

200 - application/json

Successfully listed the config instances.

The response is of type object.