Remove a Guest
- Javier Celaya (Unlicensed)
Owned by Javier Celaya (Unlicensed)
Note: Only Guests in stopped state can be removed
Format
| Method | POST |
|---|---|
| URL | /tasks/create |
| Request content | GuestDelete Object |
| Successful answer | TaskResult Object |
| Unexpected error | HTTP 500 |
Disk images associated to cloned guests are implicitly deleted when removing the clone. Disk images associated to templates or regular guests have to be explicitly deleted.
GuestDelete Object
Schema
| type | String | Task type identifier. In this case, "guest_delete" |
|---|---|---|
| guest_id | String | Unique identifier of the Guest |
JSON example
{
"type": "guest_delete",
"guest_id": "testguest"
}