Skip to main content

Authentication

danger

API keys are sensitive data. Keep them secret and never share them publicly.
Failing to do so may result in unauthorized access to your account and data and will expose you to the risk of data loss.

The Garmingo Status API uses API keys to authenticate requests.
API keys are unique identifiers that are used to authenticate requests to the API.

To authenticate with the Garmingo Status API, you need to include your API key in the x-garmingo-status-key header of your HTTP request.

Obtaining an API Key

info

API Keys can only be managed by users with the Admin role.

To obtain an API key, you need to create a new API key in the Garmingo Status Dashboard.
Go to the Settings Page of your Garmingo Status instance and there to the "API" section.

Click on the "Create API Key" button to create a new API key.