Device Inventory REST Operations for Oracle Radio
List, inspect, rename, and delete registered Radio application installations.
An enabled Radio user needs radio.device.manage for each operation on this page. These REST operations have their own permission requirement; the Radio Devices UI requires both device-management and enrollment-management permissions.
The paths below start at the managed instance origin. When using the returned serviceEndpoint, append only the portion after /api/. See the REST overview for endpoint, authentication, and request guidance.
List Devices
Operation: listRadioDevices.
GET /api/v1/management/devicesGet a bounded page of registered installations.
| Parameter | Location | Requirement |
|---|---|---|
limit | Query | Optional integer from 1 through 100; default 50. |
offset | Query | Optional nonnegative integer; default 0. |
Success: 200 with devices, count, limit, offset, and hasMore.
Continue by adding the returned count to offset while hasMore is true. An empty page isn't evidence of an authentication failure.
Get a Device
Operation: getRadioDevice.
GET /api/v1/management/devices/{deviceId}Inspect one installation using the ID returned by registration or device inventory.
| Parameter | Location | Requirement |
|---|---|---|
deviceId | Path | Required radioDeviceId from a device response; 1–32 characters. Encode it as one URL path segment. |
Success: 200 with a device object. Fields include radioDeviceId, displayName, enrolledAt, and online. Additional fields include advertisingId, appVersion, osVersion, enrolledByRadioUserId, firstSeenAt, lastSeenAt, onlineUntil, lastUsedByRadioUserId, and lastUsedByDisplayName; activity and optional metadata can be absent or null.
Treat online as best-effort activity information. It doesn't prove that the user is currently listening or ready to transmit. A legacy installation can have no advertising ID.
Rename a Device
Operation: renameRadioDevice.
PATCH /api/v1/management/devices/{deviceId}Change the installation's display name.
| Parameter | Location | Requirement |
|---|---|---|
deviceId | Path | Required radioDeviceId from a device response; 1–32 characters. Encode it as one URL path segment. |
displayName | JSON body | Required nonblank name, up to 256 characters. |
Replace the bracketed values with your values before sending this JSON request. Supply Content-Type: application/json.
{
"displayName": "<new-installation-name>"
}Success: 200 with the updated device object.
Retain the returned radioDeviceId; renaming doesn't create a new installation. If the result is uncertain, retrieve the device before repeating the update.
Delete a Device
Operation: deleteRadioDevice.
DELETE /api/v1/management/devices/{deviceId}Permanently remove one device inventory record.
| Parameter | Location | Requirement |
|---|---|---|
deviceId | Path | Required radioDeviceId from a device response; 1–32 characters. Encode it as one URL path segment. |
Success: 204 with no response body.
Verify the device ID before deletion. Historical communications aren't deleted by removing the inventory record. If the application must enroll again, follow re-enrollment.
Next Steps
Use registration grants to register or reissue an installation. Use heartbeats to report installation activity. For the UI workflow, see Devices.
For failed requests, see errors, troubleshooting, and the FAQ. A 404 NotAuthorizedOrNotFound response doesn't distinguish missing resources from authorization failures.