---
title: "Read Device Software"
method: GET
path: "/api/v1/devices/{device_id}/software"
tags: ["device deployments"]
---

# Read Device Software

`GET /api/v1/devices/{device_id}/software`

## Request

- Base URL: `https://api.brumby.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.brumby.com/api/v1/devices/{device_id}/software`
- Auth: HTTP bearer

## Path parameters

- `device_id` string, required

## Response `200`

Successful Response

- DeviceSoftwareResponse
  - `device_id` string, required
  - `desired_release_id` string, uuid, nullable, required
  - `desired_release` DockReleaseResponse, required
    - `release_id` string, uuid, required
    - `version` string, required
    - `git_commit` string, required
    - `schema_release_id` string, uuid, required
    - `schema_release` SchemaReleaseResponse, required
      - `schema_release_id` string, uuid, required
      - `version` string, required
      - `git_commit` string, required
      - `wheel_s3_key` string, required
      - `wheel_sha256` string, required
      - `created_at` string, date-time, required
      - `created_by` string, required
      - `status` 'draft' | 'released' | 'deprecated' | 'revoked', required: Operator-controlled lifecycle for immutable catalogue entries.
    - `product` 'brumby-dock', nullable, required
    - `release_purpose` 'application' | 'updater_migration', nullable, required
    - `release_format_version` string, nullable, required
    - `job_schema_version` '1' | '2', nullable, required
    - `target_hardware_family` 'n100' | 'jetson', nullable, required
    - `target_architecture` 'x86_64' | 'aarch64', nullable, required
    - `manifest_sha256` string, nullable, required
    - `signing_key_id` string, nullable, required
    - `artifact_s3_key` string, required
    - `artifact_sha256` string, required
    - `artifact_size_bytes` integer, required
    - `created_at` string, date-time, required
    - `created_by` string, required
    - `release_status` 'draft' | 'released' | 'deprecated' | 'revoked', required: Operator-controlled lifecycle for immutable catalogue entries.
    - `release_notes` string, nullable, required
    - `installable` boolean, required
  - `reported_version` string, nullable, required
  - `reported_schema_version` string, nullable, required
  - `reported_release_sha256` string, nullable, required
  - `reported_at` string, date-time, nullable, required
  - `updater` DeviceUpdaterResponse, required
    - `name` 'dock-updater', required
    - `version` string, required
    - `supported_job_schema_versions` string[], required
    - `supported_release_format_versions` string[], required
    - `trusted_signing_key_ids` string[], required
    - `architecture` 'x86_64' | 'aarch64', required
    - `ready` boolean, required
    - `reported_at` string, date-time, required
    - `received_at` string, date-time, required
  - `converged` boolean, nullable, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/brumby/apis/brumby-platform-api.md) - [All operations](https://skmtc.dev/brumby/apis/brumby-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/brumby/apis/brumby-platform-api/revisions/fe185e20813e?raw)