Remove a Guest

Owned by Javier Celaya (Unlicensed)
Last updated: Sept 25, 2018
1 min read

Note: Only Guests in stopped state can be removed

Format

MethodPOST
URL

/tasks/create

Request contentGuestDelete Object
Successful answerTaskResult Object
Unexpected errorHTTP 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

typeStringTask type identifier. In this case, "guest_delete"
guest_idStringUnique identifier of the Guest

JSON example

{
    "type": "guest_delete",
    "guest_id": "testguest"
}