Get Server Status Information

GET /status

Enables the retrieval of server status information.

Note: This will be used in monitoring solutions to warn us when the REST API is no longer functioning as expected.

Resource URL

https://api.ideasystem.org/v1/status

Response

The response will be an HTTP 200 with a JSON body. The body will include a list of components that have status associated with them. The 200 will be returned only when all components are operating correctly. Otherwise, an HTTP 503 will be returned along with status for each component.

Response Parameters (JSON Body)

api
Example: "api": "online"
Displays the status of this server.
server
Example: "server": "offline"
Displays the status of the IDEA Server (which is used to perform calculations and generation or reports).
database
Example: "database": "online"
Displays the status of the MySQL Combo database.

Example

This request will get the status of the server when everything is functioning as expected.

Request

GET /v1/status

Response (as JSON)

HTTP 200
{
	"api": "online", // status of the IDEA REST Server
	"server": "online", // status of the IDEA Server
	"database": "online" // status of the Combo Database
}

Example

This request will get the status of the server when there are issues with the backend services.

Request

GET /v1/status

Response (as JSON)

HTTP 503
{
	"api": "online", // status of the IDEA REST Server
	"server": "offline", // status of the IDEA Server
	"database": "offline" // status of the Combo Database
}