PATCH /cloud/v2/universes/{universe_id}/places/{place_id}/instances/{instance_id} — cloud.docs

Update Instance

Updates an instance's property data.

When updating a Script instance's source property, the maximum supported property size is 200,000 bytes after UTF-8 encoding.

Endpoint

Method: PATCH

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

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.
updateMask	query	false	The list of fields to update.

[
  {
    "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": "updateMask",
    "in": "query",
    "description": "The list of fields to update.",
    "schema": {
      "type": "string",
      "format": "field-mask"
    }
  }
]

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Instance"
      }
    }
  },
  "required": true
}

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": "Update Instance",
  "description": "Updates an instance's property data.\n\nWhen updating a `Script` instance's source property, the maximum supported\nproperty size is 200,000 bytes after UTF-8 encoding.",
  "operationId": "Cloud_UpdateInstance",
  "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": "updateMask",
      "in": "query",
      "description": "The list of fields to update.",
      "schema": {
        "type": "string",
        "format": "field-mask"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Instance"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Operation"
          }
        }
      }
    }
  },
  "x-long-running-operation-parameters": {
    "metadata": {
      "$ref": "#/components/schemas/UpdateInstanceMetadata"
    },
    "response": {
      "$ref": "#/components/schemas/Instance"
    }
  },
  "x-visibility": "BETA",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "x-roblox-scopes": [
    {
      "name": "universe.place.instance:write"
    }
  ],
  "x-roblox-docs": {
    "category": "Universes and places",
    "methodProperties": {
      "scopes": [
        "universe.place.instance:write"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/Instance",
      "name": "Instance"
    }
  }
}