/
Remove a Guest
Remove a Guest
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
repeat | String | Reserved |
---|---|---|
retries | String | Number of times this task will be retried, in case of error |
type | String | Task type identifier. In this case, "guest_delete" |
guest_id | String | Unique identifier of the Guest |
JSON example
{ "repeat": "0", "retries": "0", "type": "guest_delete", "guest_id": "testguest" }
, multiple selections available,
Related content
Remove a Guest
Remove a Guest
More like this
Guest actions
Guest actions
More like this
Clone a guest
Clone a guest
More like this
Migrate a running Guest to another Host
Migrate a running Guest to another Host
More like this
Migrate a running Guest to another Host
Migrate a running Guest to another Host
More like this
Copy Guest
Copy Guest
More like this