Hosts

Get a host's uptime aggregates

The aggregate ladder for a host at a chosen resolution, per-location plus the __all__ rollup, optionally windowed by [from, to), cursor-paginated.

get/v1/hosts/{hostname}/uptime

Request

  • Base URL: https://api.peppolstatus.com
  • URL: https://api.peppolstatus.com/v1/hosts/{hostname}/uptime
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

hostnamestring required

The host's fully-qualified hostname.

Query parameters

resolution'hourly' | 'daily' | 'monthly'

Aggregate tier. Defaults to hourly.

fromstring date-time

Inclusive lower bound (ISO 8601). Must not be after to.

tostring date-time

Exclusive upper bound (ISO 8601).

locationstring

Restrict to one probe location, or __all__ for the rollup.

limitinteger

Page size, clamped to [1, 200]. Defaults to 50.

cursorstring

Opaque pagination cursor returned as next_cursor by the previous page.

Response

A page of uptime buckets.

next_cursorstring nullable required

Opaque cursor for the next page, or null on the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.