List - Miru

Scope	Required
`deployments:read`	Yes

Authorizations

X-API-Key

string

header

required

The API key to use for authentication.

Headers

Miru-Version

string

required

The API version the client was built against.

Example:

"2026-03-09.tetons"

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

Example:

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

Example:

10

order_by

enum<string>[]

Sort order for the deployment results.

Available options:

id:asc,

id:desc,

created_at:desc,

created_at:asc

Example:

["created_at:desc"]

expand

enum<string>[]

Fields to expand on each deployment in the list.

Available options:

total_count,

device,

release,

config_instances

Example:

["device"]

string[]

The deployment IDs to filter by.

Example:

["dpl_123"]

target_status

enum<string>[]

The deployment target statuses to filter by.

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

Example:

["staged"]

activity_status

enum<string>[]

The deployment activity statuses to filter by.

Last known activity state of the deployment.

Drifted: device's configurations have drifted since this deployment was staged, and the 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
Archived: the deployment is available for historical reference but cannot be deployed and is not active on the device

Available options:

drifted,

staged,

queued,

deployed,

archived

Example:

["drifted"]

error_status

enum<string>[]

The deployment error statuses to filter by.

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

Example:

["none"]

device_id

string[]

The deployment device IDs to filter by.

Example:

["dvc_123"]

release_id

string[]

The deployment release IDs to filter by.

Example:

["rls_123"]

Response

200 - application/json

Successfully listed the deployments.

object

enum<string>

required

The object type, which is always list.

Available options:

list

Example:

"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

The list of deployments.

Show child attributes

total_count

integer<int64>

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.