Heartbeat
Send a heartbeat lifecycle signal (GET)
Record a job lifecycle signal (start, success, or fail). The explicit path segment always wins over any ?signal/?state/?status query value. GET is accepted for runners that can only issue GET requests.
Path Parameters
uuid*string
Unique heartbeat monitor identifier
Format
uuidsignal*string
Job lifecycle signal. start marks a run beginning, success a healthy completion, and fail records a failure (flipping the monitor down).
Value in
"start" | "success" | "fail"Response Body
application/json
application/json
curl -X GET "https://api.telescopealerts.com/api/heartbeat/497f6eca-6276-4993-bfeb-53cbbbba6f08/start"{
"status": "ok",
"message": "string",
"monitor_id": "ff93e0f3-22fc-4809-8875-a2d24a9803b1",
"signal": "start",
"received_at": "2019-08-24T14:15:22Z"
}{
"status": "error",
"error": "string",
"code": "string"
}