# Venafi System Status APIs API **Canonical:** https://apis.io/apis/venafi/venafi-system-status-apis-api/ **Provider:** Venafi — https://apis.io/providers/venafi/ **Base URL:** https://api.venafi.cloud **Documentation:** https://developer.venafi.com/tlsprotectcloud/reference/tls-protect-overview Venafi System Status APIs API is one of 58 APIs that [Venafi](https://apis.io/providers/venafi/) publishes on the [APIs.io](https://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. The SystemStatus interface provides status and upgrade information about Trust Protection Foundation engines. This information also appears in the UI. # Engine Upgrade Status EngineUpgradeState 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 Status The 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 object The 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. ## Operations (9) | Method | Path | Summary | |---|---|---| | GET | `/vedscim/{owner}/available` | Get provider-specific SCIM endpoint status | | GET | `/vedscim/available` | Get SCIM Server endpoint status | | GET | `/vedsdk/SystemStatus/` | Get all engines | | GET | `/vedsdk/SystemStatus/Version` | Get engine schema version | | GET | `/vedsdk/SystemStatus/Upgrade/Status` | Get upgrade status | | GET | `/vedsdk/SystemStatus/Upgrade/Summary` | Get upgrade summary | | GET | `/vedsdk/SystemStatus/Upgrade/Engine` | Get the upgrade status of one engine | | GET | `/vedsdk/SystemStatus/Upgrade/Engines` | Get all engine upgrade statuses | | GET | `/vedsdk/SystemStatus/Upgrade/History` | Get upgrade history | ## Machine-readable artifacts (4) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/venafi/refs/heads/main/openapi/venafi-system-status-apis-api-openapi.yml - **Documentation** — https://developer.venafi.com/tlsprotectcloud/reference/tls-protect-overview - **Webhooks** — https://raw.githubusercontent.com/api-evangelist/venafi/refs/heads/main/asyncapi/venafi-certificate-manager-saas-webhooks.yml - **Documentation** — https://docs.venafi.com/Docs/currentSDK/TopNav/Content/SDK/WebSDK/cco-sdk-GettingStarted.php ## Other Venafi APIs (12) - [Venafi Access Management APIs API](https://apis.io/apis/venafi/venafi-access-management-apis-api/) - [Venafi AlgorithmSelector APIs API](https://apis.io/apis/venafi/venafi-algorithmselector-apis-api/) - [Venafi Application API](https://apis.io/apis/venafi/venafi-application-api/) - [Venafi Authentication Server APIs API](https://apis.io/apis/venafi/venafi-authentication-server-apis-api/) - [Venafi Certificate Approvals API](https://apis.io/apis/venafi/venafi-certificate-approvals-api/) - [Venafi Certificate Auto-renewal Monitoring API](https://apis.io/apis/venafi/venafi-certificate-auto-renewal-monitoring-api/) - [Venafi Certificate Discovery API](https://apis.io/apis/venafi/venafi-certificate-discovery-api/) - [Venafi Certificate Expiration Reports API](https://apis.io/apis/venafi/venafi-certificate-expiration-reports-api/) - [Venafi Certificate Import API](https://apis.io/apis/venafi/venafi-certificate-import-api/) - [Venafi Certificate Installations API](https://apis.io/apis/venafi/venafi-certificate-installations-api/) - [Venafi Certificate Inventory Monitoring API](https://apis.io/apis/venafi/venafi-certificate-inventory-monitoring-api/) - [Venafi Certificate Management APIs API](https://apis.io/apis/venafi/venafi-certificate-management-apis-api/) ## Tags System Status APIs --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/venafi/venafi-system-status-apis-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/venafi/.