> ## Documentation Index > Fetch the complete documentation index at: https://docs.mirurobotics.com/llms.txt > Use this file to discover all available pages before exploring further. # Get > Retrieve a deployment by its ID. ## OpenAPI ````yaml /references/device-api/v0.2.1/api.yaml get /deployments/{deployment_id} openapi: 3.0.3 info: title: Miru Agent API description: >- The API between the Miru Agent and any external client living on the same device as the Miru Agent version: v0.2 license: name: MIT url: https://opensource.org/licenses/MIT x-release-version: v0.2.1 x-git-commit: sha: 10dc72e22958a4851e7f6718f5b7542b0c7f62e1 url: >- https://github.com/mirurobotics/openapi/commit/10dc72e22958a4851e7f6718f5b7542b0c7f62e1 message: |- feat(lint): add x-summary to event schemas and enforce via MIRU024 (#15) ## Summary - Add `x-summary` extension field and richer `description` to all `*Event` data schemas (`DeploymentDeployedEvent`, `DeploymentRemovedEvent`, `ValidateDeploymentEvent`) - Add MIRU024 lint rule (`event_schema_x_summary_required`) that enforces `x-summary` on all `*Event` schemas (excluding the `Event` envelope) - Add 3 test fixtures and test class for MIRU024 (197 tests pass, 99% coverage) The `x-summary` field is consumed by the docs codegen (`docs/api/generate_event_pages.py`) as the page subtitle, while `description` provides the longer inline body text. This makes generated event type reference pages more useful. ## Test plan - [x] `./tools/lint/test.sh` — 197 tests pass - [x] `./tools/lint/covgate.sh` — 99% coverage (gate: 98%) - [x] `./scripts/lint.sh` — all custom MIRU rules and Redocly clean - [x] MIRU024 fires on `*Event` schema missing `x-summary` - [x] MIRU024 passes when `x-summary` is present - [x] MIRU024 exempts the `Event` envelope schema 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 4.6 (1M context) author: ben-miru branch: HEAD dirty: false x-build: built_at: '2026-04-06T19:21:53.148075+00:00' servers: - url: http://localhost/v0.2 description: localhost security: [] paths: /deployments/{deployment_id}: get: tags: - Deployments summary: Get description: Retrieve a deployment by its ID. operationId: getDeployment parameters: - $ref: '#/components/parameters/deployment_id' responses: '200': description: Successfully retrieved the deployment. content: application/json: schema: $ref: '#/components/schemas/Deployment' x-codeSamples: - lang: curl source: |- curl \ --unix-socket /run/miru/miru.sock \ --request GET \ --url http://localhost/v0.2/deployments/{deployment_id} - lang: Python source: |- from miru_device_sdk import Miru client = Miru() deployment = client.deployments.retrieve( "dpl_123", ) print(deployment.id) components: parameters: deployment_id: name: deployment_id in: path required: true description: The unique identifier of the deployment. schema: type: string example: dpl_123 schemas: Deployment: title: Deployment type: object required: - object - id - description - status - activity_status - error_status - target_status - device_id - release_id - created_at properties: object: type: string enum: - deployment example: deployment x-stainless-const: true description: The object type, which is always `deployment`. id: type: string description: ID of the deployment. example: dpl_123 description: type: string example: Deployment for the motion control config instance description: The description of the deployment. status: $ref: '#/components/schemas/DeploymentStatus' activity_status: $ref: '#/components/schemas/DeploymentActivityStatus' error_status: $ref: '#/components/schemas/DeploymentErrorStatus' target_status: $ref: '#/components/schemas/DeploymentTargetStatus' device_id: type: string example: dvc_123 description: ID of the device. release_id: type: string example: rls_123 description: ID of the release. created_at: type: string format: date-time example: '2024-01-01T00:00:00Z' description: Timestamp of when the device release was created. example: 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' DeploymentStatus: type: string description: > 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'. enum: - drifted - staged - queued - deployed - removing - archived - failed - retrying x-enum-varnames: - DEPLOYMENT_STATUS_DRIFTED - DEPLOYMENT_STATUS_STAGED - DEPLOYMENT_STATUS_QUEUED - DEPLOYMENT_STATUS_DEPLOYED - DEPLOYMENT_STATUS_REMOVING - DEPLOYMENT_STATUS_ARCHIVED - DEPLOYMENT_STATUS_FAILED - DEPLOYMENT_STATUS_RETRYING DeploymentActivityStatus: type: string description: > 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. enum: - drifted - staged - queued - deployed - removing - archived x-enum-varnames: - DEPLOYMENT_ACTIVITY_STATUS_DRIFTED - DEPLOYMENT_ACTIVITY_STATUS_STAGED - DEPLOYMENT_ACTIVITY_STATUS_QUEUED - DEPLOYMENT_ACTIVITY_STATUS_DEPLOYED - DEPLOYMENT_ACTIVITY_STATUS_REMOVING - DEPLOYMENT_ACTIVITY_STATUS_ARCHIVED DeploymentErrorStatus: type: string description: > 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. enum: - none - failed - retrying x-enum-varnames: - DEPLOYMENT_ERROR_STATUS_NONE - DEPLOYMENT_ERROR_STATUS_FAILED - DEPLOYMENT_ERROR_STATUS_RETRYING DeploymentTargetStatus: type: string description: > 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. enum: - staged - deployed - archived x-enum-varnames: - DEPLOYMENT_TARGET_STATUS_STAGED - DEPLOYMENT_TARGET_STATUS_DEPLOYED - DEPLOYMENT_TARGET_STATUS_ARCHIVED ````