Status API

1. Retrieve the Status

The Status API is used to retrieve the current status and metrics for the server. This is useful for health checks and monitoring.

1.1. Request

Return the Server Status.

URI

GET /api/status

1.2. Response

The JSON response from the Status API is complex and subject to change. The specific contents of the JSON body are not documented here. If you choose to use this API for monitoring purposes you should primarily use the response code to indicate server health. If you receive a 200 you may consider CleanSpeak in a healthy state. The response body is intended for use by Inversoft support.

Table 1. Response Codes
Code Description

200

The Passport server is functioning properly

500

The Passport server is not functioning properly. This could indicate that the database connectivity failed or one or more services within Passport failed. Consult the Passport Troubleshooting to learn more about the failure or contact Inversoft support for assistance.