Prerequisites: please ensure that you have private AppBeat API Access Key.
API endpoints:
It is recommended that you always call "Endpoint 1". However if you experience any issues with this endpoint (you don't receive JSON response or there is no response after 30 seconds), we suggest you to repeat your call on "Endpoint 2" (which is located in different geographic region). Some users may decide to call our API endpoints by using round-robin technique (which is also OK).
When posting JSON data (payload) to AppBeat server please ensure that you:
| URL template (relative to endpoint) | Type | JSON payload | Description |
|---|---|---|---|
| /status? secret=URL_ENCODED_KEY |
GET | Returns live system status with all services and checks. | |
| /list? secret=URL_ENCODED_KEY &resource=checks |
GET | Returns all checks (including resource identifiers). | |
| /check-details? secret=URL_ENCODED_KEY &id=YOUR_CHECK_ID |
GET | Returns check details for give id. | |
| /list? secret=URL_ENCODED_KEY &resource=services |
GET | Returns all services (including resource identifiers). | |
| /list? secret=URL_ENCODED_KEY &resource=checks &serviceId=YOUR_SERVICE_ID |
GET | Returns all checks for specific service (including resource identifiers). | |
| /pause | POST | {
"Ids":[
"YOUR_SERVICE_ID_OR_YOUR_CHECK_ID"
],
"Secret":"YOUR_KEY"
} |
Pause one or more check(s) or service(s) identified by resource id(s). |
| /resume | POST |
{
"Ids":[
"YOUR_SERVICE_ID_OR_YOUR_CHECK_ID"
],
"Secret":"YOUR_KEY"
}
|
Resume one or more check(s) or service(s) identified by resource id(s). |
| /delete | POST |
{
"Ids":[
"YOUR_SERVICE_ID_OR_YOUR_CHECK_ID"
],
"Secret":"YOUR_KEY"
}
|
Delete one or more check(s) or service(s) identified by resource id(s). |
| /new-check? secret=URL_ENCODED_KEY |
POST | {
"Agent":"AdvancedWeb",
"Name":"My Check Name",
"Description":"Check created with AppBeat REST API",
"CheckIntervalInSeconds":"300",
"AgentSpecificSettings":{
"URL":"www.google.com",
"TIMEOUT":"15",
"METHOD":"GET",
"HTTP_VER":"http1.1",
"IP_VER":"ipv4"
}
} |
Creates new periodic web check. Please contact us for other check types (Ping, IMAP, POP3, ...) so we can provide you required parameter names. |
| /dismiss-service-alert | POST |
{
"Ids":[
"YOUR_SERVICE_ID"
],
"Secret":"YOUR_KEY"
}
|
Dismisses service alerts (by provided service resource ids) which are displayed on AppBeat GUI. |
| /dismiss-all-service-alerts | POST |
{
"Secret":"YOUR_KEY"
}
|
Dismisses all service alerts which are displayed on AppBeat GUI. |
Please note: instead of web1.appbeat.io you can also use web2.appbeat.io as stated in General section.
If you have any questions or issues please let us know. You can contact us here.