This operation deletes a client.
Caution
This operation also deletes any backup data that is associated with the client.
Request
Syntax
DELETE <webservice>/Client/{clientId} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Parameters
|
Name |
Description |
Required |
|---|---|---|
|
clientId |
The client ID for the client. If the client ID is not known, use the GET Client API to retrieve it. |
Yes |
|
forceDelete |
The option to delete the client from the Commvault system, even if it is not retired. Valid values are:
|
No |
Request Headers
|
Name |
Description |
|---|---|
|
Host |
The host name of the Web Server or Web Console used in the API request. |
|
Accept |
The format of the response. Valid values are: application/xml or application/json. |
|
Authtoken |
The authentication token received after successfully logging on. For information about receiving an authentication token, see Authentication. |
Response
Response Parameters
|
Parameter |
Description |
Element |
|---|---|---|
|
errorCode |
The possible error codes. Valid values are:
|
response |
|
warningCode |
The possible warning codes. Valid values are:
|
response |
Examples
Example Request
DELETE <webservice>/Client/6 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8
Example Response
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_DeleteClientResponse>
<response errorCode="0" warningCode="0"/>
</App_DeleteClientResponse>