delete_virtual_client

(DELETE)/virtual_clients/{id}

Description

Delete the virtual client on the specified system with the specified id.

Request

Syntax

DELETE /api/virtual_clients/{id}/?sid={sid}
Host: <server host name>
Accept: application/json
AuthToken: <authentication token returned from authenticate>

Parameters

Name	Description	Type	Required
id	The ID of the virtual client we want to delete which may be appended with '.wir', '.vm_ir' or '.hv_ir'	long or string	Yes
sid	The system ID on which the virtual client is located	long	Yes
type	"wir" or "hv_ir" or "vm_ir"	string	Yes
deleteFromHypervisor	flag which indicates if the VM should be deleted from the hypervisor	0 or 1	Yes, if type=wir
force **	flag which indicates if the VM should be forcefully deleted from the vCenter/Hyper-V server	0 or 1	Optional; applicable in case of type=vm_ir or hv_ir

Response

Status code, Status string

Parameters

Examples

Sample Request

DELETE /api/virtual_clients/12/?sid=3
DELETE /api/virtual_clients/12.wir/?sid=3
Host: <server host name>
Accept: application/json
AuthToken: 8a00sjerhterqerjlqkjlk443l4j56869h4f_)(fjdkasHHHHHkdal324

{
  "type": "wir",
  "deleteFromHypervisor": 1
}

Sample Response

200 Success

** applicable for release 9.2