6 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

Universe — cloud.docs

Represents a Roblox experience.

Properties

Related Schemas

• Universe_SocialLink

Complete Schema

{
  "required": [
    "templateRootPlace"
  ],
  "type": "object",
  "properties": {
    "path": {
      "example": "universes/123",
      "type": "string",
      "description": "The resource path of the universe.\n\nFormat: `universes/{universe_id}`"
    },
    "createTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The timestamp when the universe was created.",
      "format": "date-time"
    },
    "updateTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The timestamp when the universe was last updated.",
      "format": "date-time"
    },
    "displayName": {
      "readOnly": true,
      "example": "ROBLOX Battle [OPEN]",
      "type": "string",
      "description": "The name of the universe.\n\nThis field can be updated by updating the root place's name."
    },
    "description": {
      "readOnly": true,
      "example": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",
      "type": "string",
      "description": "The description of the universe.\n\nThis field can be updated by updating the root place's description."
    },
    "user": {
      "readOnly": true,
      "type": "string",
      "description": "The universe is user-owned."
    },
    "group": {
      "type": "string",
      "description": "The universe is group-owned.",
      "x-immutable": true
    },
    "visibility": {
      "readOnly": true,
      "example": "VISIBILITY_UNSPECIFIED",
      "enum": [
        "VISIBILITY_UNSPECIFIED",
        "PUBLIC",
        "PRIVATE"
      ],
      "type": "string",
      "description": "Whether or not the universe is publicly accessible.\n\nPossible values:\n\n  | Value | Description |\n  | --- | --- |\n  | VISIBILITY_UNSPECIFIED | Updates using this value will throw an error on the backend. |\n  | PUBLIC | The universe is public. |\n  | 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. |",
      "format": "enum"
    },
    "facebookSocialLink": {
      "$ref": "#/components/schemas/Universe_SocialLink",
      "description": "The Facebook social link."
    },
    "twitterSocialLink": {
      "$ref": "#/components/schemas/Universe_SocialLink",
      "description": "The Twitter social link."
    },
    "youtubeSocialLink": {
      "$ref": "#/components/schemas/Universe_SocialLink",
      "description": "The Youtube social link."
    },
    "twitchSocialLink": {
      "$ref": "#/components/schemas/Universe_SocialLink",
      "description": "The Twitch social link."
    },
    "discordSocialLink": {
      "$ref": "#/components/schemas/Universe_SocialLink",
      "description": "The Discord social link."
    },
    "robloxGroupSocialLink": {
      "$ref": "#/components/schemas/Universe_SocialLink",
      "description": "The Roblox group social link."
    },
    "guildedSocialLink": {
      "$ref": "#/components/schemas/Universe_SocialLink",
      "description": "The Guilded social link."
    },
    "voiceChatEnabled": {
      "example": true,
      "type": "boolean",
      "description": "Whether or not voice chat is enabled for users in the Experience.\n\nUpdating this value will not affect active servers."
    },
    "ageRating": {
      "readOnly": true,
      "example": "AGE_RATING_UNSPECIFIED",
      "enum": [
        "AGE_RATING_UNSPECIFIED",
        "AGE_RATING_ALL",
        "AGE_RATING_9_PLUS",
        "AGE_RATING_13_PLUS",
        "AGE_RATING_17_PLUS"
      ],
      "type": "string",
      "description": "The age rating of this universe.\n\nPossible values:\n\n  | Value | Description |\n  | --- | --- |\n  | AGE_RATING_UNSPECIFIED | The age rating is not set. |\n  | AGE_RATING_ALL | Supported for all users. |\n  | AGE_RATING_9_PLUS | Supported for users aged 9 and up. |\n  | AGE_RATING_13_PLUS | Supported for users aged 13 and up. |\n  | AGE_RATING_17_PLUS | Supported for users aged 17 and up. |",
      "format": "enum"
    },
    "privateServerPriceRobux": {
      "type": "integer",
      "description": "Represents the price in Robux of private servers.\n\nIf unset, private servers are not supported for this universe.\n\nCan only be disabled when using a field mask.\n\nSetting to null will disable all active private servers.\n\nChanging the price will cancel all private server subscriptions.",
      "format": "int32"
    },
    "desktopEnabled": {
      "example": true,
      "type": "boolean",
      "description": "Whether or not players can join the Experience via Desktop."
    },
    "mobileEnabled": {
      "example": true,
      "type": "boolean",
      "description": "Whether or not players can join the Experience via Mobile."
    },
    "tabletEnabled": {
      "example": true,
      "type": "boolean",
      "description": "Whether or not players can join the Experience via Tablet."
    },
    "consoleEnabled": {
      "example": true,
      "type": "boolean",
      "description": "Whether or not players can join the Experience via Console."
    },
    "vrEnabled": {
      "example": true,
      "type": "boolean",
      "description": "Whether or not players can join the Experience via VR."
    },
    "rootPlace": {
      "readOnly": true,
      "type": "string",
      "description": "The resource path of the root place of this universe\nFormat: universes/{universe_id}/places/{place_id}"
    },
    "templateRootPlace": {
      "writeOnly": true,
      "example": "universes/{universe_id}/places/{place_id}",
      "type": "string",
      "description": "The resource path of the template place, used for CreateUniverse.\nThe root place of the newly-created universe will be a clone of this\ntemplate. A list of the valid template places can be obtained from\nListTemplatePlaces. Format: universes/{universe_id}/places/{place_id}",
      "x-immutable": true
    }
  },
  "description": "Represents a Roblox experience.",
  "x-aep-resource": {
    "patterns": [
      "universes/{universe_id}"
    ],
    "plural": "universes",
    "singular": "universe"
  },
  "x-resource": true,
  "x-oneOf": {
    "ConsoleEnabled": [
      "consoleEnabled"
    ],
    "DesktopEnabled": [
      "desktopEnabled"
    ],
    "MobileEnabled": [
      "mobileEnabled"
    ],
    "PrivateServerPriceRobux": [
      "privateServerPriceRobux"
    ],
    "TabletEnabled": [
      "tabletEnabled"
    ],
    "VoiceChatEnabled": [
      "voiceChatEnabled"
    ],
    "VrEnabled": [
      "vrEnabled"
    ],
    "owner": [
      "user",
      "group"
    ]
  }
}