ROroblox
Universes

Get settings for an owned universe.

Changed on
get/v1/universes/{universeId}/configuration

Request

  • Base URL
    https://develop.roblox.com
  • URL
    https://develop.roblox.com/v1/universes/{universeId}/configuration
  • Auth
    API key in cookie .ROBLOSECURITY

Path parameters

universeIdinteger required

The universe Id.

Response

OK

allowPrivateServersboolean

If the universe allows the use of private servers.

privateServerPriceinteger

The price to purchase a private server in robux.

isMeshTextureApiAccessAllowedboolean

Whether access to APIs for mesh and texture is enabled for this universe.

isRewardedOnDemandAdsAllowedboolean

Whether rewarded on-demand ads are allowed for this universe.

idinteger

The universe Id.

namestring

The universe name.

promotionalTextstring

Promotional Text for the universe.

universeAvatarType1 | 2 | 3

Which avatar types are allowed in the universe. ['MorphToR6' = 1, 'PlayerChoice' = 2, 'MorphToR15' = 3]

universeScaleType1 | 2

Whether custom scales allowed in the universe. ['NoScales' = 1, 'AllScales' = 2]

universeAnimationType1 | 2

Whether custom animations are allowed in the universe. ['Standard' = 1, 'PlayerChoice' = 2]

universeCollisionType1 | 2

What type of collisions are used by the universe. ['InnerBox' = 1, 'OuterBox' = 2]

universeBodyType1 | 2

What avatar body types are allowed by the universe. ['Standard' = 1, 'PlayerChoice' = 2]

universeJointPositioningType1 | 2

What avatar joint positioning is allowed by the universe. ['Standard' = 1, 'ArtistIntent' = 2]

isArchivedboolean

Archive status of the universe

isFriendsOnlyboolean

Whether game access is limited to friends for user-owned games or group members for group-owned games.

genre0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14

Game genre. ['All' = 0, 'Tutorial' = 1, 'Scary' = 2, 'TownAndCity' = 3, 'War' = 4, 'Funny' = 5, 'Fantasy' = 6, 'Adventure' = 7, 'SciFi' = 8, 'Pirate' = 9, 'FPS' = 10, 'RPG' = 11, 'Sports' = 12, 'Ninja' = 13, 'WildWest' = 14]

playableDevicesinteger[]

List of device types this game can be played on.

isForSaleboolean

Whether the game is offered for sale.

priceinteger

Price of the game, in Robux.

isStudioAccessToApisAllowedboolean

Whether studio access to APIs is allowed or not.

privacyTypestring

Privacy type of the universe.

isForSaleInFiatboolean

Whether the game is offered for sale in fiat.

fiatBasePriceIdstring

The basePriceId for the Fiat product.

fiatModerationStatus0 | 1 | 2 | 3 | 4

The current moderation status of the game if it is for sale in fiat. ['Invalid' = 0, 'NotModerated' = 1, 'Pending' = 2, 'Approved' = 3, 'Rejected' = 4]

audiencesinteger[]

The audiences this universe is visible to (e.g. Editors, PlayTesters, Friends, Public). Always non-null; may be empty when audience visibility has not been configured.

demoModeEnabledboolean

Whether demo mode is enabled.

demoModeChangeableAfterstring date-time

The earliest time at which demo mode can be toggled again (ISO 8601). Null when no cooldown is active (i.e. demo mode can be changed immediately).

Changes

  • 3fe4a685dcbcRevision changes
    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)