Skip to content

Uptime

17 endpoints under /api/v1/uptime.

GET /api/v1/uptime/ping #

Uptime service round-trip check

Proves the Console → Lookout relay for the acting organization. Private beta: requires the org's Uptime entitlement.

Responses

200 The Lookout service answered.
Response body
  • servicestringrequired
  • orgstringrequired
  • schemaEpochstringrequired
  • timestringrequired
401 No valid session.
Response body
  • errorstringrequired
403 Uptime is not enabled for this organization (private beta), or the monitor quota is reached.
Response body
  • errorstringrequired
404 Unknown service or monitor.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
GET /api/v1/uptime/catalog #

Offerable check intervals and probe vantages

Platform-tweakable capability catalog; vantages with available=false are coming soon and rejected on writes.

Responses

200 The Lookout capability catalog.
Response body
  • intervalsUptimeInterval[]required
    Show fields
    • secondsintegerrequired
    • labelstringrequired
  • vantagesUptimeVantage[]required
    Show fields
    • idstringrequired
    • labelstringrequired
    • availablebooleanrequired
401 No valid session.
Response body
  • errorstringrequired
403 Uptime is not enabled for this organization (private beta), or the monitor quota is reached.
Response body
  • errorstringrequired
404 Unknown service or monitor.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
GET /api/v1/uptime/services #

List the organization's uptime services

Responses

200 The org's services, with live monitor counts.
Response body
  • servicesUptimeService[]required
    Show fields
    • idstringrequired
    • namestringrequired
    • monitorsintegerrequired
    • createdAtstringrequired
401 No valid session.
Response body
  • errorstringrequired
403 Uptime is not enabled for this organization (private beta), or the monitor quota is reached.
Response body
  • errorstringrequired
404 Unknown service or monitor.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
GET /api/v1/uptime/monitors #

List the organization's monitors

Responses

200 The org's live monitors (read-through from Lookout).
Response body
  • monitorsUptimeMonitor[]required
    Show fields
    • namestringrequired
    • serviceIdstring
    • enabledbooleanrequired
    • intervalSecondsintegerrequired
    • vantagesstring[]required
    • timeoutMsintegerrequired
    • downConditionobjectrequired
      Show fields
      • confirmationsintegerrequired
      • quorumintegerrequired
    • httpobject
      Show fields
      • urlstring · urirequired
      • methodstring · enum

        GETHEADPOST

      • headersobject
        Show fields

        object

      • bodyBase64string
      • followRedirectsboolean
      • expectStatusstring[]
      • expectBodyContainsstring
    • tcpobject
      Show fields
      • hoststringrequired
      • portintegerrequired
      • tlsboolean
      • sendBase64string
      • expectPrefixBase64string
    • idstringrequired
    • kindstring · enumrequired

      tcphttp

    • statestring · enum

      pendingupdown

    • stateSincestring
    • createdAtstringrequired
    • updatedAtstringrequired
401 No valid session.
Response body
  • errorstringrequired
403 Uptime is not enabled for this organization (private beta), or the monitor quota is reached.
Response body
  • errorstringrequired
404 Unknown service or monitor.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
POST /api/v1/uptime/services #

Create an uptime service

Request body

  • namestringrequired

Responses

201 The created service.
Response body
  • idstringrequired
  • namestringrequired
  • monitorsintegerrequired
  • createdAtstringrequired
401 No valid session.
Response body
  • errorstringrequired
403 Uptime is not enabled for this organization (private beta), or the monitor quota is reached.
Response body
  • errorstringrequired
404 Unknown service or monitor.
Response body
  • errorstringrequired
409 A service with this name already exists.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
POST /api/v1/uptime/monitors #

Create a monitor

Console-side monitor quota (DEFAULT_MAX_MONITORS) applies before the relay; interval, vantages, and target admissibility are Lookout-validated.

Request body

  • namestringrequired
  • serviceIdstring
  • enabledboolean
  • intervalSecondsintegerrequired
  • vantagesstring[]required
  • timeoutMsinteger
  • downConditionobject
    Show fields
    • confirmationsintegerrequired
    • quorumintegerrequired
  • httpobject
    Show fields
    • urlstring · urirequired
    • methodstring · enum

      GETHEADPOST

    • headersobject
      Show fields

      object

    • bodyBase64string
    • followRedirectsboolean
    • expectStatusstring[]
    • expectBodyContainsstring
  • tcpobject
    Show fields
    • hoststringrequired
    • portintegerrequired
    • tlsboolean
    • sendBase64string
    • expectPrefixBase64string
  • kindstring · enumrequired

    tcphttp

Responses

201 The created monitor.
Response body
  • namestringrequired
  • serviceIdstring
  • enabledbooleanrequired
  • intervalSecondsintegerrequired
  • vantagesstring[]required
  • timeoutMsintegerrequired
  • downConditionobjectrequired
    Show fields
    • confirmationsintegerrequired
    • quorumintegerrequired
  • httpobject
    Show fields
    • urlstring · urirequired
    • methodstring · enum

      GETHEADPOST

    • headersobject
      Show fields

      object

    • bodyBase64string
    • followRedirectsboolean
    • expectStatusstring[]
    • expectBodyContainsstring
  • tcpobject
    Show fields
    • hoststringrequired
    • portintegerrequired
    • tlsboolean
    • sendBase64string
    • expectPrefixBase64string
  • idstringrequired
  • kindstring · enumrequired

    tcphttp

  • statestring · enum

    pendingupdown

  • stateSincestring
  • createdAtstringrequired
  • updatedAtstringrequired
401 No valid session.
Response body
  • errorstringrequired
403 Uptime is not enabled for this organization (private beta), or the monitor quota is reached.
Response body
  • errorstringrequired
404 Unknown service or monitor.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
GET /api/v1/uptime/monitors/{id} #

One monitor

Parameters

  • id path string required

Responses

200 The monitor.
Response body
  • namestringrequired
  • serviceIdstring
  • enabledbooleanrequired
  • intervalSecondsintegerrequired
  • vantagesstring[]required
  • timeoutMsintegerrequired
  • downConditionobjectrequired
    Show fields
    • confirmationsintegerrequired
    • quorumintegerrequired
  • httpobject
    Show fields
    • urlstring · urirequired
    • methodstring · enum

      GETHEADPOST

    • headersobject
      Show fields

      object

    • bodyBase64string
    • followRedirectsboolean
    • expectStatusstring[]
    • expectBodyContainsstring
  • tcpobject
    Show fields
    • hoststringrequired
    • portintegerrequired
    • tlsboolean
    • sendBase64string
    • expectPrefixBase64string
  • idstringrequired
  • kindstring · enumrequired

    tcphttp

  • statestring · enum

    pendingupdown

  • stateSincestring
  • createdAtstringrequired
  • updatedAtstringrequired
401 No valid session.
Response body
  • errorstringrequired
403 Uptime is not enabled for this organization (private beta), or the monitor quota is reached.
Response body
  • errorstringrequired
404 Unknown service or monitor.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
GET /api/v1/uptime/export-tokens #

List the organization's Prometheus export tokens

Long-lived, revocable credentials for your own Prometheus to scrape check results. The token value itself is never returned here — it is shown once, at creation.

Responses

200 The org's export tokens (metadata only, never secrets).
Response body
  • tokensUptimeExportToken[]required
    Show fields
    • idstringrequired
    • namestringrequired
    • createdAtstringrequired
    • lastUsedAtstringrequired
401 No valid session.
Response body
  • errorstringrequired
403 Uptime is not enabled for this organization (private beta), or the monitor quota is reached.
Response body
  • errorstringrequired
404 Unknown service or monitor.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
POST /api/v1/uptime/export-tokens #

Create a Prometheus export token

Mints an org-scoped scrape credential (lke_…). The response is the ONLY time the token value appears — store it now; only its hash is kept server-side.

Request body

  • namestringrequired

Responses

201 The created token, including the one-time token value (shown once).
Response body
  • idstringrequired
  • namestringrequired
  • tokenstringrequired
  • createdAtstringrequired
401 No valid session.
Response body
  • errorstringrequired
403 Uptime is not enabled for this organization (private beta), or the monitor quota is reached.
Response body
  • errorstringrequired
404 Unknown service or monitor.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
PATCH /api/v1/uptime/services/{id} #

Rename an uptime service

Parameters

  • id path string required

Request body

  • namestringrequired

Responses

200 The renamed service.
Response body
  • idstringrequired
  • namestringrequired
  • monitorsintegerrequired
  • createdAtstringrequired
401 No valid session.
Response body
  • errorstringrequired
403 Uptime is not enabled for this organization (private beta), or the monitor quota is reached.
Response body
  • errorstringrequired
404 Unknown service or monitor.
Response body
  • errorstringrequired
409 A service with this name already exists.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
PATCH /api/v1/uptime/monitors/{id} #

Update a monitor

Any subset of the spec; kind is immutable (recreate to switch checks).

Parameters

  • id path string required

Request body

  • namestring
  • serviceIdstring
  • enabledboolean
  • intervalSecondsinteger
  • vantagesstring[]
  • timeoutMsinteger
  • downConditionobject
    Show fields
    • confirmationsintegerrequired
    • quorumintegerrequired
  • httpobject
    Show fields
    • urlstring · urirequired
    • methodstring · enum

      GETHEADPOST

    • headersobject
      Show fields

      object

    • bodyBase64string
    • followRedirectsboolean
    • expectStatusstring[]
    • expectBodyContainsstring
  • tcpobject
    Show fields
    • hoststringrequired
    • portintegerrequired
    • tlsboolean
    • sendBase64string
    • expectPrefixBase64string

Responses

200 The updated monitor.
Response body
  • namestringrequired
  • serviceIdstring
  • enabledbooleanrequired
  • intervalSecondsintegerrequired
  • vantagesstring[]required
  • timeoutMsintegerrequired
  • downConditionobjectrequired
    Show fields
    • confirmationsintegerrequired
    • quorumintegerrequired
  • httpobject
    Show fields
    • urlstring · urirequired
    • methodstring · enum

      GETHEADPOST

    • headersobject
      Show fields

      object

    • bodyBase64string
    • followRedirectsboolean
    • expectStatusstring[]
    • expectBodyContainsstring
  • tcpobject
    Show fields
    • hoststringrequired
    • portintegerrequired
    • tlsboolean
    • sendBase64string
    • expectPrefixBase64string
  • idstringrequired
  • kindstring · enumrequired

    tcphttp

  • statestring · enum

    pendingupdown

  • stateSincestring
  • createdAtstringrequired
  • updatedAtstringrequired
401 No valid session.
Response body
  • errorstringrequired
403 Uptime is not enabled for this organization (private beta), or the monitor quota is reached.
Response body
  • errorstringrequired
404 Unknown service or monitor.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
DELETE /api/v1/uptime/services/{id} #

Delete an uptime service

Refused (409) while monitors are still attached — detach or delete them first; there is no implicit cascade.

Parameters

  • id path string required

Responses

204 Deleted.
401 No valid session.
Response body
  • errorstringrequired
403 Uptime is not enabled for this organization (private beta), or the monitor quota is reached.
Response body
  • errorstringrequired
404 Unknown service or monitor.
Response body
  • errorstringrequired
409 Monitors are still attached.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
DELETE /api/v1/uptime/monitors/{id} #

Delete a monitor

Soft delete Lookout-side — history and billing survive.

Parameters

  • id path string required

Responses

204 Deleted.
401 No valid session.
Response body
  • errorstringrequired
403 Uptime is not enabled for this organization (private beta), or the monitor quota is reached.
Response body
  • errorstringrequired
404 Unknown service or monitor.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
DELETE /api/v1/uptime/export-tokens/{id} #

Revoke a Prometheus export token

Revocation is immediate — in-flight scrapes get a 401.

Parameters

  • id path string required

Responses

204 Revoked.
401 No valid session.
Response body
  • errorstringrequired
403 Uptime is not enabled for this organization (private beta), or the monitor quota is reached.
Response body
  • errorstringrequired
404 Unknown service or monitor.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
GET /api/v1/uptime/monitors/{id}/metrics #

Windowed per-vantage check metrics

Latency + up/down series and per-vantage uptime %, read through Lookout from the metrics store. 503 when metrics are temporarily unavailable (the monitor itself is unaffected).

Parameters

  • id path string required
  • window query string · enum

Responses

200 The windowed metrics view.
Response body
  • windowstring · enumrequired

    1h24h7d

  • stepSecondsintegerrequired
  • uptimePctobjectrequired
    Show fields

    object

  • seriesUptimeMetricsSeries[]required
    Show fields
    • vantagestringrequired
    • pointsUptimeMetricsPoint[]required
      Show fields
      • tnumberrequired
      • latencyMsnumberrequired
      • upnumberrequired
401 No valid session.
Response body
  • errorstringrequired
403 Uptime is not enabled for this organization (private beta), or the monitor quota is reached.
Response body
  • errorstringrequired
404 Unknown service or monitor.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
503 Metrics temporarily unavailable.
Response body
  • errorstringrequired
GET /api/v1/uptime/monitors/{id}/failures #

Recent check failures

Newest first; snippets are already truncated at capture.

Parameters

  • id path string required

Responses

200 The recent failures feed.
Response body
  • failuresUptimeFailure[]required
    Show fields
    • atstringrequired
    • vantagestringrequired
    • attemptintegerrequired
    • outcomestring · enumrequired

      failerror

    • errorKindstringrequired
    • errorDetailstringrequired
    • responseSnippetstringrequired
401 No valid session.
Response body
  • errorstringrequired
403 Uptime is not enabled for this organization (private beta), or the monitor quota is reached.
Response body
  • errorstringrequired
404 Unknown service or monitor.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired
GET /api/v1/uptime/monitors/{id}/transitions #

Monitor state history

Down-condition-driven state changes, most recent first (≤50).

Parameters

  • id path string required

Responses

200 The state-transition history.
Response body
  • transitionsUptimeTransition[]required
    Show fields
    • atstringrequired
    • fromstring · enumrequired

      pendingupdown

    • tostring · enumrequired

      pendingupdown

    • failingVantagesstring[]required
401 No valid session.
Response body
  • errorstringrequired
403 Uptime is not enabled for this organization (private beta), or the monitor quota is reached.
Response body
  • errorstringrequired
404 Unknown service or monitor.
Response body
  • errorstringrequired
502 The Lookout service is unreachable.
Response body
  • errorstringrequired