Delete Machine

Delete Machine

Deletes the machine.

Request
URI
DELETE
https://{api_host}//localhost/rest/inventory/v1/machines/{id}
COPY
Path Parameters
string
id
Required

id


Request Body

The specification applicable to deleting the machine.

MachineDeleteData of type(s) application/json
Required
{
    "allow_delete_from_multi_desktop_pools": true,
    "archive_datastore_id": "855ea6c5-720a-41e1-96f4-958c90e6e424",
    "archive_datastore_path_id": "a219420d-4799-4517-8f78-39c74c7c4efc",
    "archive_persistent_disk": true,
    "delete_from_disk": true,
    "force_logoff_session": true
}
boolean
allow_delete_from_multi_desktop_pools
Optional

Determines whether the machines from different desktop pools can be deleted. This defaults to false in which case only machines belonging to single desktop pool can be deleted. If true, machines from different desktop pools can be deleted.

string
archive_datastore_id
Optional

Determines the datastore where the persistent user disk will be saved for future use. Both this as well as the archiveDatastorePathId need to be set. If this is unset and archivePersistentDisk is specified, the persistent disk is archived in place.

string
archive_datastore_path_id
Optional

Determines the location in the datastore where the persistent user disk will be saved for future use. If this is set, then archiveDatastoreId also needs to be specified.If this is unset and archivePersistentDisk is specified, the persistent disk is archived in place.

boolean
archive_persistent_disk
Optional

Determines whether to detach the persistent user disk and save it for future use. This can only be specified for linked-clone desktops with redirectWindowsProfile enabled, in which case it defaults to true.

boolean
delete_from_disk
Optional

Determines whether the Machine VM should be deleted from vCenter Server. This is only applicable for managed machines. This must always be true for machines in linked and instant clone desktops. This defaults to true for linked and instant clone machines and false for all other types. If this is true, then machine being deleted must not have any active user session, otherwise delete operation would fail.

boolean
force_logoff_session
Optional

Determines whether active session on the machine to be logged off before deletion. This is only applicable for managed machines. If true, active session on the machine will be logged off before Machine delete. Otherwise,it will result in an exception.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

400

Bad Request

Operation doesn't return any data structure

401

User is not authenticated

Operation doesn't return any data structure