GET ServerStatus

Returns an HTML page indicating the status of all Trust Protection Platform servers and services. The HTML page can be viewed in a browser at https://tpp.server.url/vedsdk/serverstatus/.

This endpoint can be disabled. To disable this endpoint, contact Venafi Support and have them walk you through setting an Options attribute set to NoHtmlStatus on the Platforms > Support tab.

NOTE  Disabling does not disable the ServerStatus/Status, ServerStatus/Active, or ServerStatus/Idle endpoints.

Requirements

  • Permissions:  None
  • Token scope:   No token required

Headers

None

Parameters

None

Returns

Response description

Name

Description

HTTP 200

Returns an HTML page that shows the following:

  • Engine: The name of the Trust Protection Platform server.

  • Service: The service that the engine is running.

  • Modules: The modules that are active on the engine.

  • First Seen: The date and time when the engine was first seen.

  • Last Seen: The date and time when the engine was most recently seen.

  • Configured Mode: One of three possible values:

    • None: Standby mode is not configured. Work orders will be acquired as soon as they are available and processed immediately.

    • Manual: Engine must be manually configured to start acquiring work orders via an administrator or automated script. Orders will only be acquired if this engine is set for processing.

    • Automatic: Engine is configured to acquire work orders only if the backlog grows too long or the database latency drops below an acceptable threshold. One or both of these can be configured at once, and the engine will process orders if either criteria is met.

  • Current Mode: One of three possible values:

    • None: Will always pick up work orders. Standby mode doesn’t apply.

    • Idle: Standby mode is configured, and it will not pick up work orders.

    • Active: Standby mode is configured, and it can pick up work orders.

  • Configured Latency: The engine's configured latency, in milliseconds. -1 indicates that this isn't configured.

  • Current Latency: The engine's current latency, in milliseconds. This value is pulled from the engine's statistics. It is the average over the last 15 minutes.

  • Configured Work: The work threshold value. The engine will remain idle until the work backlog exceeds this number. -1 indicates that this isn't configured.

  • Current Work: The number of work orders queued.

HTTP 404

Returns Document not found if the endpoint has been disabled as described in the description above.

Example: Show settings and status of every engine

Request

https://tpp.venafi.example/vedsdk/ServerStatus/

Response