Answers the game the key opens and its limit per minute, so a game's server can check its key when it starts. It never answers the key or its fingerprint.
Request to GET /developer/v1/key
GET/developer/v1/key
Headers
AuthorizationstringRequiredBearer bk_live_<the game's key>.
The route takes no parameters.
GET https://studio.blockoutgames.com/developer/v1/keyAuthorization: Bearer bk_live_<the game's key>What GET /developer/v1/key answers
200 with a DeveloperKeyInfo:
{ "game": { "id": 1001, "name": "Rising Tycoon" }, "limits": { "perMinute": 120 } }DeveloperKeyInfo
game.idnumber- The game's Roblox universe id.
game.namestring- The studio catalog's title for the game, else the collector's name, else
Universe <id>. limits.perMinutenumber- Requests a minute this key may make, for every server of the game together (
GAME_API_RATE_LIMIT_PER_KEY, 120).
How this route is cached and counted
Not cached by the platform: every request reads the key afresh. It counts against the key's 120 a minute and appears as GET /key in the key's usage on the Developer tab. The Template's PlatformService.key() keeps the answer for 30 minutes in its shared cache, so checking it on every server's start costs about two requests an hour.
Errors from GET /developer/v1/key
| Status | error.code | When |
|---|---|---|
| 401 | unauthenticated | The key is missing, malformed, wrong or revoked, or its game left the catalog |
| 429 | rate_limited | Over a limit; wait the Retry-After seconds |
Bodies and what to do: Errors, limits and polling.
Updated