Universe

Represents a Roblox experience.

Thuộc Tính

pathstring

The resource path of the universe.

Format: universes/{universe_id}.

createTimestring

Chỉ Xuất

The timestamp when the universe was created. Chuỗi này được định dạng là Dấu thời gian.

updateTimestring

Chỉ Xuất

The timestamp when the universe was last updated. Chuỗi này được định dạng là Dấu thời gian.

displayNamestring

Chỉ Xuất

The name of the universe.

This field can be updated by updating the root place's name.

descriptionstring

Chỉ Xuất

The description of the universe.

This field can be updated by updating the root place's description.

Một trong những thông tin sau đây cho owner:

userstring

Chỉ Xuất

The universe is user-owned.

groupstring

Chỉ Xuất

The universe is group-owned.

visibilityEnum<string>

Chỉ Xuất

Whether or not the universe is publicly accessible.

Possible values:

Value	Description
VISIBILITY_UNSPECIFIED	Updates using this value will throw an error on the backend.
PUBLIC	The universe is public.
PRIVATE	The universe is private. If a universe's visibility is set to PRIVATE, all active players will immediately be removed from all running servers.

facebookSocialLinkobject

The Facebook social link.

twitterSocialLinkobject

The Twitter social link.

youtubeSocialLinkobject

The Youtube social link.

twitchSocialLinkobject

The Twitch social link.

discordSocialLinkobject

The Discord social link.

robloxGroupSocialLinkobject

The Roblox group social link.

guildedSocialLinkobject

The Guilded social link.

voiceChatEnabledboolean

Whether or not voice chat is enabled for users in the Experience.

Updating this value will not affect active servers.

ageRatingEnum<string>

Chỉ Xuất

The age rating of this universe.

Possible values:

Value	Description
AGE_RATING_UNSPECIFIED	The age rating is not set.
AGE_RATING_ALL	Supported for all users.
AGE_RATING_9_PLUS	Supported for users aged 9 and up.
AGE_RATING_13_PLUS	Supported for users aged 13 and up.
AGE_RATING_17_PLUS	Supported for users aged 17 and up.

privateServerPriceRobuxnumber

Represents the price in Robux of private servers.

If unset, private servers are not supported for this universe.

Can only be disabled when using a field mask.

Setting to null will disable all active private servers.

Changing the price will cancel all private server subscriptions.

desktopEnabledboolean

Whether or not players can join the Experience via Desktop.

mobileEnabledboolean

Whether or not players can join the Experience via Mobile.

tabletEnabledboolean

Whether or not players can join the Experience via Tablet.

consoleEnabledboolean

Whether or not players can join the Experience via Console.

vrEnabledboolean

Whether or not players can join the Experience via VR.

URL Cơ Sở

https://apis.roblox.com

Tài nguyên 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}

Gets the specified universe.

Yêu CầuTham Số Đường Dẫn

universe_idstring

Bắt Buộc

The universe ID.

Phản HồiUniverse

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

Phản Hồi

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

Updates the specified universe.

This method is guaranteed to return all updated fields. This method may additionally return the full resource.

Phạm Vi

universe:write

Yêu CầuTham Số Đường Dẫn

universe_idstring

Bắt Buộc

The universe ID.

Tham Số Truy Vấn

updateMaskstring

The list of fields to update. Chuỗi này được định dạng là Mặt nạ trường.

Yêu Cầu Cơ ThểUniverse

Phản HồiUniverse

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

Phản Hồi

{
  "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
Bản Beta

POST /cloud/v2/universes/{universe_id}:publishMessage

Publishes a message to the universe's live servers.

Servers can consume messages via MessagingService.

Phạm Vi

universe-messaging-service:publish

Yêu CầuTham Số Đường Dẫn

universe_idstring

Bắt Buộc

The universe ID.

Yêu Cầu Cơ Thể

topicstring

The topic on which to publish the message.

messagestring

The message to publish.

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

Restarts all active servers for a specific universe if and only if a new version of the experience has been published. Used for releasing experience updates.

Phạm Vi

universe:write

Yêu CầuTham Số Đường Dẫn

universe_idstring

Bắt Buộc

The universe ID.

Yêu Cầu Cơ Thể

Phản Hồi

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

Phản Hồi

{}

Universe

Thuộc Tính

Universe

Get Universe

Universe

Update Universe

Universe

Publish Universe MessageBản Beta

Universe

Restart Universe Servers

Publish Universe Message
Bản Beta