Send a Heartbeat

This endpoint allows you to send a heartbeat for a specific Monitor of the Heartbeat (CRON) type in your Garmingo Status instance.

Endpoint	Method	URL
/heartbeat/{token}	POST/GET	https://garmingo.com/api/status/v1/heartbeat/{token}

Heartbeat Token

The request contains the token of the Monitor you want to send a heartbeat for.
The token is a unique identifier for the Monitor and is used to authenticate the request.
It can be obtained from the Monitor's settings in the Garmingo Status web interface.

Response

The response is a JSON object with the following properties:

Property	Type	Description
success	boolean	Whether the request was successful.

Example

{
  "success": true
}

Failing Heartbeats

You can also send a failing heartbeat which will mark the Monitor as down.
To do this, you simply append /fail to the URL and send a POST or GET request.

Example

curl -X POST https://garmingo.com/api/status/v1/heartbeat/{token}/fail