API Reference

Authentication

Authenticate your API requests using an API key.

API Key Format

API keys follow the format:

RNKLY-XXXX-XXXX-XXXX-XXXX

Where each XXXX segment is a 4-character alphanumeric string. The RNKLY- prefix identifies the key as a Rankly API key.

Generating a Key

Your API key is generated automatically when you sign up and create your server. It is displayed once during the onboarding process.

Important

Copy and store your API key securely when it is shown. For security reasons, the full key is only displayed once. If you lose it, you will need to regenerate a new key.

Regenerating a Key

If you need a new API key, you can regenerate one from your dashboard:

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

Warning

Regenerating your API key immediately invalidates the previous key. You will need to update the key in your DayZ server's RanklyConfig.json file and restart the server.

Using the Key

Include your API key in the X-API-Key header of every request:

curl -X POST https://rankly.gg/api/ingest \
  -H "X-API-Key: RNKLY-XXXX-XXXX-XXXX-XXXX" \
  -H "Content-Type: application/json" \
  -d '[{"type": "connect", "steamId": "76561198012345678"}]'

Requests without a valid API key receive a 401 Unauthorized response.