Skip to main content

Heartbeat

After you create a Heartbeat monitor on monitor page, you can send heartbeat signals to Regle.

ENDPOINTS



Sending heartbeat

Send a heartbeat using HTTP POST method. Heartbeat `id` must be included in the POST URL. You can find the `id` on [monitor page](https://app.relge.dev/monitor).

No body is required and if one is sent it is ignored.

Returns

Returns a new generated id for the received heartbeat signal if successful, and returns an error otherwise.

POST /v1/heartbeat/:id
curl -s -XPOST \
-H 'Content-Type: application/json' \
-H "X-Regle-ApiKey: $REGLE_API_KEY" \
-d '{}' \
https://api.regle.dev/v1/heartbeat/:id
response
{
"id": "1664f94c-ac6c-42b0-adf8-2e560ff13553"
}