ROroblox
Observability

Launch a game server restart for a universe.

Changed on
post/server-management/v1/universes/{universeId}/restarts

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/server-management/v1/universes/{universeId}/restarts
  • Auth
    • API key in cookie .ROBLOSECURITY
    • or API key in header x-api-key
    • or OAuth 2
      Authorization code: https://apis.roblox.com/oauth/v1/authorize
      Token URL: https://apis.roblox.com/oauth/v1/token scopes: universe:write

Path parameters

universeIdinteger required

The universe ID

Request body

bleedOffDurationMinutesinteger nullable

Period in minutes before servers begin to be restarted. During this time, players will not be matchmade to servers scheduled for restart. Valid range: 1-240.

placesobject nullable

Optional mapping of place ID to specific PlaceFilter objects. If empty for a place, restart all versions of that place. If null/omitted entirely, restart all places in the universe.

attributesunknown

Response

Success

idstring nullable

ID of the restart.

playersImpactedinteger

Number of players in instances that will be shut down.

instancesImpactedinteger

Number of game instances that will be closed.

Changes