plugin_uninstall
Remove a plugin completely. The server unloads it and deletes its folder, including plugin.json, main.js, its stored data, and its files/ folder. To keep the plugin but stop it, use plugin_disable instead.
Request
Section titled “Request”{ "cmd": "plugin_uninstall", "name": "hello"}| Field | Type | Required | Description |
|---|---|---|---|
name |
string | Yes | Name of an installed plugin. |
Response
Section titled “Response”{ "cmd": "plugin_uninstall", "val": true}If the plugin had slash commands loaded, every authenticated connection receives slash_remove with them. The removal is recorded in the audit log.
Permissions
Section titled “Permissions”Requires manage_server. It is blocked while you are timed out.
Errors
Section titled “Errors”val |
When |
|---|---|
Invalid plugin name |
name has characters other than letters, digits, _, and -. |
Plugin '<name>' is not installed |
There is no folder with that name. |
Unable to remove plugin directory |
The server couldn’t delete the whole folder. The plugin keeps running, though some of its files may already be gone. |
| Validation message | name is missing, blank, or longer than 64 characters. |