API Reference

Authentication

Rankly uses Bearer token authentication for all API endpoints. There are two types of API keys depending on what you are building.

Key Types

Server KeyRNKLY-XXXX-XXXX-XXXX-XXXX

Used by the DayZ mod to POST events to the ingest endpoint. Generated automatically when you create your server — displayed once during onboarding. Regenerate via Dashboard → Config.

Developer Keyrkly_xxxxxxxxxxxxxxxxxxxxxxxx

Used to call the v1 read API (leaderboard, kill feed, player stats, etc.). Requires the Network plan. Managed via Dashboard → API Keys.

Using Your Key

Pass your key as a Bearer token in the Authorization header on every request:

# v1 API (developer key)
curl -H "Authorization: Bearer rkly_your_key_here" \
  https://rankly.gg/api/v1/leaderboard

# Ingest endpoint (server key)
curl -X POST https://rankly.gg/api/ingest \
  -H "Authorization: Bearer RNKLY-XXXX-XXXX-XXXX-XXXX" \
  -H "Content-Type: application/json" \
  -d '[{"type": "connect", "steamId": "76561198012345678"}]'

Requests without a valid key receive a 401 Unauthorized response. Revoked keys are rejected immediately.

Generating Developer Keys

Developer keys give read access to the v1 API and require the Network plan.

  1. 1.Go to Dashboard → API Keys
  2. 2.Click Generate New Key and give it a label
  3. 3.Copy the key immediately — it will not be shown again
  4. 4.Keys can be revoked at any time from the same page

Regenerating Your Server Key

If you need to rotate your DayZ server's ingest key:

  1. 1.Go to your server dashboard
  2. 2.Navigate to Config
  3. 3.Click Regenerate API Key

Warning

Regenerating your server key immediately invalidates the previous key. Update the key in your DayZ server's RanklyConfig.json and restart the server.