2.8 KiB
Pinging API
With the Pinging API, you can signal success, fail, and start events from your systems.
General Notes
All ping endpoints support:
- HTTP and HTTPS
- HTTP 1.0, HTTP 1.1 and HTTP 2
- IPv4 and IPv6
- HEAD, GET, and POST requests methods. The HTTP POST requests can optionally include diagnostic information in the request body. If the request body looks like a UTF-8 string, SITE_NAME stores the request body (limited to the first 10KB for each received ping).
Successful responses will have the "200 OK" HTTP response status code and a short "OK" string in the response body.
Send a "success" Signal
HEAD|GET|POST PING_ENDPOINT{uuid}
Signals to SITE_NAME that the job has completed successfully (or,
continuously running processes are still running and healthy). The uuid parameter
is unique for each check.
Example
GET /5bf66975-d4c7-4bf5-bcc8-b8d8a82ea278 HTTP/1.0
Host: hc-ping.com
HTTP/1.1 200 OK
Server: nginx
Date: Wed, 29 Jan 2020 09:58:23 GMT
Content-Type: text/plain; charset=utf-8
Content-Length: 2
Connection: close
Access-Control-Allow-Origin: *
OK
Send a "fail" Signal
HEAD|GET|POST PING_ENDPOINT{uuid}/fail
Signals to SITE_NAME that the job has failed. Actively signaling a failure minimizes the delay from your monitored service failing to you receiving an alert.
Example
GET /5bf66975-d4c7-4bf5-bcc8-b8d8a82ea278/fail HTTP/1.0
Host: hc-ping.com
HTTP/1.1 200 OK
Server: nginx
Date: Wed, 29 Jan 2020 09:58:23 GMT
Content-Type: text/plain; charset=utf-8
Content-Length: 2
Connection: close
Access-Control-Allow-Origin: *
OK
Send a "start" Signal
HEAD|GET|POST PING_ENDPOINT{uuid}/start
Sends a "job has started!" message to SITE_NAME. Sending a "start" signal is optional, but it enables a few extra features:
- SITE_NAME will measure and display job execution times
- SITE_NAME will detect if the job runs longer than its configured grace time
Example
GET /5bf66975-d4c7-4bf5-bcc8-b8d8a82ea278/start HTTP/1.0
Host: hc-ping.com
HTTP/1.1 200 OK
Server: nginx
Date: Wed, 29 Jan 2020 09:58:23 GMT
Content-Type: text/plain; charset=utf-8
Content-Length: 2
Connection: close
Access-Control-Allow-Origin: *
OK
Report Script's Exit Status
HEAD|GET|POST PING_ENDPOINT{uuid}/{exit-status}
Sends a success or failure signal depending on the exit status included in the URL. The exit status is a 0-255 integer. SITE_NAME interprets 0 as success and all other values as failure.
Example
GET /5bf66975-d4c7-4bf5-bcc8-b8d8a82ea278/1 HTTP/1.0
Host: hc-ping.com
HTTP/1.1 200 OK
Server: nginx
Date: Wed, 29 Jan 2020 09:58:23 GMT
Content-Type: text/plain; charset=utf-8
Content-Length: 2
Connection: close
Access-Control-Allow-Origin: *
OK