REST API Endpoint Manual
This manual provides an overview and usage instructions for the REST API endpoints of the application. The endpoints allow interaction with the application to retrieve platform configuration, restart services, and exit all processes gracefully.
Note: Replace {{ hostname }} with the appropriate hostname and {{ port }} with the desired port number.
Get Platform Configuration
Retrieve the platform configuration.
Endpoint:
GET http://{{ host }}/api/platformConfig
Description:
This endpoint allows you to fetch the platform configuration from the application.
Response:
The response will contain the platform configuration data.
Restart Services
Restart the services by sending a POST request.
Endpoint:
POST http://{{ host }}/api/restart
Description:
This endpoint triggers the restart of the services. It is used to restart the services.
Request Body:
The request does not require a request body.
Response:
The response will indicate the status of the restart operation.
Exit All Processes
Initiate a gradual exit of all processes by sending a POST request.
Endpoint:
POST http://{{ host }}/api/exitAllProcesses
Description:
This endpoint initiates the gradual exit of all processes. It allows for a graceful termination of all services and processes managed by the application.
Request Body:
The request does not require a request body.
Response:
The response will indicate the status of the exit operation.
By utilizing the REST API endpoints provided by the application, you can interact with the system to retrieve platform configuration, restart services, and gracefully exit all processes. Please refer to this manual for the appropriate usage of each endpoint.
Note: Ensure that you have the correct hostname and port number set before making requests to the endpoints.