API keys let you read your monitoring data programmatically through the Ravnsight read API, and are created under Settings → API.
Create an API key
Go to Settings → API, enter a descriptive name for the key and click Create key. The name helps you recognise where the key is used.
- The key itself is shown only once, right after it is created. Copy it and store it somewhere safe immediately.
- Afterwards the list shows only the key's prefix, along with the creation date, when it was last used and the number of requests made.
- Each plan has a limit on the number of keys. When the limit is reached you must delete an existing key before you can create a new one.
Keep the key secret
An API key grants read access to your account's data. Treat it like a password.
- Never put the key in public code, in browser client code or in a version-controlled repository.
- Use the key only from servers or tools you control yourself.
- If you suspect a key has leaked, click Regenerate to invalidate the old one and get a new value, or Delete the key entirely.
Using the key against the read API
Send the key in the X-API-Key header on every request. The Authorization: Bearer YOUR_KEY header also works.
A simple example with curl:
curl -H "X-API-Key: YOUR_KEY" https://ravnsight.se/api/v1/monitoring/sites
Each key in the list has a status: Active, Expired or Inactive. Only active keys are accepted.
A Pro feature
The read API is a Pro feature (api.read). On the Free plan there is no API access, and the Settings → API page is not available. If an administrator has turned the API off entirely, a message is shown instead saying the API is not available.
Endpoints and examples
For a full list of available endpoints with example responses, see the article Read API — endpoints and examples.