Oracle Radio REST API
Use the Radio REST API for request and response operations against an active Public Safety and Security instance.
Protected request examples use the supported mobile bearer-token flow or the supplied browser application's managed session. They do not establish command-line, custom-browser, or server authentication support. See supported authentication.
Use REST for individual requests to read information or change saved Radio state. For live channel events and audio, use the corresponding WebSocket operations. See the Overview's API comparison to choose the method for your task.
The REST service uses the serviceEndpoint returned for the active Public Safety and Security instance. The endpoint includes the trailing /api/ prefix. Use the linked resource references for request methods, paths, parameters, responses, and recovery guidance.
Send a REST Request
For the unauthenticated health and ping diagnostics, use the documented GET request without a sign-in or Radio permission. The authentication and authorization steps below apply to protected operations.
- Get the active instance's
serviceEndpoint. The operation references show complete paths from the instance origin. Append only the portion after/api/to the returned endpoint; for example, appendv1/radio/mefor the current profile. - Use the supported authentication path for the client. Bearer-token clients send
Authorization: Bearerwith a current access token; browser clients use their managed session and applicable CSRF protection. - Verify the operation's Radio permissions and any applicable channel access. Identity Domain authentication doesn't grant Radio authorization.
- Substitute the returned identifiers and URL-encode each path parameter as one segment. For JSON request bodies, send
Content-Type: application/json. UseAccept: application/jsonwhen requesting JSON. - Check the HTTP status and response before continuing. A
204response has no body to parse. After an uncertain write result, inspect current state before repeating the operation.
The quick start includes cURL and PowerShell examples using the returned endpoint.
For an ordered example with a specific result, follow the subscription workflow to discover a channel, save it, and verify the saved state.
Core Operator Resources
- Account settings: read and update your own audio and push-to-talk preferences.
- Profile: identify the authenticated Radio user.
- Location updates: report your position and inspect automatic subscription outcomes.
- Channels: discover visible channels and inspect details, talk status, and connected users.
- Saved subscriptions: list, add, and remove durable channel selections.
Administration Resources
Use geofence operations to read, configure, or remove channel boundaries.
Use user operations to read directory details, enable or disable Radio access, and replace Radio group memberships.
Use registration grants to select eligible users and issue, inspect, revoke, or reissue registrations. Use device inventory to list, inspect, rename, or delete registered installations.
Device Registration and Management Operations
The following eleven operations cover device enrollment and management. Select an operation for its request and response details. The table shows complete paths from the managed instance origin.
| Operation | Method and path | Authorization |
|---|---|---|
| createDeviceRegistration | POST /api/v1/management/device-registrations | radio.enrollment.manage |
| listDeviceRegistrations | GET /api/v1/management/device-registrations | radio.enrollment.manage |
| revokeDeviceRegistration | DELETE /api/v1/management/device-registrations/{grantId} | radio.enrollment.manage |
| listDeviceRegistrationUsers | GET /api/v1/management/device-registration-users | radio.enrollment.manage |
| listRadioDevices | GET /api/v1/management/devices | radio.device.manage |
| getRadioDevice | GET /api/v1/management/devices/{deviceId} | radio.device.manage |
| renameRadioDevice | PATCH /api/v1/management/devices/{deviceId} | radio.device.manage |
| deleteRadioDevice | DELETE /api/v1/management/devices/{deviceId} | radio.device.manage |
| reissueDeviceRegistration | POST /api/v1/management/devices/{deviceId}/registration | radio.enrollment.manage |
| completeDeviceRegistration | POST /api/v1/radio/device-registrations/completions | Authenticated, enabled intended Radio user |
| heartbeatRadioDevice | POST /api/v1/radio/me/devices/{deviceId}/heartbeat | Authenticated, enabled Radio user |
Use the mobile registration reference for completion and heartbeat requests. For revokeDeviceRegistration, use the registrationId returned by Radio as the grantId path value.
The mobile operations require an Identity Domain bearer access token. A registration code or Radio device ID doesn't replace the access token. See Authenticating with Oracle Radio APIs.
Next Steps
Use public diagnostics to check connectivity before troubleshooting an authenticated operation.
Follow the enrollment scenario or establish a WebSocket session for live operations. For failed requests, see errors, troubleshooting, and the FAQ.