GET SystemStatus/Upgrade/Status

Important! This page is no longer supported or being updated. It is left here for reference purposes. We encourage you to find corresponding information in our new API Reference documentation.

Returns the status of a Trust Protection Platform upgrade.

Requirements

  • Permissions:  The caller is not required to have any special permissions. The caller must be able to authenticate with Trust Protection Platform.
  • 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 the following message:

  • Failed to read upgrade status

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

Response description

Name

Description

UpgradeInProgress

The status of all engines:

  • true: One or more engines are currently upgrading.
  • false: No current upgrades are in progress.

Example: Show the upgrade status of all engines

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

Response

HTTP/1.1 200 OK
{
   "UpgradeInProgress":false
}