Retire Client Packages

Selectively uninstall packages from given client

Path Parameters

• clientId string required

application/json

Request Body

• retireClient boolean
• packages object[]

  id int32

  name string

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• jobId int32
• error object

  errorMessage string

  errorCode int32

{
  "jobId": 0,
  "error": {
    "errorMessage": "string",
    "errorCode": 0
  }
}

PUT /v4/client/:clientid/retire    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

clientId — path required

Body

• Default
• RetireTwoPackages

---

{
  "retireClient": true,
  "packages": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}

curl -L -X PUT 'https://localhost/webconsole/api/V4/Client/:clientId/Retire' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "retireClient": true,
  "packages": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/Client/:clientId/Retire' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "retireClient": true,
  "packages": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/Client/:clientId/Retire' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "retireClient": true,
  "packages": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/Client/:clientId/Retire' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "retireClient": true,
  "packages": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/Client/:clientId/Retire' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "retireClient": true,
  "packages": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/Client/:clientId/Retire' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "retireClient": true,
  "packages": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/Client/:clientId/Retire' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "retireClient": true,
  "packages": [
    {
      "id": 0,
      "name": "string"
    }
  ]
}'