Pings
Called by your job to report a run. Authenticated by the ping URL itself rather than a token.
Path Parameters
From the monitor’s ping URL.
Query Parameters
A per-run id tying this ping to its /start. Without it a closing ping pairs with whatever event came last, which mis-measures jobs whose runs overlap.
Run time in seconds, measured by the job. Preferred over the server’s own arithmetic, which can only see when the pings arrived.
Response Body
application/json
curl -X GET "https://example.com/ping/string/"{ "success": true, "data": { "monitor": { "pingID": "string", "status": "string" }, "event": { "number": 0, "type": "string", "duration": 0, "runID": "string" } }}Path Parameters
From the monitor’s ping URL.
Query Parameters
A per-run id tying this ping to its /start. Without it a closing ping pairs with whatever event came last, which mis-measures jobs whose runs overlap.
Run time in seconds, measured by the job. Preferred over the server’s own arithmetic, which can only see when the pings arrived.
Response Body
application/json
curl -X GET "https://example.com/ping/string/start/"{ "success": true, "data": { "monitor": { "pingID": "string", "status": "string" }, "event": { "number": 0, "type": "string", "duration": 0, "runID": "string" } }}Path Parameters
From the monitor’s ping URL.
Query Parameters
A per-run id tying this ping to its /start. Without it a closing ping pairs with whatever event came last, which mis-measures jobs whose runs overlap.
Run time in seconds, measured by the job. Preferred over the server’s own arithmetic, which can only see when the pings arrived.
Response Body
application/json
curl -X GET "https://example.com/ping/string/fail/"{ "success": true, "data": { "monitor": { "pingID": "string", "status": "string" }, "event": { "number": 0, "type": "string", "duration": 0, "runID": "string" } }}Path Parameters
From the monitor’s ping URL.
Query Parameters
A per-run id tying this ping to its /start. Without it a closing ping pairs with whatever event came last, which mis-measures jobs whose runs overlap.
Run time in seconds, measured by the job. Preferred over the server’s own arithmetic, which can only see when the pings arrived.
Response Body
application/json
curl -X GET "https://example.com/ping/string/end/"{ "success": true, "data": { "monitor": { "pingID": "string", "status": "string" }, "event": { "number": 0, "type": "string", "duration": 0, "runID": "string" } }}