Instance

Attributes

pathstring

hasChildrenboolean

engineInstanceobject

Base URL

https://apis.roblox.com/cloud
The Instance Resource

{
"path": "string",
"hasChildren": true,
"engineInstance": {
"Id": "string",
"Parent": "string",
"Name": "string",
"Details": {
"Folder": null
}
}
}

Get Instance

GET /v2/universes/{universe}/places/{place}/instances/{instance}
Scopes
universe.place.instance:read
RequestPath Parameters
universestringRequired

placestringRequired

instancestringRequired

Response
ResponseInstanceMetadata
GET /v2/universes/{universe}/places/{place}/instances/{instance}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe}/places/{place}/instances/{instance}' \
-H 'x-api-key: {your-api-key}'

Update Instance

PATCH /v2/universes/{universe}/places/{place}/instances/{instance}
Scopes
universe.place.instance:write
RequestPath Parameters
universestringRequired

placestringRequired

instancestringRequired

Query Parameters
updateMaskstring

Request BodyInstance
Response
ResponseInstanceMetadata
PATCH /v2/universes/{universe}/places/{place}/instances/{instance}

curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe}/places/{place}/instances/{instance}?updateMask={string}' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
-d \
'{
"engineInstance": {
"Id": "string",
"Parent": "string",
"Name": "string",
"Details": {
"Folder": null
}
}
}'

List Instance Children

GET /v2/universes/{universe}/places/{place}/instances/{instance}:listChildren
Scopes
universe.place.instance:read
RequestPath Parameters
universestringRequired

placestringRequired

instancestringRequired

Query Parameters
maxPageSizenumber

pageTokenstring

Response
Response
instancesarray<Instance>

nextPageTokenstring

Metadata
GET /v2/universes/{universe}/places/{place}/instances/{instance}:listChildren

curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe}/places/{place}/instances/{instance}:listChildren?maxPageSize=100&pageToken={string}' \
-H 'x-api-key: {your-api-key}'