Health and Information

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

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

GET /health

Note that this URL is only available with PrizmDoc Enterprise.

A check to determine if the service is up and running.

GET http://localhost:3000/health

Successful Response:

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 Enterprise.

Returns the status of the PrizmDoc Application Services connectivity to PrizmDoc Server, whether PrizmDoc Enterprise or PrizmDoc Cloud.

Successful Response:

200 OK
OK

Note that this response represents that the connection to the back-end 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.

Errored Responses:

This response represents that PAS is not properly configured to communicate with a PrizmDoc back-end service.

GET /info

Note that this URL is only available with PrizmDoc Enterprise.

A request to get information about the service.

GET http://localhost:3000/info

Successful Response:

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

Where the version is the PrizmDoc Application Services 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.