GET SystemStatus

Returns service module settings and statuses for Trust Protection Platform, Log server, and Trust Protection Platform services that run on Microsoft Internet Information Services (IIS). For example, the SystemStatus call can show you the amount of service module up time or down time for each engine. The status information also appears on the System Status dashboard.

Requirements

Permissions: The caller must have View permission AND 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 an HTTP 400 and the following messages:

Object Does NotExist.
The object does not exist or you do not have permissions to the object.

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

Response description
Name	Description
HTTP 200	For valid requests, this this method returns a HTTP 200 message and the following data in the message body: engineDN: The Distinguished Name (DN) of a Platforms engine. engineName: The Platforms engine name. services: A dictionary of service status: IIS modules: An array of Trust Protection Platform service modules that run on the service. status: The IIS Service Status. timeSinceFirstSeen: The ISO 8601 PT Duration format that represents the elapsed hours, minutes, and seconds since the vPlatform service detected operations for this service. timeSinceLastSeen: The ISO 8601 PT Duration format that represents the elapsed hours, minutes, and seconds of the most recent status check. After the service starts, a status check on the service and the modules occurs every five minutes. When the service restarts, this value is the same as timeSinceFirstSeen. logServer modules: An array of Trust Protection Platform service modules that run on the service. status: The Log server Service Status. timeSinceFirstSeen: The ISO 8601 PT Duration format that represents the elapsed hours, minutes, and seconds since the vPlatform service detected operations for this service. timeSinceLastSeen: The ISO 8601 PT Duration format that represents the elapsed hours, minutes, and seconds of the most recent status check. After the service starts, a status check on the service and the modules occurs every five minutes. When the service restarts, this value is the same as timeSinceFirstSeen. vPlatform configuredLatency: Only has a value when configuredMode is Automatic. The acceptable number of millisecond (ms) delay between Trust Protection Platform and the database. For example, 30ms, means the server will be active when the latency between the Trust Protection Platform server and database is below 30 ms. configuredMode: Appears only when Stand By Mode is configured: Manual: Stand By Mode is manually toggled by a person or script. Automatic: Stand By Mode is triggered by Latency and Work Queue Levels. configuredWork: If the ToDo queue grows above this number, a standby server will become active. currentLatency: Only has a value when configuredMode is Automatic. Last measured delay between the Trust Protection Platform server and database. currentMode: Active: When configuredWork or configuredLatency is set, the server is able to process ToDos. Idle: Server is in standby. It is not processing ToDos. currentWork: Only has a value when configuredMode is Automatic. The current size of the ToDo queue that this server could process. modules: An array of Trust Protection Platform service modules that run on the service. status: The engine Service Status. timeSinceLastSeen: The ISO 8601 PT Duration format that represents the elapsed hours, minutes, and seconds of the most recent status check. After the service starts, a status check on the service and the modules occurs every five minutes. When the service restarts, this value is the same as timeSinceFirstSeen. version: The Trust Protection Platform version.
HTTP 307	If the method is missing a slash (/) at the end of the URL or between the query parameters, this message appears: There is no operation listening for [Web SDK method], but there is an operation listening for [Web SDK method/], so you are being redirected there.
HTTP 400	Returns Bad Request for invalid URL.

Example: Show settings and status of every engine

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

Response

HTTP/1.1 200 OK
[
   {
      "engineDN":"\\VED\\Engines\\WIN-RQNDGEQLF6P",
      "engineName":"WIN-RQNDGEQLF6P",
      "services":{
         "iis":{
            "modules":[
               "Venafi.Aperture.Core",
               "Acme.Server",
               "WebSDK",
               "ClientRest",
               "AuthServer",
               "Hsm",
               "Venafi.Admin.Web",
               "VScep",
               "KeyServer"
            ],
            "timeSinceFirstSeen":"P1DT1H28M11.1982263S",
            "timeSinceLastSeen":"PT3M8.2139982S"
         },
         "logServer":{
            "modules":[
               "Log Server"
            ],
            "status":"Up",
            "timeSinceFirstSeen":"P1DT1H28M20.25899S",
            "timeSinceLastSeen":"PT14.8225645S"
         },
         "vPlatform":{
            "configuredLatency":-1,
            "configuredMode":"Automatic",
            "configuredWork":-1,
            "currentLatency":1,
            "currentMode":"Idle",
            "currentWork":0,
            "modules":[
               "Auto Layout Manager",
               "Bulk Provisioning Manager",
               "CA Import Manager",
               "Certificate Manager",
               "Certificate Pre-Enrollment",
               "Certificate Revocation",
               "Discovery",
               "Key Manager",
               "Monitor",
               "Onboard Discovery Manager",
               "Reporting",
               "SSH Certificate Manager",
               "SSH Manager",
               "Validation Manager"
            ],
            "status":"Down",
            "timeSinceFirstSeen":"P1DT1H28M11.3388299S",
            "timeSinceLastSeen":"PT3M8.2296439S"
         }
      },
      "version":"21.3.0.1994"
   },
   {
      "engineDN":"\\VED\\Engines\\64-a6997659de49",
      "engineName":"64-a6997659de49",
      "services":{
         "iis":{
            "modules":[
               "Venafi.Aperture.Core",
               "Acme.Server",
               "WebSDK",
               "ClientRest",
               "AuthServer",
               "Hsm",
               "Venafi.Admin.Web",
               "VScep",
               "KeyServer"
            ],
            "timeSinceFirstSeen":"P1DT1H18M55.0397704S",
            "timeSinceLastSeen":"PT3M51.2790671S"
         },
         "logServer":{
            "modules":[
               "Log Server"
            ],
            "status":"Up",
            "timeSinceFirstSeen":"P1DT1H19M5.8524396S",
            "timeSinceLastSeen":"PT2.4890005S"
         },
         "vPlatform":{
            "configuredLatency":0,
            "configuredWork":0,
            "currentLatency":0,
            "currentMode":"Active",
            "currentWork":0,
            "modules":[
               "Auto Layout Manager",
               "Bulk Provisioning Manager",
               "CA Import Manager",
               "Certificate Manager",
               "Certificate Pre-Enrollment",
               "Certificate Revocation",
               "Discovery",
               "Key Manager",
               "Monitor",
               "Onboard Discovery Manager",
               "Reporting",
               "SSH Certificate Manager",
               "SSH Manager",
               "Validation Manager"
            ],
            "status":"Down",
            "timeSinceFirstSeen":"P1DT1H18M55.1960023S",
            "timeSinceLastSeen":"PT3M51.3121345S"
         }
      },
      "version":"21.3.0.1994"
   }
]