List

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 maximum 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:

id:asc,

id:desc,

created_at:desc,

created_at:asc

expand[]

enum<string>[]

The fields to expand in the deployments list.

Hide child attributes

enum<string>

Available options:

total_count,

device,

release,

config_instances

string

The deployment ID to filter by.

Example:

"dpl_123"

target_status

enum<string>

The deployment target status to filter by.

Available options:

staged,

deployed,

archived

activity_status

enum<string>

The deployment activity status to filter by.

Available options:

validating,

needs_review,

staged,

queued,

deployed,

removing,

archived

error_status

enum<string>

The deployment error status to filter by.

Available options:

none,

failed,

retrying

device_id

string

The deployment device ID to filter by.

Example:

"dvc_123"

release_id

string

The deployment release ID to filter by.

Example:

"rls_123"

Response

200 - application/json

Successfully listed the deployments.

object

enum<string>

required

Available options:

list

Example:

"list"

total_count

integer

required

The total number of items in the list. By default the total count is not returned. The total count must be expanded (using expand[]=total_count) to get the total number of items in the list.

limit

integer

default:10

required

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

Required range: 1 <= x <= 100

offset

integer

default:0

required

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

Required range: x >= 0

has_more

boolean

required

True if there are more items in the list to return. False if there are no more items to return.

Example:

false

data

Deployment · object[]

required

Hide child attributes

object

enum<string>

required

Available options:

deployment

Example:

"deployment"

string

required

ID of the deployment.

Example:

"dpl_123"

description

string

required

The description of the deployment.

Example:

"Deployment for the motion control config instance"

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:

validating,

needs_review,

staged,

queued,

deployed,

removing,

archived,

failed,

retrying

activity_status

enum<string>

required

Last known activity state of the deployment.

Validating: the deployment's config instances are being validated with user's custom validation
Needs review: deployment needs to be reviewed before it can be deployed
Staged: is ready to be deployed
Queued: the deployment's config instances are waiting to be received by the device; will be deployed as soon as the device is online
Deployed: the deployment's config instances are currently available for consumption on the device
Removing: the deployment's config instances are being removed from the device
Archived: the deployment is available for historical reference but cannot be deployed and is not active on the device

Available options:

validating,

needs_review,

staged,

queued,

deployed,

removing,

archived

error_status

enum<string>

required

Last known error state of the deployment.

None: no errors
Retrying: an error has been encountered and the agent is retrying to reach the target status
Failed: a fatal error has been encountered; the deployment is archived and (if deployed) removed from the device

Available options:

none,

failed,

retrying

target_status

enum<string>

required

Desired state of the deployment.

Staged: is ready to be deployed
Deployed: all config instances part of the deployment are available for consumption on the device
Archived: the deployment is available for historical reference but cannot be deployed and is not active on the device

Available options:

staged,

deployed,

archived

device_id

string

required

ID of the device.

Example:

"dvc_123"

release_id

string

required

The version of the release.

Example:

"v1.0.0"

created_at

string<date-time>

required

Timestamp of when the device release was created.

Example:

"2024-01-01T00:00:00Z"

updated_at

string<date-time>

required

Timestamp of when the device release was last updated.

Example:

"2024-01-01T00:00:00Z"

device

object

required

Expand the device using 'expand[]=device' in the query string.

Hide child attributes

device.object

enum<string>

required

Available options:

device

Example:

"device"

device.id

string

required

ID of the device.

Example:

"dvc_123"

device.name

string

required

Name of the device.

Example:

"My Device"

device.status

enum<string>

required

The status of the device.

Inactive: The miru agent has not yet been installed / authenticated
Activating: The miru agent is currently being installed / authenticated (should only last for a few seconds)
Online: The miru agent has successfully pinged the server within the last 60 seconds.
Offline: The miru agent has not successfully pinged the server within the last 60 seconds (e.g. network issues, device is powered off, etc.)

Available options:

inactive,

activating,

online,

offline

device.last_connected_at

string<date-time> | null

required

Timestamp of when the device was last made an initial connection (this is not the same as the last time the device was seen).

Example:

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

device.last_disconnected_at

string<date-time> | null

required

Timestamp of when the device was last disconnected (this is not the same as the last time the device was seen).

Example:

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

device.created_at

string<date-time>

required

Timestamp of when the device was created.

Example:

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

device.updated_at

string<date-time>

required

Timestamp of when the device was last updated.

Example:

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

Example:

null

release

object

required

Expand the release using 'expand[]=release' in the query string.

Hide child attributes

release.object

enum<string>

required

Available options:

release

Example:

"release"

release.id

string

required

ID of the release.

Example:

"rls_123"

release.version

string

required

The version of the release.

Example:

"v1.0.0"

release.created_at

string<date-time>

required

Timestamp of when the release was created.

Example:

"2024-01-01T00:00:00Z"

release.updated_at

string<date-time>

required

Timestamp of when the release was last updated.

Example:

"2024-01-01T00:00:00Z"

release.config_schemas

Config Schema · object[] | null

required

Expand the config schemas using 'expand[]=config_schemas' in the query string.

Hide child attributes

object

enum<string>

required

Available options:

config_schema

Example:

"config_schema"

string

required

ID of the config schema.

Example:

"cfg_sch_123"

version

integer

required

Config schema version for the config type.

Example:

2

digest

string

required

Hash of the config schema contents.

Example:

"1234567890"

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

Timestamp of when the config schema was created.

Example:

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

updated_at

string<date-time>

required

Timestamp of when the config schema was last updated.

Example:

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

config_type_id

string

required

ID of the config type.

Example:

"cfg_typ_123"

content

object | null

required

The config schema's JSON Schema definition.

Example:

{
  "title": "Robot Features",
  "type": "object",
  "properties": {
    "enable_autonomy": { "type": "boolean", "default": true },
    "enable_remote_control": { "type": "boolean", "default": true },
    "max_payload_kg": {
      "type": "number",
      "minimum": 0,
      "maximum": 99,
      "default": 10
    },
    "preferred_speed_mode": {
      "type": "string",
      "enum": ["slow", "normal", "fast"],
      "default": "normal"
    },
    "emergency_stop_sensitivity": {
      "type": "number",
      "minimum": 0,
      "maximum": 1,
      "default": 0.8
    },
    "telemetry": {
      "type": "object",
      "properties": {
        "upload_interval_sec": {
          "type": "integer",
          "minimum": 10,
          "maximum": 600,
          "default": 60
        },
        "heartbeat_interval_sec": {
          "type": "integer",
          "minimum": 1,
          "maximum": 60,
          "default": 10
        }
      },
      "required": [
        "upload_interval_sec",
        "heartbeat_interval_sec"
      ]
    }
  },
  "required": [
    "enable_autonomy",
    "enable_remote_control",
    "max_payload_kg",
    "preferred_speed_mode",
    "emergency_stop_sensitivity",
    "telemetry"
  ]
}

config_type

object

required

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

Hide child attributes

config_type.object

enum<string>

required

Available options:

config_type

Example:

"config_type"

config_type.id

string

required

ID of the config type.

Example:

"cfg_123"

config_type.name

string

required

Name of the config type.

Example:

"My Config Type"

config_type.slug

string

required

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

Example:

"my-config-type"

config_type.created_at

string<date-time>

required

Timestamp of when the config type was created.

Example:

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

config_type.updated_at

string<date-time>

required

Timestamp of when the config type was last updated.

Example:

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

Example:

null

Example:

[]

Example:

null

config_instances

Config Instance · object[] | null

required

Expand the config instances using 'expand[]=config_instances' in the query string.

Hide child attributes

object

enum<string>

required

Available options:

config_instance

Example:

"config_instance"

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

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

object

required

Hide child attributes

device.object

enum<string>

required

Available options:

device

Example:

"device"

device.id

string

required

ID of the device.

Example:

"dvc_123"

device.name

string

required

Name of the device.

Example:

"My Device"

device.status

enum<string>

required

The status of the device.

Inactive: The miru agent has not yet been installed / authenticated
Activating: The miru agent is currently being installed / authenticated (should only last for a few seconds)
Online: The miru agent has successfully pinged the server within the last 60 seconds.
Offline: The miru agent has not successfully pinged the server within the last 60 seconds (e.g. network issues, device is powered off, etc.)

Available options:

inactive,

activating,

online,

offline

device.last_connected_at

string<date-time> | null

required

Timestamp of when the device was last made an initial connection (this is not the same as the last time the device was seen).

Example:

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

device.last_disconnected_at

string<date-time> | null

required

Timestamp of when the device was last disconnected (this is not the same as the last time the device was seen).

Example:

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

device.created_at

string<date-time>

required

Timestamp of when the device was created.

Example:

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

device.updated_at

string<date-time>

required

Timestamp of when the device was last updated.

Example:

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

Example:

null

config_schema

object

required

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

Hide child attributes

config_schema.object

enum<string>

required

Available options:

config_schema

Example:

"config_schema"

config_schema.id

string

required

ID of the config schema.

Example:

"cfg_sch_123"

config_schema.version

integer

required

Config schema version for the config type.

Example:

2

config_schema.digest

string

required

Hash of the config schema contents.

Example:

"1234567890"

config_schema.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"

config_schema.created_at

string<date-time>

required

Timestamp of when the config schema was created.

Example:

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

config_schema.updated_at

string<date-time>

required

Timestamp of when the config schema was last updated.

Example:

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

config_schema.config_type_id

string

required

ID of the config type.

Example:

"cfg_typ_123"

config_schema.content

object | null

required

The config schema's JSON Schema definition.

Example:

{
  "title": "Robot Features",
  "type": "object",
  "properties": {
    "enable_autonomy": { "type": "boolean", "default": true },
    "enable_remote_control": { "type": "boolean", "default": true },
    "max_payload_kg": {
      "type": "number",
      "minimum": 0,
      "maximum": 99,
      "default": 10
    },
    "preferred_speed_mode": {
      "type": "string",
      "enum": ["slow", "normal", "fast"],
      "default": "normal"
    },
    "emergency_stop_sensitivity": {
      "type": "number",
      "minimum": 0,
      "maximum": 1,
      "default": 0.8
    },
    "telemetry": {
      "type": "object",
      "properties": {
        "upload_interval_sec": {
          "type": "integer",
          "minimum": 10,
          "maximum": 600,
          "default": 60
        },
        "heartbeat_interval_sec": {
          "type": "integer",
          "minimum": 1,
          "maximum": 60,
          "default": 10
        }
      },
      "required": [
        "upload_interval_sec",
        "heartbeat_interval_sec"
      ]
    }
  },
  "required": [
    "enable_autonomy",
    "enable_remote_control",
    "max_payload_kg",
    "preferred_speed_mode",
    "emergency_stop_sensitivity",
    "telemetry"
  ]
}

config_schema.config_type

object

required

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

Hide child attributes

config_schema.config_type.object

enum<string>

required

Available options:

config_type

Example:

"config_type"

config_schema.config_type.id

string

required

ID of the config type.

Example:

"cfg_123"

config_schema.config_type.name

string

required

Name of the config type.

Example:

"My Config Type"

config_schema.config_type.slug

string

required

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

Example:

"my-config-type"

config_schema.config_type.created_at

string<date-time>

required

Timestamp of when the config type was created.

Example:

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

config_schema.config_type.updated_at

string<date-time>

required

Timestamp of when the config type was last updated.

Example:

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

Example:

null

Example:

null

content

object | null

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

object

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

Hide child attributes

config_type.object

enum<string>

required

Available options:

config_type

Example:

"config_type"

config_type.id

string

required

ID of the config type.

Example:

"cfg_123"

config_type.name

string

required

Name of the config type.

Example:

"My Config Type"

config_type.slug

string

required

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

Example:

"my-config-type"

config_type.created_at

string<date-time>

required

Timestamp of when the config type was created.

Example:

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

config_type.updated_at

string<date-time>

required

Timestamp of when the config type was last updated.

Example:

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

Example:

null

Server-Side API

SDKs

Endpoints

Webhooks

Authorizations

Query Parameters

Response