Get Platform Upgrade Options

API to get eligibility for install job option at different entity level

Query Parameters

• option int32

  Specify the entity level for which to fetch install jobs options. Accepted values [ 2 = Client, 3 = Client Group, 4 = Commcell]

• clientId int32

  Id of the client or client group for which to fetch install job options

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• option int32
• clientId int32
• MSSQLPatching int32
• WindowsPatching int32
• UnixOSPatching int32
• HyperScaleOSPatching int32
• HSXStorageUpdatesPatching int32
• DiagsInCSCache int32
• EligibleForMSSQLPatching int32
• EligibleForWindowsOSPatching int32

{
  "option": 0,
  "clientId": 0,
  "MSSQLPatching": 0,
  "WindowsPatching": 0,
  "UnixOSPatching": 0,
  "HyperScaleOSPatching": 0,
  "HSXStorageUpdatesPatching": 0,
  "DiagsInCSCache": 0,
  "EligibleForMSSQLPatching": 0,
  "EligibleForWindowsOSPatching": 0
}

GET /v4/platformupgrade/options    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

option — query

clientId — query

curl -L -X GET 'https://localhost/webconsole/api/V4/PlatformUpgrade/Options' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/PlatformUpgrade/Options' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/PlatformUpgrade/Options' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/PlatformUpgrade/Options' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/PlatformUpgrade/Options' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/PlatformUpgrade/Options' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'

curl -L -X GET 'https://localhost/webconsole/api/V4/PlatformUpgrade/Options' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'