IOTMER Control Plane API (Customer)
Workspace-scoped REST API for MQTT, devices, domains, and billing.
Create your account in the IOTMER console (this API does not document registration or password reset).
Authentication (Swagger Authorize)
Click Authorize and use one scheme, then Try it out on workspace endpoints.
| Scheme | When to use | What to paste |
|---|---|---|
| ApiKeyAuth | Workspace platform API key | The key (header X-API-Key) |
| BearerAuth | Same platform API key, or console JWT | Key or access_token only (Swagger adds Bearer) |
| IotmerAuthCode | Factory provision key only | Raw key (header iotmer-auth-code) — /provision/* only |
JWT from this API
POST /auth/login with the console email/password → copy access_token → Authorize → BearerAuth. If the login response has mfa_required, complete POST /auth/mfa/verify first.
Platform API keys are created in the console (Settings → API Keys) or POST /workspaces/{id}/api-keys. The plaintext key is returned once. Scoped to that workspace (admin-level).
Data pipeline endpoints are omitted until GA. Operations without a human-written summary are omitted. Does not include IOTMER platform administration or internal operator endpoints.
Authentication
- API Key: ApiKeyAuth
- HTTP: Bearer Auth
- API Key: IotmerAuthCode
Workspace platform API key. Create with POST /workspaces/{id}/api-keys (key_kind: platform).
The plaintext key is returned once. Paste the key as-is. Equivalent header: X-API-Key: <key>.
Scoped to one workspace (admin-level). Do not use a provision key here.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-API-Key |
Console JWT access_token from POST /auth/login, or a workspace platform API key. Paste the token or key only (Swagger adds Bearer ).
Equivalent header: Authorization: Bearer <value>.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT or API key |
Workspace provision API key (key_kind: provision). Paste the raw key (no Bearer prefix). Only for factory routes GET /provision/device-templates and POST /provision/device.
Equivalent header: iotmer-auth-code: <key>.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | iotmer-auth-code |