List all uptime monitors

GET

/v1/uptime/monitors

const url = 'https://api.overwatch.weareheavy.dev/v1/uptime/monitors';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.overwatch.weareheavy.dev/v1/uptime/monitors \
  --header 'x-api-key: <x-api-key>'

Every uptime monitor the caller can see across the organization, joined with its site’s hostname, plus the monitor quota. Each row’s denormalized status/status_since doubles as current status.

Authorizations

ApiKeyAuth
BearerAuth

Responses

200

The organization’s monitors and quota.

application/json

object

monitors

required

Array<object>

A stored uptime monitor. status/status_since double as current status.

object

required

string format: uuid

tenant_id

required

string

site_id

required

string format: uuid

url

required

string format: uri

name

required

string | null

cadence_seconds

required

integer

timeout_seconds

required

integer

enabled

required

integer

Allowed values: 0 1

alert_emails

required

JSON-encoded array of extra alert addresses.

string | null

alert_webhooks

required

JSON-encoded array of extra alert webhooks.

string | null

status

required

Consensus status written by the coordinator; unknown before the first probes.

string

Allowed values: up degraded down unknown

status_since

required

Epoch ms the current status began, or null.

integer | null

last_checked_at

required

Epoch ms of the last probe, or null.

integer | null

created_at

required

integer

updated_at

required

integer

quota

required

The organization’s pooled monitor allowance.

object

count

required

Monitors currently configured across the organization.

integer

included

required

Monitors included in the subscription (2 per site, unless operator-overridden).

integer

overageEnabled

required

boolean

Example

{
  "monitors": [
    {
      "enabled": 0,
      "status": "up"
    }
  ]
}

401

Missing or invalid credentials.

application/json

object

error

required

A human-readable error message.

string

Example

{
  "error": "invalid api key"
}