Restart Operation
A restart service API allows you to restart the application.
A restart operation makes the system temporarily unavailable. |
Restart Operation is allowed in non-production environments and only work with the same major application release version. |
To perform the restart operation, submit the following POST requests and confirm the operation:
HTTP Method |
|
Base URL |
|
Content-Type |
|
- Response Example
-
The successful creation of a request returns a 200 OK response with the following response body:
{ "uuid": "<uuid>", "requestType": "restart", "status": "<statusType>", "requestInfo": "{<request_Information>}", "createdBy": "<user_name>", "createdAt": "2022-05-31T06:04:18.39486333Z", "updatedBy": null, "lastUpdatedAt": "2022-05-31T06:04:18.394870245Z", "confirm": "https://<app-deployment-name>/console/workRequest/confirm/{uuid}", "cancel": "https://<app-deployment-name>/console/workRequest/cancel/{uuid}" }
Error Response
Besides, the 2OO responses, this endpoint returns the 4xx responses when any other operation is in-progress.
Confirm the Restart Operation
To confirm the restart operation, send the following GET
request with the appropriate UUID:
HTTP Method |
|
Base URL |
|
Content-Type |
|
Here, replace {uuid}
with an uuid value that returned by POST http://<app-deployment-name>/workRequest/create/restart
- Response Example
{ "uuid": "<uuid>", "requestType": "reset", "status": "COMPLETED", "requestInfo": "{<requestType>}", "createdBy": "<user_name>", "createdAt": "2022-05-17T06:02:14.908Z", "updatedBy": null, "lastUpdatedAt": "2022-05-17T06:16:54.409Z", "confirm": null, "cancel": null }
You can also confirm the work request by clicking on the confirm
URL return in the POST http://<app-deployment-name>/workRequest/create/reset
response body.
It redirects you to the GET
request body and then sends the request.
Cancel the Restart Operation
You can cancel the operation within ten minutes by sending the following GET
request with the appropriate UUID:
HTTP Method |
|
Base URL |
|
Content-Type |
|
Here, replace {uuid}
with an uuid value that returned by POST http://<app-deployment-name>/workRequest/create/restart
- Response Example
{ "uuid": "<uuid>", "requestType": "restart", "status": "CANCELED", "requestInfo": "{<requestInfo>}", "createdBy": "<user_name>", "createdAt": "2022-05-17T06:02:14.908Z", "updatedBy": null, "lastUpdatedAt": "2022-05-17T06:16:54.409Z", "confirm": null, "cancel": null }