Aleeva API
The Aleeva API lets other applications work with your Aleeva data. Connect a tool to Aleeva, upload DPS reports from your own uploader, or read the events and servers you have access to.
The full endpoint reference lives at api.aleeva.io/api-doc.html. The production base URL is https://api.aleeva.io.
Getting an API key
Open and choose "Aleeva API Access". Aleeva asks which permissions the key should carry, then hands you the key. Give it only the permissions the application actually needs.
The permissions you can grant yourself are:
- Read server settings. Read the settings of every server where you have the Aleeva Administrator permission.
- Read channels. Read the channels of servers you are a member of.
- Read events. Read your subscribed events, and the events of servers where you have the Event Administrator or Aleeva Administrator permission.
- Upload reports. Upload DPS reports on your behalf.
The same menu lists your existing keys, so you can revoke access whenever you want.
Using the API
Send the key in the Authorization header. Every request also needs a User-Agent header naming your project and its version; requests without one are rejected.
The API is versioned by media type. Pin a version so the response shape stays stable across releases:
Accept: application/json;version=2.10.6Omitting the version uses the latest one, which can change on a breaking release.
When you call a version that is being retired, the response carries Deprecation and Sunset headers plus a Link header pointing at the version history. The current version returns none of them, so their presence is your signal to migrate.
Limits
You can make 10 requests per 10 seconds per user. Most endpoints are cached by the CDN, by default for 5 minutes.
If you need a higher limit, or you want to hear about API updates before they land, get in touch on the support server.