System
The IPMonitor System API provides an essential endpoint for verifying the operational status of the system. This documentation details the endpoint, complete with a request example and the possible responses.
System Check
GET /api/v1/system-check
This endpoint is used to confirm if the IPMonitor system is operational and running smoothly.
bash
curl -X 'GET' \
'http://ipmonitor.mydomain.com/api/v1/system-check' \
-H 'accept: */*' \
-H 'Authorization: Bearer api_token_here'
curl -X 'GET' \
'http://ipmonitor.mydomain.com/api/v1/system-check' \
-H 'accept: */*' \
-H 'Authorization: Bearer api_token_here'
json
{
"status": "ok",
"message": "System is up and running"
}
{
"status": "ok",
"message": "System is up and running"
}
Response Status Codes:
- 200 Success
- 401 Unauthorized
- 403 Forbidden
- 503 Service Unavailable