You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en-us/cloud/index.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,18 +5,18 @@ description: Get comprehensive API reference documentation for Open Cloud.
5
5
6
6
With Open Cloud, you can access Roblox resources through standard REST APIs, which lets you build everything from command line automation tools to complex web apps. The Open Cloud APIs support HTTPS and use [API keys](./auth/api-keys.md) or [OAuth 2.0](./auth/oauth2-overview.md) for authentication. You can update experiences, restart servers, work with your data stores and memory stores, manage user restrictions, list inventory items, and much, much more.
7
7
8
-
## About the APIs
8
+
## About this reference
9
9
10
-
Roblox has four categories of HTTP REST API:
10
+
This reference documentation is broken into two sections:
11
11
12
-
- Open Cloud v2
13
-
- Open Cloud v1
14
-
-[Legacy with API key and/or OAuth 2.0 authentication](legacy.md)
15
-
-[Legacy with cookie authentication](legacy.md)
12
+
- A [feature-based section](features/accounts.md) that categorizes APIs by use case (Avatars, Game Passes, Users, etc.).
13
+
- A [section that separates endpoints by system](/cloud/reference/DataStore#List-Data-Stores) (Open Cloud v2, v1, or legacy).
16
14
17
-
Whenever possible, use Open Cloud v2, Open Cloud v1, or legacy endpoints that support API key and/or OAuth 2.0 authentication. These APIs have strong stability guarantees and regularly add new resources.
15
+
**Both sections** contain the full list of available API endpoints; use whichever helps you find what you need.
18
16
19
-
Legacy API endpoints with cookie authentication can incorporate breaking changes without notice and have minimal stability guarantees. We don't recommend them for production applications.
17
+
Whenever possible, use Open Cloud v2, Open Cloud v1, or [legacy endpoints that support API key and/or OAuth 2.0 authentication](legacy.md). These APIs have strong stability guarantees and regularly add new resources.
18
+
19
+
Legacy API endpoints with cookie authentication can incorporate breaking changes without notice and have minimal stability guarantees. We don't recommend them for production applications. The legacy API has been known by various names over the years, including the Roblox site API, the web API, and the classic API.
20
20
21
21
<Alertseverity="info">
22
22
Roblox also offers [webhooks](./webhooks/webhook-notifications.md), which can notify your applications when certain events occur, such as refunds or changes to subscriptions.
Copy file name to clipboardExpand all lines: content/en-us/cloud/reference/patterns.md
+27-6Lines changed: 27 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ This page covers common patterns with the Open Cloud APIs, particularly around m
7
7
8
8
## Paths
9
9
10
-
To make a request to the Open Cloud APIs, you must first form a URL. This URL is a combination of the base URL (`https://apis.roblox.com/cloud/v2`), the Open Cloud API path (for example, `/universes/{universe-id}/places/{place-id}/user-restrictions`), and any query parameters (for example, `?maxPageSize=25`). A full request URL might look like this:
10
+
To make a request to the Open Cloud APIs, you must first form a URL. This URL is a combination of the base URL (`https://apis.roblox.com/cloud/v2`), the Open Cloud API path (for example, `/universes/{universe_id}/places/{place_id}/user-restrictions`), and any query parameters (for example, `?maxPageSize=25`). A full request URL might look like this:
@@ -17,8 +17,8 @@ Many paths, including the example above, have **path parameters**, designated by
17
17
18
18
Some resources have multiple path patterns, visible under the **Resource Paths** header in the API reference. For example, the URL for [List User Restrictions](/cloud/reference/UserRestriction#List-User-Restrictions) can be either of the following:
You can probably infer the difference between the two: some user restrictions apply to an entire universe (experience), whereas others apply to specific places within a universe. Aside from the small addition to the path and extra path parameter, the calls are identical.
24
24
@@ -34,7 +34,7 @@ If you specify `maxPageSize` in your request, some methods return paginated
34
34
results—essentially partial responses:
35
35
36
36
```json
37
-
GET /cloud/v2/users/{userId}/inventory-items?maxPageSize=25
37
+
GET /cloud/v2/users/{user_id}/inventory-items?maxPageSize=25
38
38
39
39
{
40
40
"inventoryItems": [
@@ -44,12 +44,23 @@ GET /cloud/v2/users/{userId}/inventory-items?maxPageSize=25
44
44
}
45
45
```
46
46
47
+
```json
48
+
GET /cloud/v2/universes/{universe_id}/data-stores?maxPageSize=25
49
+
50
+
{
51
+
"dataStores": [
52
+
...
53
+
],
54
+
"nextPageToken": "datastore1"
55
+
}
56
+
```
57
+
47
58
If a response includes a value for `nextPageToken`, use that value in the
48
59
`pageToken` parameter of the subsequent request to retrieve the next page. When
49
-
`nextPageToken` is empty, you've reached the end of your results:
60
+
`nextPageToken` is empty or omitted entirely, you've reached the end of your results:
50
61
51
62
```json
52
-
GET /cloud/v2/users/{userId}/inventory-items?maxPageSize=25&pageToken=aaaBBB
63
+
GET /cloud/v2/users/{user_id}/inventory-items?maxPageSize=25&pageToken=aaaBBB
53
64
54
65
{
55
66
"inventoryItems": [
@@ -59,6 +70,16 @@ GET /cloud/v2/users/{userId}/inventory-items?maxPageSize=25&pageToken=aaaBBB
59
70
}
60
71
```
61
72
73
+
```json
74
+
GET /cloud/v2/universes/{universe_id}/data-stores?maxPageSize=25&pageToken=datastore1
75
+
76
+
{
77
+
"dataStores": [
78
+
...
79
+
]
80
+
}
81
+
```
82
+
62
83
Aside from the `pageToken`, you must use the same query for pagination to work
63
84
properly. Altering any filter parameter results in a 400 error.
Copy file name to clipboardExpand all lines: content/en-us/includes/studio/controller-emulator.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
title: include
3
3
---
4
4
5
-
The **Controller Emulator** lets you accurately emulate gamepad input directly in Studio. The default controller is a generic gamepad but you can select alternatives for PlayStation, Xbox, and Quest devices from the upper‑left picker menu.
5
+
The **Controller Emulator** lets you accurately emulate gamepad input directly in Studio. The default controller is a generic gamepad, but you can select alternatives for PlayStation, Xbox, and Quest devices from the upper‑left picker menu.
6
6
7
7
<imgsrc="../../assets/studio/general/Test-Tab-Emulation-Controllers.png"width="840"alt="Emulate Device Controllers button indicated in Test tab" />
Copy file name to clipboardExpand all lines: content/en-us/includes/studio/device-emulator.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,10 +2,10 @@
2
2
title: include
3
3
---
4
4
5
-
The **Device Emulator** lets you emulate various devices directly in Studio, providing insight on how controls operate on a mobile device or how [on-screen UI](../../ui/on-screen-containers.md)displays on different screens and aspect ratios.
5
+
The **Device Emulator** lets you emulate various devices directly in Studio, providing insight into how controls work on mobile devices, consoles, and VR headsets, as well as how [on-screen UI](../../ui/on-screen-containers.md)elements display on different screen resolutions and aspect ratios.
6
6
7
7
<imgsrc="../assets/studio/general/Test-Tab-Emulation-Device.png"width="800"alt="Device button indicated in Test tab" />
8
8
9
-
In emulation mode, you can select devices from the **device selector** dropdown menu above the 3D viewport to emulate less powerful devices and test [streaming-enabled](../../workspace/streaming.md) experiences where 3D content dynamically loads/unloads based on available memory. You can also adjust the **view size** and change the **orientation** between landscape and portrait modes.
9
+
In emulation mode, you can select devices from the **device selector** dropdown menu above the 3D viewport to emulate less powerful devices and test [streaming-enabled](../../workspace/streaming.md) experiences where 3D content dynamically loads and unloads based on available memory. You can also adjust the **view size** and change the **orientation** between landscape and portrait modes.
10
10
11
11
<imgsrc="../assets/studio/general/Editor-Window-Emulation-Options.png"width="840"alt="Emulation options above the 3D viewport" />
0 commit comments