Skip to main content
GET
/
deployments
/
{deployment_id}
cURL
curl --unix-socket /run/miru/miru.sock \
  --request GET \
  --url http://localhost/v0.2/deployments/{deployment_id}
{
  "object": "deployment",
  "id": "dpl_123",
  "description": "Deployment for the motion control config instance",
  "status": "staged",
  "activity_status": "staged",
  "error_status": "none",
  "target_status": "staged",
  "device_id": "dvc_123",
  "release_id": "rls_123",
  "created_at": "2024-01-01T00:00:00Z"
}

Path Parameters

​
deployment_id
string
required

The unique identifier of the deployment.

Example:

"dpl_123"

Response

200 - application/json

Successfully retrieved the deployment.

​
object
enum<string>
required

The object type, which is always deployment.

Available options:
deployment
Example:

"deployment"

​
id
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:
drifted,
staged,
queued,
deployed,
archived,
failed,
retrying
​
activity_status
enum<string>
required

Last known activity state of the deployment.

drifted means the device's configurations have drifted since this deployment was staged, and the deployment needs to be reviewed before it can be deployed.

staged means the deployment is ready to be deployed.

queued means the deployment's config instances are waiting to be received by the device and will be deployed as soon as the device is online.

deployed means the deployment's config instances are currently available for consumption on the device.

archived means 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
​
error_status
enum<string>
required

Last known error state of the deployment.

none means there are no errors.

retrying means an error has been encountered and the agent is retrying to reach the target status.

failed means 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 means the deployment is ready to be deployed.

deployed means all config instances in the deployment are available for consumption on the device.

archived means 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

ID of the release.

Example:

"rls_123"

​
created_at
string<date-time>
required

Timestamp of when the device release was created.

Example:

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

Last modified on March 13, 2026