Universe

Attributs

pathstring

createTimestring

Sortie seule

updateTimestring

Sortie seule

displayNamestring

Sortie seule

descriptionstring

Sortie seule

Un des éléments suivants pour owner:

userstring

Sortie seule

groupstring

Sortie seule

visibilityEnum<string>

Sortie seule

facebookSocialLinkobject

twitterSocialLinkobject

youtubeSocialLinkobject

twitchSocialLinkobject

discordSocialLinkobject

robloxGroupSocialLinkobject

guildedSocialLinkobject

voiceChatEnabledboolean

ageRatingEnum<string>

Sortie seule

privateServerPriceRobuxnumber

desktopEnabledboolean

mobileEnabledboolean

tabletEnabledboolean

consoleEnabledboolean

vrEnabledboolean

URL de base

https://apis.roblox.com/cloud

La ressource Universe

{
  "path": "universes/123",
  "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 /cloud/v2/universes/{universe}

RequêteParamètres du chemin

universestring

Requis

RéponseUniverse

GET /cloud/v2/universes/{universe}

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

Réponse

{
  "path": "universes/123",
  "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 /cloud/v2/universes/{universe}

Périmètres d'application

universe:write

RequêteParamètres du chemin

universestring

Requis

Paramètres de requête

updateMaskstring

Corps de la requêteUniverse

RéponseUniverse

PATCH /cloud/v2/universes/{universe}

curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe}?updateMask={string}' \
  -H 'x-api-key: {your-api-key}' \
  --data '{ \
  "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 \
}'

Réponse

{
  "path": "universes/123",
  "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 /cloud/v2/universes/{universe}:restartServers

Périmètres d'application

universe:write

RequêteParamètres du chemin

universestring

Requis

Corps de la requête

Réponse

POST /cloud/v2/universes/{universe}:restartServers

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

Réponse

null