ROroblox
Universes

Restart Universe Servers

Changed on

Restarts active servers for a specific universe. Defaults to only restarting servers running older versions, but can be configured to restart all servers regardless of version. Used for releasing experience updates.

post/cloud/v2/universes/{universe_id}:restartServers

Request

  • Base URL
    https://apis.roblox.com
  • URL
    https://apis.roblox.com/cloud/v2/universes/{universe_id}:restartServers
  • Auth
    • 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

universe_idstring required

The universe ID.

Request body

placeIdsinteger[]

The place IDs to update. If none are specified, all active places in the universe will be updated.

closeAllVersionsboolean

If true, players from servers running both old and new place versions will be restarted. If false, restarts all active servers for a specific universe if and only if a new version of the experience has been published.

bleedOffServersboolean

If true, matchmaking to servers will stop, but servers will stay up for bleed_off_duration_minutes before shutting down. This setting gives players time to naturally migrate to the newer version. If false, servers will immediately start shutting down.

bleedOffDurationMinutesinteger

If bleed_off_servers is true, how long (in minutes) old servers are allowed to stay up before shutting them down. Valid values: 1-60 minutes.

Example request

{
  "closeAllVersions": true,
  "bleedOffServers": true,
  "bleedOffDurationMinutes": 10
}

Response

OK

RestartUniverseServersResponse required

Empty response. May later contain a status.

Changes