Skip to main content

​
Description

Removes a specific attribute from an instance. Internally sets the attribute to nil.

​
Endpoint

delete_attribute

​
Parameters

​
path
string
required
The path to the instance (e.g., “Workspace.Part” or “ReplicatedStorage.Config”)
​
name
string
required
The name of the attribute to delete

​
Response

​
ok
boolean
Returns true if the attribute was deleted successfully
​
error
string
Error message if the instance path could not be resolved

​
Examples

​
Delete an attribute

{
  "path": "Workspace.Part",
  "name": "Description"
}
Response: 
{
  "ok": true
}

​
Delete a non-existent attribute

Deleting a non-existent attribute still returns success: 
{
  "path": "Workspace.Part",
  "name": "NonExistent"
}
Response: 
{
  "ok": true
}

​
Error handling

{
  "path": "Workspace.InvalidPath",
  "name": "SomeAttribute"
}
Response: 
{
  "error": "Instance not found: Workspace.InvalidPath"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us