PrizmDoc® Viewer v13.27 Release - Updated
PrizmDoc OCR API / OCR API Reference / OCR Process Manager Health API
In This Topic
    OCR Process Manager Health API
    In This Topic

    Health

    The Process Manager Internal API has two routes that can be used to check on the status of the Process Manager.

    Available URLs

    URL Description
    GET /liveness This route will return a simple 200 status if the service has completed a minimal amount of initialization. The service may not be able to receive requests on the public port and may not be able to establish a connection to the database.
    GET /readiness This route will return a simple 200 status if the service is healthy, has established a connection to the database, has a valid license, and is ready to accept requests. The database connection is not tested periodically, so a 200 response does not guarantee the service is currently able to communicate with the database.

    GET /liveness

    This route will return a simple 200 status if the service has completed a minimal amount of initialization. The service may not be able to receive requests on the public port and may not be able to establish a connection to the database.

    Success 200

    Field Description
    200 the service has completed a minimal amount of initialization.

    Successful Response

    Response body

    Plain text body "OK"

    Examples

    Request

    GET /liveness
    
    

    Successful Response

    HTTP 200 OK

    "OK"
    
    

    GET /readiness

    This route will return a simple 200 status if the service is healthy, has established a connection to the database and is ready to accept requests. The database connection is not tested periodically, so a 200 response does not guarantee the service is currently able to communicate with the database.

    Success 200

    Field Description
    200 The service is healthy, has established a connection to the database and is ready to accept requests.

    Successful Response

    Response body

    Plain text body "OK"

    Examples

    Request

    GET /readiness
    
    

    Successful Response

    HTTP 200 OK

    "OK"