Venafi System Status APIs API
The SystemStatus interface provides status and upgrade information about Trust Protection Foundation engines. This information also appears in the UI.# Engine Upgrade StatusEngineUpgradeState describes the following Trust Protection Foundation upgrade statuses:* _Upgrade Complete_: The upgrade completed on all Trust Protection Foundation engines.* _Upgrade Blocked_: One or more dependency tasks prevented the upgrade from completing.* _Upgrade In Error_: The upgrade encountered an error.* _Upgrade Running_: The upgrade is to a newer version is in progress.* _Upgrade Pending Install_: The numbers of engines that still have a previous version of Trust Protection Foundation. An upgrade is required.# Service StatusThe Service status describes engine availability: * _Down_: The service is deemed unavailable for operations. The service is considered down if the TimeSinceLastSeen is greater than six minutes. When Demo mode is enabled to allow updates every 30 seconds, the service is considered down if TimeSinceLastSeen is greater than 45 seconds.* _New_: The vPlatform service never detected operations for this service. The corresponding timeSinceFirstSeen and TimeSinceLastSeen values are also empty.* _Unknown_: The IIS status is unknown because the vPlatform service is not currently available to report the status.* _Up_: The service is deemed available for operations. The service is considered up if the TimeSinceLastSeen is less than six minutes. When Demo mode is enabled to allow updates every 30 seconds, the service is considered up if TimeSinceLastSeen is less than 45 seconds.# Upgrade Status Summary Details objectThe UpgradeSummary object describes the status of a Trust Protection Foundation upgrade:* _Status_: The Engine Upgrade Status.* _StatusDetails_: Appears only when an upgrade is blocked, in error, or pending installation. Additional information about the upgrade.* _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.* _CompletedTasks_: The total number of upgrade task across all engines.* _OriginVersion_: Appears on any upgrades that occur after 20.1. For example, if you are upgrading to 20.1 or higher for the first time, the value is omitted. The starting point version prior to Trust Protection Foundation upgrades.* _TargetVersion_: The intended Trust Protection Foundation version.* _RemainingTasks_: Appears only when additional upgrade tasks are present.* _EnginesComplete_: The number of engines that successfully completed the upgrade.* _EnginesRunning_: The number of engines that are currently upgrading.* _EnginesBlocked_: The number of engines blocked by other upgrade tasks or dependencies.* _EnginesInError_: The number of engines that are in a failed state. These engines retry every three minutes.* _EnginesPendingInstall_: The number of engines that still have a previous version of Trust Protection Foundation installed. An upgrade is required.
Venafi System Status APIs API is one of 58 APIs that Venafi publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include System Status APIs. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 9 operations across 9 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 26.1.1.
Requests are made against 3 base URLs: /, https://REPLACEdnsnameME/, https://{dnsname}/.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Venafi System Status APIs API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (AccessToken).
By default, every request must be authenticated.
Paths & Operations 9
Across 9 paths, the API surfaces 9 operations — 9 GET. Each is listed below with its method, path, parameters, and response codes.
The SystemStatus interface provides status and upgrade information about Trust Protection Foundation engines.
Schemas 8
The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Core_WebSDK_Obsolete_EngineUpgradeResponse_Upgrade_Engines (2 properties), Core_WebSDK_Obsolete_EngineUpgradeResponse_Upgrade_Engine (2 properties), Web_SDK_Authentication_OAuthError (2 properties), Core_WebSDK_Obsolete_GroupingIdsResposne (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Venafi 12
Other APIs Venafi publishes across the network.
This is an independent, third-party profile of Venafi System Status APIs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.