Shutdown

This page describes the different ways to shut down REST server gracefully. It also describes the behaviour of the REST server if the license server goes down.

Graceful Shutdown

A REST server can be shut down using following options:

Using Control-C.
System wide shutdown.
Using REST Server shutdown end point.

In all above cases, the REST server will check for any running comparisons before initiating the shutdown. REST Server will shut itself down after completing all the running comparisons. At same time, the REST server will not accept any new comparison.

REST Server Shutdown End Point

A graceful can be enacted with the POST command using this string: http://0.0.0.0:8080/api/shutdown

Request

POST /api/shutdown

Response

XML

<shutdownInfo>
    <initiateTime>2026-06-25T12:48:43.230+0000</initiateTime>
    <runningComparisons>0</runningComparisons>
    <info>REST Server shut down initiated. It will be completed after finishing the running jobs.</info>
</shutdownInfo>

The above command runs a graceful shutdown, however to run a forced shutdown you can add force to the end of the command such as: http://0.0.0.0:8080/api/shutdown/force

Request

POST /api/shutdown/force

Response

XML

<shutdownInfo>
    <initiateTime>2026-06-25T12:58:12.052+0000</initiateTime>
    <runningComparisons>0</runningComparisons>
    <info>REST Server forced shut down initiated. All running jobs will be stopped.</info>
</shutdownInfo>