API Reference
The EmberNet REST API provides programmatic access to the platform's data and configuration.
info
This API reference is a placeholder. Full API documentation with interactive endpoints will be published in a future update.
Base URL
https://dashboard.embernet.ai/api/v1
For on-premises deployments:
https://<your-embernet-host>/api/v1
Authentication
API Key
Authorization: ApiKey <your-api-key>
Bearer Token
Authorization: Bearer <your-token>
Endpoints
Devices
| Method | Endpoint | Description |
|---|---|---|
GET | /devices | List all devices |
GET | /devices/:id | Get device details |
POST | /devices | Register a new device |
PUT | /devices/:id | Update device configuration |
DELETE | /devices/:id | Remove a device |
GET | /devices/:id/metrics | Get device metrics |
Metrics
| Method | Endpoint | Description |
|---|---|---|
GET | /metrics | Query metrics |
POST | /metrics | Submit custom metrics |
GET | /metrics/tags | List available metric tags |
Alerts
| Method | Endpoint | Description |
|---|---|---|
GET | /alerts | List alerts |
POST | /alerts | Create alert rule |
PUT | /alerts/:id | Update alert rule |
POST | /alerts/:id/acknowledge | Acknowledge an alert |
Tenants
| Method | Endpoint | Description |
|---|---|---|
GET | /tenants | List tenants |
POST | /tenants | Create a tenant |
PUT | /tenants/:id | Update tenant |
Users
| Method | Endpoint | Description |
|---|---|---|
GET | /users | List users |
POST | /users | Create a user |
PUT | /users/:id | Update user |
DELETE | /users/:id | Delete user |
Response Format
{
"status": "success",
"data": { ... },
"meta": { "page": 1, "per_page": 50, "total": 142 }
}
Rate Limiting
- Standard: 100 requests/minute
- Metrics queries: 30 requests/minute
- Bulk operations: 10 requests/minute