PrizmDoc® v14.1 Release - Updated
PrizmDoc / API Reference / PAS REST API / Self-Hosted Administration / Health
In This Topic
    Health
    In This Topic

    Introduction

    For customers who are self-hosting PAS, the health REST API allows an administrator or application to check the health of a specific PAS instance.

    NOTE: These URLs are not available in PrizmDoc Cloud.

    Available URLs

    URL Description
    GET /health Determines whether PAS is healthy or not.
    GET /servicesConnection Returns the status of PAS connectivity to PrizmDoc Server.
    GET /info A request to get information about the service.

    GET /health

    Determines whether a specific PAS instance is healthy or not. A 200 response indicates PAS is healthy. Anything else indicates PAS is unhealthy.

    NOTE: For a Kubernetes cluster, see Checking PrizmDoc Kubernetes Cluster Health.

    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

    Returns the status of PAS connectivity to PrizmDoc Server.

    Successful Response

    HTTP/1.1 200 OK
    OK
    
    

    A 200 response indicates PAS is able to communicate with PrizmDoc Server.

    NOTE: A successful response only indicates whether PAS is able to communicate with PrizmDoc Server; it does not mean that PrizmDoc Server instances themselves are healthy. To check the health of PrizmDoc Server instances, use the PrizmDoc Server Health REST API.

    Error Responses

    HTTP/1.1 580 Server Error
    
    

    A non-200 response indicates PAS is NOT able to communicate with PrizmDoc Server.

    GET /info

    A request to get information about the service.

    NOTE: We recommend using GET /health API when checking PAS health automatically.

    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.