Cloud API (cloud.docs)

The Roblox Open Cloud v2 API. This is a subset of endpoints that Roblox provides. See https://create.roblox.com/docs/cloud/open-cloud for more details.

Download the original OpenAPI definition

Operations

Method	Endpoint	Summary
POST	/cloud/v2/creator-store-products	Create Creator Store Product
GET	/cloud/v2/creator-store-products/{creator_store_product_id}	Get Creator Store Product
PATCH	/cloud/v2/creator-store-products/{creator_store_product_id}	Update Creator Store Product
GET	/cloud/v2/groups/{group_id}	Get Group
GET	/cloud/v2/groups/{group_id}/forum-categories	List Group Forum Categories
GET	/cloud/v2/groups/{group_id}/forum-categories/{forum_category_id}/posts	List Group Forum Posts
GET	/cloud/v2/groups/{group_id}/forum-categories/{forum_category_id}/posts/{post_id}/comments	List Group Forum Comments
GET	/cloud/v2/groups/{group_id}/join-requests	List Group Join Requests
POST	/cloud/v2/groups/{group_id}/join-requests/{join_request_id}:accept	Accept Group Join Request
POST	/cloud/v2/groups/{group_id}/join-requests/{join_request_id}:decline	Decline Group Join Request
GET	/cloud/v2/groups/{group_id}/memberships	List Group Memberships
PATCH	/cloud/v2/groups/{group_id}/memberships/{membership_id}	Update Group Membership
POST	/cloud/v2/groups/{group_id}/memberships/{membership_id}:assignRole	Assign Role Group Membership
POST	/cloud/v2/groups/{group_id}/memberships/{membership_id}:unassignRole	Unassign Role Group Membership
GET	/cloud/v2/groups/{group_id}/roles	List Group Roles
GET	/cloud/v2/groups/{group_id}/roles/{role_id}	Get Group Role
GET	/cloud/v2/universes/{universe_id}	Get Universe
PATCH	/cloud/v2/universes/{universe_id}	Update Universe
GET	/cloud/v2/universes/{universe_id}/data-stores	List Data Stores
DELETE	/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}	Delete Data Store
GET	/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries	List Data Store Entries
POST	/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries	Create Data Store Entry
GET	/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}	Get Data Store Entry
DELETE	/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}	Delete Data Store Entry
PATCH	/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}	Update Data Store Entry
POST	/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:increment	Increment Data Store Entry
GET	/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/entries/{entry_id}:listRevisions	List Data Store Entry Revisions
GET	/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries	List Data Store Entries
POST	/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries	Create Data Store Entry
GET	/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}	Get Data Store Entry
DELETE	/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}	Delete Data Store Entry
PATCH	/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}	Update Data Store Entry
POST	/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment	Increment Data Store Entry
GET	/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}/scopes/{scope_id}/entries/{entry_id}:listRevisions	List Data Store Entry Revisions
POST	/cloud/v2/universes/{universe_id}/data-stores/{data_store_id}:undelete	Undelete Data Store
POST	/cloud/v2/universes/{universe_id}/data-stores:snapshot	Snapshot Data Stores
POST	/cloud/v2/universes/{universe_id}/luau-execution-session-task-binary-inputs	Create Luau Execution Session Task Binary Input
POST	/cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items	Create Memory Store Queue Item
POST	/cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items:discard	Discard Memory Store Queue Items
GET	/cloud/v2/universes/{universe_id}/memory-store/queues/{queue_id}/items:read	Read Memory Store Queue Items
GET	/cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items	List Memory Store Sorted Map Items
POST	/cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items	Create Memory Store Sorted Map Item
GET	/cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}	Get Memory Store Sorted Map Item
DELETE	/cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}	Delete Memory Store Sorted Map Item
PATCH	/cloud/v2/universes/{universe_id}/memory-store/sorted-maps/{sorted_map_id}/items/{item_id}	Update Memory Store Sorted Map Item
POST	/cloud/v2/universes/{universe_id}/memory-store:flush	Flush Memory Store
GET	/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries	List Ordered Data Store Entries
POST	/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries	Create Ordered Data Store Entry
GET	/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}	Get Ordered Data Store Entry
DELETE	/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}	Delete Ordered Data Store Entry
PATCH	/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}	Update Ordered Data Store Entry
POST	/cloud/v2/universes/{universe_id}/ordered-data-stores/{ordered_data_store_id}/scopes/{scope_id}/entries/{entry_id}:increment	Increment Ordered Data Store Entry
GET	/cloud/v2/universes/{universe_id}/places/{place_id}	Get Place
PATCH	/cloud/v2/universes/{universe_id}/places/{place_id}	Update Place
GET	/cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}	Get Instance
PATCH	/cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}	Update Instance
GET	/cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}:listChildren	List Instance Children
POST	/cloud/v2/universes/{universe_id}/places/{place_id}/luau-execution-session-tasks	Create Luau Execution Session Task
GET	/cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions	List User Restrictions
GET	/cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions/{user_restriction_id}	Get User Restriction
PATCH	/cloud/v2/universes/{universe_id}/places/{place_id}/user-restrictions/{user_restriction_id}	Update User Restriction
POST	/cloud/v2/universes/{universe_id}/places/{place_id}/versions/{version_id}/luau-execution-session-tasks	Create Luau Execution Session Task
GET	/cloud/v2/universes/{universe_id}/places/{place_id}/versions/{version_id}/luau-execution-sessions/{luau_execution_session_id}/tasks/{task_id}	Get Luau Execution Session Task
GET	/cloud/v2/universes/{universe_id}/places/{place_id}/versions/{version_id}/luau-execution-sessions/{luau_execution_session_id}/tasks/{task_id}/logs	List Luau Execution Session Task Logs
GET	/cloud/v2/universes/{universe_id}/subscription-products/{subscription_product_id}/subscriptions/{subscription_id}	Get Subscription
GET	/cloud/v2/universes/{universe_id}/user-restrictions	List User Restrictions
GET	/cloud/v2/universes/{universe_id}/user-restrictions/{user_restriction_id}	Get User Restriction
PATCH	/cloud/v2/universes/{universe_id}/user-restrictions/{user_restriction_id}	Update User Restriction
GET	/cloud/v2/universes/{universe_id}/user-restrictions:listLogs	List User Restriction Logs
POST	/cloud/v2/universes/{universe_id}:generateSpeechAsset	Generate Speech Asset
POST	/cloud/v2/universes/{universe_id}:publishMessage	Publish Universe Message
POST	/cloud/v2/universes/{universe_id}:restartServers	Restart Universe Servers
POST	/cloud/v2/universes/{universe_id}:translateText	Translate Text
GET	/cloud/v2/users/{user_id}/asset-quotas	List Asset Quotas
POST	/cloud/v2/users/{user_id}/notifications	Create User Notification

Schemas

Other Components

API Metadata

{
  "openapi": "3.0.0",
  "info": {
    "title": "Cloud API",
    "description": "The Roblox Open Cloud v2 API. This is a subset of endpoints that Roblox\nprovides. See https://create.roblox.com/docs/cloud/open-cloud for more\ndetails.",
    "version": "2.0.1"
  },
  "servers": [
    {
      "url": "https://apis.roblox.com"
    }
  ],
  "tags": [
    {
      "name": "Cloud"
    }
  ],
  "x-categories": [
    "Data and memory stores",
    "Luau execution",
    "Monetization",
    "Universes and places",
    "Users and groups"
  ]
}