GET SystemStatus/Upgrade/History

Returns an entire history of Trust Protection Platform upgrades since 19.2.

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:

  • Failed to read upgrade history, error: [Error]
  • Grouping Id missing on upgrades root [ReadCurrentGroupingID]

Otherwise, this method returns a HTTP 200 and the following message body:

Response description

Name

Description

UpgradeHistory

An array of upgrade information for each Trust Protection Platform engine. The history is in ascending order.

  • Id: The unique GUID that identifies the upgrade.
  • StartTime: The Universal Time Coordinated (UTC) that the upgrade began for the list of versions.
  • Versions: An array of upgrades that the engine received during the same time frame. The oldest possible version is version 19.2. The Versions are in ascending order.

Example: Show upgrade information for all engines

GET https://tpp.venafi.example/vedsdk/SystemStatus/Upgrade/History
Authorization:Bearer 4MyGeneratedBearerTknz==

Response

HTTP/1.1 200 OK
{
   "UpgradeHistory":[
      {
         "Id":"bde431ec-b2d0-49bd-b2f6-7a12813026c1",
         "StartTime":"2021-07-21T09:55:03.2647483Z",
         "Versions":[
            "19.2.0.0",
            "19.3.0.0",
            "19.4.0.0",
            "20.1.0.0"
            "21.1.0.0"
         ]
      }
   ]
}