List and Get Devices

List Devices

List every device registered in the workspace. Device-scoped API keys cannot call this endpoint and receive 403.

Required scope: device:read

List Devices

get

List every device registered in the workspace. Device-scoped API keys cannot call this endpoint and receive 403.

Authorizations
AuthorizationstringRequired

Roboflow API key passed as a Bearer token.

Path parameters
workspacestringRequired

Workspace ID (URL slug).

Responses
200

Devices in the workspace.

application/json
get
/{workspace}/devices/v2

Example Request

Example Response

The status field is online if a heartbeat was received within the last 5 minutes, offline if older, or unknown if no heartbeat has ever been recorded. Newly-provisioned devices appear in the list before their first heartbeat; until then status is unknown and most monitoring-derived fields are null.

Get Device

Retrieve a single device by id. Returns 404 if the device does not exist or belongs to a different workspace.

Required scope: device:read

Get a Device

get

Retrieve a single device by ID.

Authorizations
AuthorizationstringRequired

Roboflow API key passed as a Bearer token.

Path parameters
workspacestringRequired

Workspace ID (URL slug).

deviceIdstringRequired

Device ID.

Responses
200

The device.

application/json
idstringOptional
namestring · nullableOptional
statusstring · enumOptional

online if a heartbeat was received within the last 5 minutes, offline if older, unknown if no heartbeat has ever been recorded.

Possible values:
last_heartbeatstring · date-time · nullableOptional
platformstring · nullableOptional
platform_releasestring · nullableOptional
platform_versionstring · nullableOptional
architecturestring · nullableOptional
hostnamestring · nullableOptional
rfdm_versionstring · nullableOptional

Version of the Roboflow Device Manager running on the device.

typestring · nullableOptional

Device type reported by the device (for example "jetson").

tagsstring[]Optional
created_atstring · date-time · nullableOptional
get
/{workspace}/devices/v2/{deviceId}

Example Request

The response body matches a single item from the list endpoint (not wrapped in a data array).

Last updated

Was this helpful?