Retire Client

⚠️ Caution

This operation releases the licenses and uninstalls the CommVault software on the client. If no client backup data exists in the ContentStore, then it is deleted. Otherwise, the client is set to a deconfigured state for restore purposes.

More Details

Path Parameters

• clientId string required

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• processinginstructioninfo object

  attributes object[]

  name string

  value string
• response object

  errorString string

  errorCode integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": {
    "errorString": "string",
    "errorCode": 0
  }
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": {
    "errorString": "Success",
    "errorCode": 0
  }
}

DELETE /client/:clientid/retire    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

clientId — path required

curl -L -X DELETE 'https://CommandCenterHostName/commandcenter/api/Client/:clientId/Retire' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X DELETE 'https://CommandCenterHostName/commandcenter/api/Client/:clientId/Retire' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X DELETE 'https://CommandCenterHostName/commandcenter/api/Client/:clientId/Retire' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X DELETE 'https://CommandCenterHostName/commandcenter/api/Client/:clientId/Retire' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X DELETE 'https://CommandCenterHostName/commandcenter/api/Client/:clientId/Retire' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X DELETE 'https://CommandCenterHostName/commandcenter/api/Client/:clientId/Retire' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X DELETE 'https://CommandCenterHostName/commandcenter/api/Client/:clientId/Retire' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'