Universe

Attributes

pathstring

createTimestring

updateTimestring

displayNamestring

descriptionstring

visibilityEnum<string>

VISIBILITY_UNSPECIFIED, PUBLIC, PRIVATE

facebookSocialLinkobject

twitterSocialLinkobject

youtubeSocialLinkobject

twitchSocialLinkobject

discordSocialLinkobject

robloxGroupSocialLinkobject

guildedSocialLinkobject

voiceChatEnabledboolean

ageRatingEnum<string>

AGE_RATING_UNSPECIFIED, AGE_RATING_ALL, AGE_RATING_9_PLUS, AGE_RATING_13_PLUS, AGE_RATING_17_PLUS

privateServerPriceRobuxnumber

desktopEnabledboolean

mobileEnabledboolean

tabletEnabledboolean

consoleEnabledboolean

vrEnabledboolean

One of

userstring

groupstring

Base URL

https://apis.roblox.com/cloud

The Universe Resource

{
  "path": "universes/20514875",
  "createTime": "2023-07-05T12:34:56Z",
  "updateTime": "2023-07-05T12:34:56Z",
  "displayName": "ROBLOX Battle [OPEN]",
  "description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",
  "user": "string",
  "visibility": "VISIBILITY_UNSPECIFIED",
  "facebookSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitterSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "youtubeSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitchSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "discordSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "robloxGroupSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "guildedSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "voiceChatEnabled": true,
  "ageRating": "AGE_RATING_UNSPECIFIED",
  "privateServerPriceRobux": "integer",
  "desktopEnabled": true,
  "mobileEnabled": true,
  "tabletEnabled": true,
  "consoleEnabled": true,
  "vrEnabled": true
}

Universe

Get Universe

GET /v2/universes/{universe}

RequestPath Parameters

universestringRequired

ResponseUniverse

GET /v2/universes/{universe}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe}' \
  -H 'x-api-key: {your-api-key}'

Response

{
  "path": "universes/20514875",
  "createTime": "2023-07-05T12:34:56Z",
  "updateTime": "2023-07-05T12:34:56Z",
  "displayName": "ROBLOX Battle [OPEN]",
  "description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",
  "user": "string",
  "visibility": "VISIBILITY_UNSPECIFIED",
  "facebookSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitterSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "youtubeSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitchSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "discordSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "robloxGroupSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "guildedSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "voiceChatEnabled": true,
  "ageRating": "AGE_RATING_UNSPECIFIED",
  "privateServerPriceRobux": "integer",
  "desktopEnabled": true,
  "mobileEnabled": true,
  "tabletEnabled": true,
  "consoleEnabled": true,
  "vrEnabled": true
}

Universe

Update Universe

PATCH /v2/universes/{universe}

Scopes

universe:write

RequestPath Parameters

universestringRequired

Query Parameters

updateMaskstring

Request BodyUniverse

ResponseUniverse

PATCH /v2/universes/{universe}

curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe}?updateMask={string}' \
  -H 'x-api-key: {your-api-key}' \
  -H 'Content-Type: application/json' \
  -d  \
  '{
  "facebookSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitterSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "youtubeSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitchSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "discordSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "robloxGroupSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "guildedSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "voiceChatEnabled": true,
  "privateServerPriceRobux": "integer",
  "desktopEnabled": true,
  "mobileEnabled": true,
  "tabletEnabled": true,
  "consoleEnabled": true,
  "vrEnabled": true
}'

Response

{
  "path": "universes/20514875",
  "createTime": "2023-07-05T12:34:56Z",
  "updateTime": "2023-07-05T12:34:56Z",
  "displayName": "ROBLOX Battle [OPEN]",
  "description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",
  "user": "string",
  "visibility": "VISIBILITY_UNSPECIFIED",
  "facebookSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitterSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "youtubeSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "twitchSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "discordSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "robloxGroupSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "guildedSocialLink": {
    "title": "string",
    "uri": "string"
  },
  "voiceChatEnabled": true,
  "ageRating": "AGE_RATING_UNSPECIFIED",
  "privateServerPriceRobux": "integer",
  "desktopEnabled": true,
  "mobileEnabled": true,
  "tabletEnabled": true,
  "consoleEnabled": true,
  "vrEnabled": true
}

Universe

Restart Universe Servers

POST /v2/universes/{universe}:restartServers

Scopes

universe:write

RequestPath Parameters

universestringRequired

Request Body

pathstring

Response

POST /v2/universes/{universe}:restartServers

curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe}:restartServers' \
  -H 'x-api-key: {your-api-key}' \
  -H 'Content-Type: application/json' \
  -d '{}'

Response

null