Universe

Atributos

pathstring

createTimestring

Solo salida

updateTimestring

Solo salida

displayNamestring

Solo salida

descriptionstring

Solo salida

Uno de los siguientes para owner:

userstring

Solo salida

groupstring

Solo salida

visibilityEnum<string>

Solo salida

facebookSocialLinkobject

twitterSocialLinkobject

youtubeSocialLinkobject

twitchSocialLinkobject

discordSocialLinkobject

robloxGroupSocialLinkobject

guildedSocialLinkobject

voiceChatEnabledboolean

ageRatingEnum<string>

Solo salida

privateServerPriceRobuxnumber

desktopEnabledboolean

mobileEnabledboolean

tabletEnabledboolean

consoleEnabledboolean

vrEnabledboolean

URL base

https://apis.roblox.com/cloud

El recurso 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}

SolicitudParámetros de ruta

universestring

Obligatorio

RespuestaUniverse

GET /cloud/v2/universes/{universe}

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

Respuesta

{
  "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}

Ámbitos

universe:write

SolicitudParámetros de ruta

universestring

Obligatorio

Parámetros de consulta

updateMaskstring

Solicitar cuerpoUniverse

RespuestaUniverse

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 \
}'

Respuesta

{
  "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

Ámbitos

universe:write

SolicitudParámetros de ruta

universestring

Obligatorio

Solicitar cuerpo

Respuesta

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 '{}'

Respuesta

null