WebApi

<back to all web services

SystemStatusCheck

Returns the status of the client's machine

The following routes are available for this service:
GET, OPTIONS/Status
SystemStatusCheck Parameters:
NameParameterData TypeRequiredDescription
ComponentquerystringNoThe component to check
SystemStatus Parameters:
NameParameterData TypeRequiredDescription
DatabaseStateformComponentStateNo
DatabaseMessageformstringNo
APIStateformComponentStateNo
APIMessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Status HTTP/1.1 
Host: burntrouter.info 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"DatabaseState":"Running","DatabaseMessage":"String","APIState":"Running","APIMessage":"String"}