GET SystemStatus/Upgrade/Engines

Returns the status of a Trust Protection Platform upgrade for every engine. The data includes only current engines. If you deleted a Trust Protection Platform engine, the data may be omitted from the output. To get old data, contact Customer Support.

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

Input parameters
Name	Description
UpgradeId	(Optional) In the request URL, specify an upgrade ID from GET SystemStatus/Upgrade/History.

Returns

If an error occurs, this method returns a HTTP message and error with one of the following messages:

Failed to read engine upgrade objects, error: [Error]
Failed to read engine upgrade status, error: [Error]
Failed to read engine upgrade status, object must be of type: [ConfigClass.Names.VenafiPlatform]
Failed to read platform upgrade details, error: [Error]
Failed to read upgrade tasks, error: [Error]
Reading engine upgrade status failed, failed to lookup current grouping Id, error: [Error]

Otherwise, this method returns a HTTP 200 and an array of Engines:

Response description
Name	Description
(An array of Engines) Engine	The engine with the oldest UpgradeStopTime appears first. The description of a Trust Protection Platform engine: DN: The distinguished name (DN) of the Trust Protection Platform engine. DisplayName: The engine name that appears in the UI. Guid: The unique identifier of the engine. Id: The engine ID. Name: The computer name of the Engine.
Status	The Engine Upgrade Status.
UpgradeStartTime	The UTC start time that the upgrade began on the first engine.
UpgradeStopTime	The UTC completion time when the last engine finished the upgrade.
TasksCompleted	Appears only if there are completed upgrade tasks. An array of details about each upgrade task: DisplayName: The upgrade task name as it appears in the Upgrade dashboard. Name: The task name. StartTime: The UTC start time that the upgrade began on the first engine. StopTime: The UTC completion time when the last engine finished the upgrade. WarningCount: The number of warnings that occurred while running the task. For warning details, check the log.

Example: For an upgrade, list all engine information

GET https://tpp.venafi.example/vedsdk/SystemStatus/Upgrade/Engines?upgradeId=bde431ec-b2d0-49bd-b2f6-7a12813026c1
Authorization:Bearer 4MyGeneratedBearerTknz==

Response

HTTP/1.1 200 
{
   "Engines":[
      {
         "Engine":{
            "DN":"\\VED\\Engines\\WIN-MLK71Q10559",
            "DisplayName":"WIN-MLK71Q10559",
            "Guid":"{7ebf2b04-dd12-4c0b-b9ab-3ccedf9b5a4a}",
            "Id":11,
            "Name":"WIN-MLK71Q10559"
         },
         "Status":"Upgrade Complete",
         "UpgradeStartTime":"2020-02-18T22:56:42.0000000Z",
         "UpgradeStopTime":"2020-02-18T23:08:47.0000000Z",
         "TasksCompleted":[
            {
               "DisplayName":"Update Script Target Stage Check",
               "Name":"Update Script Target Stage Check",
               "StartTime":"2020-02-18T22:56:42.0000000Z",
               "StopTime":"2020-02-18T22:56:42.0000000Z",
               "WarningCount":0
            },
            {
               "DisplayName":"19.2 Authorized users report initial calculation",
               "Name":"19.2 Authorized users report initial calculation",
               "StartTime":"2020-02-18T22:56:42.0000000Z",
               "StopTime":"2020-02-18T22:56:43.0000000Z",
               "WarningCount":0
            }
         ]    ...
      },
      {
         "Engine":{
            "DN":"\\VED\\Engines\\WIN-MLK71Q10559-2",
            "DisplayName":"WIN-MLK71Q10559-2",
            "Guid":"{9b656d8f-7b2e-433c-a1ce-ab558aa07251}",
            "Id":329,
            "Name":"WIN-MLK71Q10559-2"
         },
         "Status":"Upgrade Complete",
         "UpgradeStartTime":"2020-02-18T22:55:07.0000000Z",
         "UpgradeStopTime":"2020-02-18T23:10:11.0000000Z",
         "TasksCompleted":[
            {
               "DisplayName":"Update Script Target Stage Check",
               "Name":"Update Script Target Stage Check",
               "StartTime":"2020-02-18T22:55:07.0000000Z",
               "StopTime":"2020-02-18T22:55:07.0000000Z",
               "WarningCount":0
            },
            {
               "DisplayName":"19.2 Authorized users report initial calculation",
               "Name":"19.2 Authorized users report initial calculation",
               "StartTime":"2020-02-18T22:58:07.0000000Z",
               "StopTime":"2020-02-18T22:58:07.0000000Z",
               "WarningCount":0
            }
         ]    ...
      }
   ]
}