Retire Multiple Clients

This operation releases the licenses and uninstalls the Commvault software on list of clients. 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

application/json

Request Body

• association object

  entity object[]

  clientName string

  clientId integer

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• jobId integer
• response object

  errorString string

  errorCode integer

{
  "jobId": 0,
  "response": {
    "errorString": "string",
    "errorCode": 0
  }
}

PUT /clients/retire    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• Example 1

---

{
  "association": {
    "entity": [
      {
        "clientName": "string",
        "clientId": 0
      }
    ]
  }
}

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/Clients/retire' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "clientName": "string",
        "clientId": 0
      }
    ]
  }
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/Clients/retire' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "clientName": "string",
        "clientId": 0
      }
    ]
  }
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/Clients/retire' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "clientName": "string",
        "clientId": 0
      }
    ]
  }
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/Clients/retire' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "clientName": "string",
        "clientId": 0
      }
    ]
  }
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/Clients/retire' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "clientName": "string",
        "clientId": 0
      }
    ]
  }
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/Clients/retire' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "clientName": "string",
        "clientId": 0
      }
    ]
  }
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/Clients/retire' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "association": {
    "entity": [
      {
        "clientName": "string",
        "clientId": 0
      }
    ]
  }
}'