Updated
API Overview
Integrate with the DataRadius REST API to manage routers, subscribers, plans, and payments programmatically.
Getting started
All API requests go to your workspace API host, which you can find in the dashboard at Settings → API. The API serves JSON responses and uses ISO 8601 timestamps in UTC.
Authentication
Create an API key in the dashboard at Settings → API Keys. Each key is scoped to your workspace and inherits the permissions of the role you assign it. Include the key as a Bearer token in the Authorization header of every request.
API keys do not expire automatically, but you can revoke them at any time from the dashboard. Treat them like passwords — never commit them to version control or expose them in client-side code.
Interactive API reference
The full interactive API reference is available inside your dashboard. It is auto-generated from the server's validation schemas and is always current with the deployed API version. You can try requests directly from the browser.
The reference documents every endpoint with request methods, parameters, body schemas, response schemas, error codes, and rate limits.
Response format
Every API response follows a consistent envelope with a success boolean and either a data object or an error object. HTTP status codes follow REST conventions.
Key resources
The API exposes the same resources you manage in the dashboard:
| Resource | Operations | Description |
|---|---|---|
| Routers | List, get, create, update, delete | Manage MikroTik routers and their connection status. |
| Hotspot Plans | List, get, create, update, delete | Hotspot billing plans with duration, speed, and price. |
| PPPoE Plans | List, get, create, update, delete | PPPoE subscriber plans with speed and billing cycle. |
| Subscribers | List, get, create, update, delete | PPPoE and hotspot subscribers with plan assignments. |
| Payments | List, get | Payment records with receipt details. |
| Team | List, invite, update role, remove | Workspace team members and roles. |
Pagination
List endpoints return paginated results using cursor-based pagination. The response includes a nextCursor field — pass it as the cursor parameter to fetch the next page. When nextCursor is null, you have reached the end.
Cursor pagination is stable under concurrent writes — you will never skip or duplicate records when items are added or removed between pages.
Rate limiting
Every response includes rate-limit headers showing your current limit, remaining requests, and reset time. When you exceed the limit, the API returns a 429 status with a Retry-After header.
Webhooks
DataRadius can send HTTP POST requests to your server when events occur. Configure webhook endpoints at Settings → Webhooks in the dashboard.
Every webhook payload is signed with an HMAC-SHA256 signature in the X-Signature-256 header, using a per-endpoint secret you receive when creating the webhook. Always verify the signature before processing the payload.
Events include:
subscriber.created,subscriber.updated,subscriber.deletedpayment.completed,payment.failedrouter.online,router.offlineplan.created,plan.updated,plan.deleted
Failed deliveries are retried with exponential backoff over 24 hours. Delivery logs are visible in the dashboard.
Bulk operations
The API supports batch operations for managing subscribers at scale. Send an array of objects and receive per-item results — successes and failures are reported individually, so a single invalid record does not block the rest.
SDKs and examples
The OpenAPI spec is available for download from the interactive reference inside the dashboard. Use it to generate client SDKs in any language.