Introduction

The following APIs check the health status of PAS, as well as check whether it is properly configured to connect with a PrizmDoc Server. Additionally, an API is provided to return information about PAS.

Note that these routes do not have route keys, as they cannot be re-routed.

Available URLs

GET /health

Note that this URL is only available with PrizmDoc Viewer Self-Hosted.

Determines whether PAS is healthy or not.

GET http://localhost:3000/health

Successful Response

HTTP/1.1 200 OK
OK

There are no error states for this request. If the request times out or the connection is refused, then the service is not running or reachable.

GET /servicesConnection

Note that this URL is only available with PrizmDoc Viewer Self-Hosted.

Returns the status of PAS connectivity to PrizmDoc Server, whether PrizmDoc Viewer Self-Hosted or PrizmDoc Cloud.

Successful Response

HTTP/1.1 200 OK
OK

Note that this response represents that the connection to the PrizmDoc Service is successful, and does not take into account whether those services are healthy. If you need to check the health of those services, please make a call to them directly.

Error Responses

HTTP/1.1 580 Server Error

This response represents that PAS is not properly configured to communicate with a PrizmDoc Service.

GET /info

Note that this URL is only available with PrizmDoc Viewer Self-Hosted.

A request to get information about the service.

GET http://localhost:3000/info

Successful Response

HTTP/1.1 200 OK
Content-Type: application/json
{
    "version": "X.X.XXXX.XXXX"
}

Where the version is the PAS version.

There are no error states for this request. If the request times out or the connection is refused, then the service is not running or reachable.