On this page

    Server Status API

    This API retrieves the status of a node. For high availability, this API can be used to determine whether a controller node is active or not.

    Important
    This API is currently available, but deprecated.

    Syntax

    REST syntax:

    GET /apiv2/server_status
    

    HTTP syntax:

    http://<host>:<port>/apiv2/server_status
    

    Response Output

    If the node is responsive, the following is returned:

    "OK"
    

    If the node is not running, no response is returned. In addition, failing to complete a request to this end-point or delays in getting a response might signal problems with the node.

    Please note that, when using internal user management, if no users have been defined, this endpoint returns the following error:

    'No User Available'
    

    Example

    http://localhost:9047/apiv2/server_status