delete_desktop_pool
Permanently delete a desktop pool and all its machines via the Horizon REST API. Terminates active user sessions, so confirm affected pools and sessions before calling.
Instructions
Delete a desktop pool and all of its machines.
CAUTION: This is irreversible. All machines in the pool are deleted and any active user sessions are terminated. Always confirm with the user before calling this.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"pool_id": "<pool_id>"
},
"name": "delete_desktop_pool"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | No | Only used when the server runs with HORIZON_CONFIRMATION=flag (clients without elicitation). Otherwise the user is asked to confirm directly in the client. Before deleting, call get_desktop_pool and list_sessions (filtered by desktop_pool_id) so you can tell the user what will be affected. | |
| pool_id | Yes | Desktop pool ID — obtain from list_desktop_pools |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||