GET SystemStatus/Upgrade/Summary
Returns details about the most recent Trust Protection Platform upgrade.
Requirements
- Permissions: The caller must have View permission or Read permission to the engine root.
- Token scope: Any valid scope, such as Agent, Certificate, or SSH
Headers
-
Content type: Content-Type:application/json.
- Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.
Parameters
None
Returns
If an error occurs, this method returns a HTTP message and error with one of the following messages:
-
An error message.
-
Failed to lookup config object with id [ID], error: [Config.Error]
-
Failed to read engine upgrade status, error: [Error]
-
Failed to read upgrade status
-
Failed to read upgrade summary, error: [Error]
-
Failed to read Upgrades Root attributes, error: [Error]
-
Failed to read Upgrades Root attributes, error: [Error]
-
Grouping Id missing on upgrades root
Otherwise, this method returns a HTTP 200 and the following message body:
Name |
Description |
---|---|
UpgradeSummary |
Example: Show details about the upgrade
GET https://tpp.venafi.example/vedsdk/SystemStatus/Upgrade/Summary Authorization:Bearer 4MyGeneratedBearerTknz==
Response
HTTP/1.1 200 OK
{ "UpgradeSummary":{ "Status":"Upgrade Complete", "UpgradeStartTime": "2021-06-09T17:24:27.0000000Z", "UpgradeStopTime": "2021-06-09T17:24:29.0000000Z", "CompletedTasks": 3, "TargetVersion": "21.2.0.0", "EnginesComplete": 1, "EnginesRunning": 0, "EnginesBlocked": 0, "EnginesInError": 0, "EnginesPendingInstall": 0 } }