Shutdown REST API

You can use the following request to shutdown the webMethods API Gateway server.

POST /rest/apigateway/shutdown

{
    "bounce": "true/false",
    "option": "force/drain",
    "timeout": 10,
    "quiesce": "true/false"
}

The parameters used in the request are described in the following table:

Parameter	Description
bounce	Specifies whether to restart the webMethods API Gateway server after shutdown. If you specify the value as `true`, the webMethods API Gateway server restarts. The default value is `false`.
option	Specifies whether to shutdown the webMethods API Gateway server immediately or after all client sessions are ended. If you specify the value as `force`, the webMethods API Gateway server is shutdown immediately. If you specify the value as `drain`, webMethods API Gateway waits for a maximum period of time for all the client sessions to end before shutdown.
timeout	Specifies the maximum wait time in minutes before the webMethods API Gateway server is shutdown when `drain` option is specified.
quiesce	If you specify value as `true`, webMethods API Gateway flushes the in-memory data like performance metrics, license metrics, and subscription quota to Elasticsearch or API Data Store before the webMethods API Gateway server is shutdown. After this when webMethods API Gateway is restarted either manually or using bounce parameter, the Integration Server is started in quiesce mode. Note: In a cluster, the flushing of in-memory data is performed only on one of the nodes and on other nodes the API call returns immediately by eliminating the flush time. The default value is `false`.