REST API - DELETE Retire Client

Updated

This operation retires a client.

You can retire a client (for example, a server or a laptop) in the Command Center and CommCell Console. Retiring a client with no backup data releases the license of the client, uninstalls the Commvault software on the client computer, and then deletes the client from the Commvault system.

Note: If you perform the retire operation on a client with backup data, the operation releases the license, uninstalls the Commvault software, and retains the client. Overall, the client moves to the deconfigured state and the data is still available for data restore operation until the retention parameters of the data are met.

Caution: After you retire a client, you cannot undo the retirement. To add the client to the Commvault system again, you must add it as a new client.

Request

Syntax

DELETE  <webservice>/Client/{clientId}/Retire

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 ID of the client. If the ID is not known, use the GET Client API to retrieve it.

Yes

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 details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

jobId

The ID of the job, which will retire the client.

errorString

The message for each error code. Every error code has a different error message.

response

errorCode

The possible error codes.

Valid values are:

  • 0, client will be retired by a job.

  • 1, a failure.

  • a specific error code.

response

Examples

Example Request

DELETE <webservice>/Client/89/Retire

Host: client.mydomain.com

Accept: application/json

Authtoken: QSDK 3c633bc300b7cbdcf31f918d4ce4934722d620774b81e87e543c517177302b23a0742c0b7e74bd7dc43731ca2b83fe44a43b5fcb24633fab54842eaeb8ddaa6d85674a17692ea6cd559b1d70a4f589552e59c10fc79701debf79d85cda

Example Response

{

"jobId": 18025,

"response": {

"errorString": "Client will be retired by jobid[18025]",

"errorCode": 0

}

}