GET /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}:listChildren — cloud.docs

List Instance Children

Lists an instance's children.

The maximum supported response data size is 500,000 bytes. If this limit is exceeded, the returned Operation will be completed with an error result that has an error code of 422.

Endpoint

Method: GET

Path: /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id}:listChildren

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.
place_id	path	true	The place ID.
instance_id	path	true	The instance ID.
maxPageSize	query	false	The maximum number of child instance to return. The service may return fewer than this value. If unspecified, at most 200 children will be returned. The maximum value is 200; values above 200 will be coerced to 200.
pageToken	query	false	A page token, received from a previous `ListInstanceChildrenRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListInstanceChildrenRequest` must match the call that provided the page token.

[
  {
    "name": "universe_id",
    "in": "path",
    "description": "The universe ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "place_id",
    "in": "path",
    "description": "The place ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "instance_id",
    "in": "path",
    "description": "The instance ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "maxPageSize",
    "in": "query",
    "description": "The maximum number of child instance to return. The service may return\nfewer than this value. If unspecified, at most 200 children will be\nreturned. The maximum value is 200; values above 200 will be coerced to\n200.",
    "schema": {
      "type": "integer",
      "format": "int32"
    },
    "examples": {
      "maxPageSize": {
        "description": "An integer between 1 and 200, inclusive",
        "value": 100
      }
    }
  },
  {
    "name": "pageToken",
    "in": "query",
    "description": "A page token, received from a previous `ListInstanceChildrenRequest` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to\n`ListInstanceChildrenRequest` must match the call that provided the page\ntoken.",
    "schema": {
      "type": "string"
    }
  }
]

Responses

Status	Description
200	OK

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Operation"
        }
      }
    }
  }
}

Authentication

{
  "security": [],
  "securitySchemes": {}
}

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "List Instance Children",
  "description": "Lists an instance's children.\n\nThe maximum supported response data size is 500,000 bytes. If this limit is\nexceeded, the returned `Operation` will be completed with an error result\nthat has an error code of `422`.\n\n",
  "operationId": "Cloud_ListInstanceChildren",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "place_id",
      "in": "path",
      "description": "The place ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "instance_id",
      "in": "path",
      "description": "The instance ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "maxPageSize",
      "in": "query",
      "description": "The maximum number of child instance to return. The service may return\nfewer than this value. If unspecified, at most 200 children will be\nreturned. The maximum value is 200; values above 200 will be coerced to\n200.",
      "schema": {
        "type": "integer",
        "format": "int32"
      },
      "examples": {
        "maxPageSize": {
          "description": "An integer between 1 and 200, inclusive",
          "value": 100
        }
      }
    },
    {
      "name": "pageToken",
      "in": "query",
      "description": "A page token, received from a previous `ListInstanceChildrenRequest` call.\nProvide this to retrieve the subsequent page.\n\nWhen paginating, all other parameters provided to\n`ListInstanceChildrenRequest` must match the call that provided the page\ntoken.",
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Operation"
          }
        }
      }
    }
  },
  "x-long-running-operation-parameters": {
    "metadata": {
      "$ref": "#/components/schemas/ListInstanceChildrenMetadata"
    },
    "response": {
      "$ref": "#/components/schemas/ListInstanceChildrenResponse"
    }
  },
  "x-visibility": "BETA",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "x-roblox-scopes": [
    {
      "name": "universe.place.instance:read"
    }
  ],
  "x-roblox-docs": {
    "category": "Universes and places",
    "methodProperties": {
      "scopes": [
        "universe.place.instance:read"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/Instance",
      "name": "Instance"
    }
  }
}