Report Roblox server state

Reports the runtime state of a single Roblox game server (player count, place/job IDs, server metadata, etc.) keyed by serverId. The payload is formatted and ingested into our pipeline. Only Roblox-platform SDK keys may call this — other platforms receive a 403 with INVALID_PLATFORM.

Authorization

sdkApiKey

authorization<token>

SDK (public) key, prefixed gb_pk_ (older keys: sdk_). Send it as the authorization header value. Scoped to one project, so it is safe to ship in a game build.

In: header

Path Parameters

serverId*string

Header Parameters

isstudio?|

Defaulttrue

project-id?integer

Range0 < value <= 9007199254740991

sdkversion*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

timestamp*unknown

rootPlaceId*number

universeId*number

placeVersion*number

players*array<string>

metadata*

Response Body

`application/json`

curl -X POST "https://example.com/sdk/v1/servers/roblox/string" \  -H "sdkversion: string" \  -H "Content-Type: application/json" \  -d '{    "timestamp": null,    "rootPlaceId": 0,    "universeId": 0,    "placeVersion": 0,    "players": [      "string"    ],    "metadata": {      "matchmakingType": "string",      "serverAgeSeconds": 0    }  }'

{  "message": "string"}

Report Roblox server state

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

403application/json

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`