Universe

属性

pathstring
createTimestring
出力のみ
updateTimestring
出力のみ
displayNamestring
出力のみ
descriptionstring
出力のみ

以下のうちの一つの owner:

userstring
出力のみ
groupstring
出力のみ
visibilityEnum<string>
出力のみ
facebookSocialLinkobject
twitterSocialLinkobject
youtubeSocialLinkobject
twitchSocialLinkobject
discordSocialLinkobject
robloxGroupSocialLinkobject
guildedSocialLinkobject
voiceChatEnabledboolean
ageRatingEnum<string>
出力のみ
privateServerPriceRobuxnumber
desktopEnabledboolean
mobileEnabledboolean
tabletEnabledboolean
consoleEnabledboolean
vrEnabledboolean
ベース URL
https://apis.roblox.com
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_id}
リクエストパスのパラメータ
universe_idstring
必須
レスポンスUniverse
GET /cloud/v2/universes/{universe_id}
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}' \

  -H 'x-api-key: {your-api-key}'
レスポンス
{

  "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_id}
範囲
universe:write
リクエストパスのパラメータ
universe_idstring
必須
クエリのパラメータ
updateMaskstring
リクエスト本文Universe
レスポンスUniverse
PATCH /cloud/v2/universes/{universe_id}
curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}?updateMask={string}' \

  -H 'x-api-key: {your-api-key}' \

  -H 'Content-Type: application/json' \

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

}'
レスポンス
{

  "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

Publish Universe Message
ベータ版

POST /cloud/v2/universes/{universe_id}:publishMessage
範囲
universe-messaging-service:publish
リクエストパスのパラメータ
universe_idstring
必須
リクエスト本文
topicstring
messagestring
POST /cloud/v2/universes/{universe_id}:publishMessage
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}:publishMessage' \

  -H 'x-api-key: {your-api-key}' \

  -H 'Content-Type: application/json' \

  --data '{

  "topic": "my-topic",

  "message": "Hello, world!"

}'

Universe

Restart Universe Servers

POST /cloud/v2/universes/{universe_id}:restartServers
範囲
universe:write
リクエストパスのパラメータ
universe_idstring
必須
リクエスト本文
レスポンス
POST /cloud/v2/universes/{universe_id}:restartServers
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}:restartServers' \

  -H 'x-api-key: {your-api-key}' \

  -H 'Content-Type: application/json' \

  --data '{}'
レスポンス
{}