Developer Documentation
Unregister VM
Released in v6.8.7Removes the virtual machine corresponding to vm from the vCenter inventory without removing any of the virtual machine’s files from storage. All high-level information stored with the management server (ESXi or vCenter) is removed, including information such as statistics, resource pool association, permissions, and alarms. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Unregister.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}?action=unregister
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the virtual machine to be unregistered. The parameter must be an identifier for the resource type: VirtualMachine. |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | action=unregister |
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | Error | com.vmware.vapi.std.errors.not_found : if there is no virtual machine associated with vm in the system. |
| 409 | Error | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine is running (powered on). | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
| default | Error | Not available |
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges. |
On This Page
VM Operations
get
post
delete
get
post
post
post
post
post
post
post
