Information
- OpenAPI version:
3.1.0
Overview
OTA-Pulse API 1.0.0
Section titled “ OTA-Pulse API 1.0.0 ”REST API for OTA-Pulse: device monitoring, metrics collection,
coredump management, and OTA update distribution.
## Features
- User authentication with JWT tokens
- Multi-tenant organization support
- Device registration and management
- Real-time metrics collection
- Coredump upload and storage
- OTA firmware distribution
- API key management for devices
## Authentication
- **User authentication**: Use `/api/auth/login` to get JWT tokens
- **Device authentication**: Use `X-API-Key` header with API keysOperations
Section titled “ Operations ”GET
/ GET
/health GET
/api/api-keys POST
/api/api-keys DELETE
/api/api-keys/{key_id} GET
/api/audit GET
/api/audit POST
/api/auth/login POST
/api/auth/logout GET
/api/auth/me POST
/api/auth/refresh POST
/api/auth/register POST
/api/auth/mcu/token POST
/api/auth/mfa/enroll POST
/api/billing/cancel PATCH
/api/billing/overage POST
/api/client-errors GET
/api/coredumps DELETE
/api/coredumps/{coredump_id} GET
/api/deployments GET
/api/devices POST
/api/devices DELETE
/api/devices/{device_id} PATCH
/api/devices/{device_id} GET
/api/sessions GET
/api/sessions DELETE
/api/sessions/{session_id} DELETE
/api/sessions/{session_id} GET
/api/firmware POST
/api/firmware DELETE
/api/firmware/{firmware_id} DELETE
/api/users/{user_id}/roles DELETE
/api/users/{user_id}/roles GET
/api/health GET
/api/health/live POST
/api/metrics/cleanup POST
/api/oauth/token POST
/api/organizations POST
/api/signing-keys DELETE
/api/signing-keys/{key_id} POST
/api/support-access GET
/api/users GET
/api/users/me PATCH
/api/users/me DELETE
/api/users/{user_id} PATCH
/api/users/{user_id} POST
/api/v1/coredump POST
/api/v1/heartbeat POST
/api/v1/metrics POST
/api/v1/provision POST
/api/v1/reboot POST
/api/v1/register Authentication
Section titled “ Authentication ”HTTPBearer
Section titled “ HTTPBearer ”Security scheme type: http