Skip to main content

​
API Keys

The Miru API uses API keys to authenticate requests. You can view and manage your API keys in the Miru Dashboard. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. To authenticate, include your API key in the X-API-Key header of your request: 
curl --request GET \
  --url 'https://configs.api.miruml.com/v1/devices' \
  --header 'X-API-Key: <api-key>'
All requests must be made over HTTPS. Any requests over plain HTTP or without authentication will fail.

​
Create an API Key

To generate a new key:
  1. Go to the API Keys page in the dashboard.
  2. Click New API Key.
  3. Provide a name, select the desired scopes, and click Create.
Once an API key has been created, it can never be retrieved again. If you lose your API key, you must create a new one.
⌘I