Skip to main content
GET
/
deployments
List
curl --request GET \
  --url https://{host}/{version}/deployments \
  --header 'X-API-Key: <api-key>'
{
  "object": "list",
  "total_count": 123,
  "limit": 10,
  "offset": 0,
  "has_more": false,
  "data": [
    {
      "object": "deployment",
      "id": "dpl_123",
      "description": "Deployment for the motion control config instance",
      "status": "validating",
      "activity_status": "validating",
      "error_status": "none",
      "target_status": "pending",
      "device_id": "dvc_123",
      "release_id": "v1.0.0",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z",
      "device": null,
      "release": null,
      "config_instances": [
        {
          "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 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.

​
id
string

The deployment ID to filter by.

Example:

"dpl_123"

​
target_status
enum<string>

The deployment target status to filter by.

Available options:
pending,
approved,
deployed,
archived
​
activity_status
enum<string>

The deployment activity status to filter by.

Available options:
validating,
pending,
approved,
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
⌘I