Away 7:50 PM

1 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

Instance — openapi

Represents a data model instance.

Properties

NameTypeRequiredDescription
pathstringfalseThe resource path of the instance. Format: universes/{universe_id}/places/{place_id}/instances/{instance_id}
hasChildrenbooleanfalsewhether the instance has any children instance
engineInstance#/components/schemas/roblox.engine.Instancefalsethe property details of the instance

Complete Schema

{
  "type": "object",
  "properties": {
    "path": {
      "example": "universes/123/places/123/instances/0123456789abcdef0123456789abcdef",
      "type": "string",
      "description": "The resource path of the instance.\n\nFormat: `universes/{universe_id}/places/{place_id}/instances/{instance_id}`"
    },
    "hasChildren": {
      "readOnly": true,
      "example": true,
      "type": "boolean",
      "description": "whether the instance has any children instance"
    },
    "engineInstance": {
      "$ref": "#/components/schemas/roblox.engine.Instance",
      "description": "the property details of the instance"
    }
  },
  "description": "Represents a data model instance.",
  "x-aep-resource": {
    "patterns": [
      "universes/{universe_id}/places/{place_id}/instances/{instance_id}"
    ],
    "plural": "instances",
    "singular": "instance"
  },
  "x-resource": true
}