Software AG Products 10.11 | Integrate Software AG Products Using Digital Event Services | webMethods API Gateway Documentation | Upgrading API Gateway | Upgrading | Upgrading API Gateway in Zero Downtime | Shutdown REST API
 
Shutdown REST API
You must perform the operations of the shutdown REST API capability in the old and new instances of API Gateway.
You can use the following API to shutdown the API Gateway server.
POST /rest/apigateway/shutdown

{
"bounce": "true/false",
"option": "force/drain",
"timeout": 10,
"quiesce": "true/false"
}
The parameters used in the API are described in the following table:
Parameter
Description
bounce
Specifies whether to shutdown API Gateway server immediately or after all client sessions are ended. If you specify the value as force, the API Gateway server is shutdown immediately. If you specify the value as drain, API Gateway waits for a maximum period of time for all the client sessions to end before shutdown.
option
Specifies the maximum wait time in minutes before API Gateway server is shutdown when drain option is specified.
timeout
Specifies whether to restart drain API Gateway server after shutdown. If you specify true, the API Gateway server restarts. By default, this value is set to false.
quiesce
If you specify true, API Gateway would first flush in memory data like performance metrics, license metrics and subscription quota to API Data Store before shutdown of the API Gateway server. After this when API Gateway is restarted either manually or using bounce parameter, the integration API Gateway 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 hence on other nodes the API call returns immediately by eliminating the flush time. The default value is false.