Skip to main content

API Keys

API keys are workspace-scoped credentials for machine-to-machine access to the IOTMER REST API. Use them in your backend services instead of user JWT tokens.

Create an API key​

  1. Go to Workspace Settings → API Keys
  2. Click New API Key
  3. Enter a descriptive name (e.g. backend-service, ci-pipeline)
  4. Click Create

Create API key

Copy the key now

The full key value is shown only once at creation. Copy and store it securely (e.g. in your secret manager). IOTMER stores only a hashed version.

Key kind: platform vs provision​

When you create a key, you set key_kind (see POST /workspaces/{id}/api-keys):

  • platform (default) — use the value as X-API-Key, or send the same value with Authorization: Bearer (full key in the token position), for the main REST API (workspaces, devices, billing, etc.).
  • provision — the same secret string is also used for POST /provision/device in the iotmer-auth-code header (raw string, not a Bearer token). You can also call POST /workspaces/{id}/devices with that key via X-API-Key or Authorization as usual. Provisioning and creating devices with a single factory key is a common pattern.

Using an API key (platform)​

Include the key in the X-API-Key header:

GET /workspaces/{id}/devices
X-API-Key: iotmer_ak_xxxxxxxxxxxxxxxxxxxxxxxx

Rotate / revoke a key​

To rotate: create a new key, update your service, then delete the old key.

To revoke immediately: click Delete next to the key in Workspace Settings → API Keys. Deletion is instant and permanent.

API​