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
เวอร์ชัน Beta

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 '{}'
การตอบกลับ

{}