---
title: "Get"
method: GET
path: "/deployments/{deployment_id}"
tags: ["Deployments"]
---

# Get

`GET /deployments/{deployment_id}`

Retrieve a deployment by its ID.

## Path parameters

- `deployment_id` string, required

## Response `200`

Successfully retrieved the deployment.

- Deployment
  - `object` 'deployment', required — The object type, which is always `deployment`.
  - `id` string, required — ID of the deployment.
  - `description` string, required — The description of the deployment.
  - `status` 'drifted' | 'staged' | 'queued' | 'deployed' | 'removing' | 'archived' | 'failed' | 'retrying', 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'.
  - `activity_status` 'drifted' | 'staged' | 'queued' | 'deployed' | 'removing' | 'archived', 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. `removing` means the deployment's config instances are being removed from the device. `archived` means the deployment is available for historical reference but cannot be deployed and is not active on the device.
  - `error_status` 'none' | 'failed' | 'retrying', 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.
  - `target_status` 'staged' | 'deployed' | 'archived', 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.
  - `device_id` string, required — ID of the device.
  - `release_id` string, required — ID of the release.
  - `created_at` string, date-time, required — Timestamp of when the device release was created.

## Changes

- **2026-04-06** `3baf7b9ffbac` — 2 warning
  - added the new `removing` enum value to the `activity_status` response property for the response status `200`
  - added the new `removing` enum value to the `status` response property for the response status `200`
- **2026-03-10** `6c5a928176c5` — 1 breaking, 11 info
  - the response's body type/format changed from ``/`` to `object`/`` for status `200`
  - removed `#/components/schemas/BaseDeployment` from the response body `allOf` list for the response status `200`
  - added the required property `activity_status` to the response with the `200` status
  - added the required property `created_at` to the response with the `200` status
  - …8 more
- **2026-03-05** `d827cc046cad` — 1 info
  - removed `subschema #2` from the response body `allOf` list for the response status `200`

[Change history](https://skmtc.dev/mirurobotics/apis/miru-agent-api/changes/deployments/:deployment_id/get.md)

---

[API](https://skmtc.dev/mirurobotics/apis/miru-agent-api.md) · [All operations](https://skmtc.dev/mirurobotics/apis/miru-agent-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mirurobotics/miru-agent-api/revisions/3baf7b9ffbac/schema)
