Checks

Get the first-ping waiting/received card data for a check

The REST equivalent of the dashboard's "listening for your first heartbeat" card. received becomes true once the monitor has reported in any way — including an outstanding /start that was later cancelled or consumed by detection — using the same predicate the dashboard's own card polls against (the monitor's state alone cannot tell a cancelled start from a monitor that was truly never pinged, so this endpoint also looks at its pings, same as the dashboard).

signal_word/instruction/command are a pure function of the monitor's own configuration (monitor_type, ci_provider), never of whether it has reported yet — they stay populated after received becomes true, unlike the HTML fragment which stops rendering them. command is omitted for http monitors, which probe automatically and so have no copy-paste command.

test_ping_only separates "we have heard from the console's own test ping" from "your job has reported". Without it, pressing POST /api/v1/checks/{id}/test-ping on a monitor nothing has reported to flips received to true and a client that reads only received tells the user their integration works.

404 if the check does not exist in the authenticated project (no existence oracle).

Console stability note. This response is shaped by a console screen: the fields are the ones that screen draws, in the grouping it draws them in. It stays published because reading it is a reasonable thing to automate, and no field will be removed or change meaning without a version. Fields may be ADDED as the screen grows, so treat unknown keys as normal rather than as an error.

get/api/v1/checks/{id}/first-ping

Request

  • Base URL: https://app.lastping.dev
  • URL: https://app.lastping.dev/api/v1/checks/{id}/first-ping
  • Auth: API key in header X-Api-Key

Response

First-ping card data.

receivedboolean required

True once the monitor has reported in any way — including an outstanding /start later cancelled or consumed by detection — using the same predicate the dashboard's own card polls against.

test_ping_onlyboolean required

True when the monitor has reported but none of its most recent 20 pings came from anything other than the console's own POST /api/v1/checks/{id}/test-ping button. Always false while received is false. Read received && test_ping_only as "the test ping arrived, the caller's own job has not reported yet": a client that treats received alone as "connected" lets the test button satisfy its own acceptance check.

signal_word'ping' | 'check' | 'pipeline event' required
instructionstring required
commandstring

Omitted for http monitors — they probe automatically, so there is no copy-paste command.

Example response

{
  "signal_word": "ping",
  "instruction": "Run this at the end of your job — or paste it into a terminal now to send a test ping.",
  "command": "curl -fsS https://ping.lastping.dev/550e8400-e29b-41d4-a716-446655440000"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.