v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
device_Device

Get details of a Device

Retrieves the full detail record for a single device by its ID.

Returns the same platform-specific device object (Apple, Android, Linux, or Windows) used in the device list, but scoped to one device, including hardware identifiers, OS version, connectivity, and current blueprint assignment.

About Get Device Detail

This is the single-device counterpart to GET /device/v0/devices/, useful once you already have a device id and need its full current record rather than a filtered list. The response shape depends on the device's platform, so integrations should handle each of the possible device object types.

Common Use Cases

Looking up a device's full configuration and status before issuing a command or Converge action

Verifying a device's current blueprint and OS version during troubleshooting

Best Practices

Confirm the device id is correct before relying on a 404 to mean the device doesn't exist, since it could also indicate the ID belongs to a different tenant

Use GET /device/v0/devices/{id}/devicestate for a lighter-weight check when you only need current state rather than the full device record

Workflow

Obtain the device id from the device list or from a prior command or operation response

Call this endpoint to retrieve the full device record

Use the device's platform and current_blueprint_version_id to decide on next steps

get/device/v0/devices/{id}/

Path parameters

idstring uuid required

ID of the device

Response

Details of the device

codeinteger
messagestring