Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.
POST /server-management/v1/universes/{universeId}/restarts — openapi
Launch a game server restart for a universe.
Endpoint
Method: POST
Path: /server-management/v1/universes/{universeId}/restarts
Servers:
https://apis.roblox.com
Parameters
| Name | Location | Required | Description |
|---|---|---|---|
| universeId | path | true | The universe ID |
[
{
"name": "universeId",
"in": "path",
"description": "The universe ID",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
]Request Body
The launch restart request body
{
"description": "The launch restart request body",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/LaunchRestartRequest"
}
],
"description": "Request model for launching a game restart."
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/LaunchRestartRequest"
}
],
"description": "Request model for launching a game restart."
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/LaunchRestartRequest"
}
],
"description": "Request model for launching a game restart."
}
}
}
}Responses
| Status | Description |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
{
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LaunchRestartResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerManagementService.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerManagementService.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerManagementService.ProblemDetails"
}
}
}
}
}Authentication
{
"security": [
{
"roblox-legacy-cookie": []
},
{
"roblox-api-key": []
},
{
"roblox-oauth2": [
"universe:write"
]
}
],
"securitySchemes": {
"roblox-api-key": {
"type": "apiKey",
"description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
"name": "x-api-key",
"in": "header"
},
"roblox-legacy-cookie": {
"type": "apiKey",
"description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. We do not recommend using cookies to call endpoints. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
"in": "cookie",
"name": ".ROBLOSECURITY"
},
"roblox-oauth2": {
"type": "oauth2",
"description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
"tokenUrl": "https://apis.roblox.com/oauth/v1/token",
"refreshUrl": "https://apis.roblox.com/oauth/v1/token",
"scopes": {}
}
}
}
}
}Related Schemas
Complete Operation Definition
{
"tags": [
"Observability"
],
"summary": "Launch a game server restart for a universe.",
"operationId": "Restarts_LaunchRestart",
"parameters": [
{
"name": "universeId",
"in": "path",
"description": "The universe ID",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "The launch restart request body",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/LaunchRestartRequest"
}
],
"description": "Request model for launching a game restart."
}
},
"text/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/LaunchRestartRequest"
}
],
"description": "Request model for launching a game restart."
}
},
"application/*+json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/LaunchRestartRequest"
}
],
"description": "Request model for launching a game restart."
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LaunchRestartResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerManagementService.ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerManagementService.ProblemDetails"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerManagementService.ProblemDetails"
}
}
}
}
},
"x-roblox-stability": "BETA",
"x-roblox-rate-limits": {
"perApiKeyOwner": {
"period": "MINUTE",
"maxInPeriod": 100
},
"perOauth2Authorization": {
"period": "MINUTE",
"maxInPeriod": 100
}
},
"x-roblox-scopes": [
{
"name": "universe:write",
"targetResourceSpecifier": "universes"
}
],
"x-roblox-engine-usability": {
"apiKeyWithHttpService": true
},
"security": [
{
"roblox-legacy-cookie": []
},
{
"roblox-api-key": []
},
{
"roblox-oauth2": [
"universe:write"
]
}
],
"externalDocs": {
"url": "https://create.roblox.com/docs/cloud/reference/features/observability#Restarts_LaunchRestart"
}
}