Skip to content
WatchTower15Docs

public.health.summary

GET
/health/summary
curl --request GET \
  --url https://rest.watchtower15.com/v1/health/summary \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

HealthSummaryResource

Media typeapplication/json
object
data
required
HealthSummaryResource
object
generated_at
required

Epoch milliseconds.

integer
servers
required
object
available
required
boolean
active
integer
warning
integer
critical
integer
seen_last_5m
integer
seen_last_1h
integer
domains
required
object
available
required
boolean
active
integer
warning
integer
critical
integer
services
required
object
available
required
boolean
active
integer
warning
integer
critical
integer
log_sources
required
object
available
required
boolean
active
integer
warning
integer
critical
integer
received_last_5m
integer
received_last_1h
integer
scans
required
object
domains
required
object
available
required
boolean
last_1h
integer
last_24h
integer
services
required
object
available
required
boolean
last_1h
integer
last_24h
integer

Example generated

{
  "data": {
    "generated_at": 1,
    "servers": {
      "available": true,
      "active": 1,
      "warning": 1,
      "critical": 1,
      "seen_last_5m": 1,
      "seen_last_1h": 1
    },
    "domains": {
      "available": true,
      "active": 1,
      "warning": 1,
      "critical": 1
    },
    "services": {
      "available": true,
      "active": 1,
      "warning": 1,
      "critical": 1
    },
    "log_sources": {
      "available": true,
      "active": 1,
      "warning": 1,
      "critical": 1,
      "received_last_5m": 1,
      "received_last_1h": 1
    },
    "scans": {
      "domains": {
        "available": true,
        "last_1h": 1,
        "last_24h": 1
      },
      "services": {
        "available": true,
        "last_1h": 1,
        "last_24h": 1
      }
    }
  }
}

401

Section titled “401”

The API key is missing, malformed, expired or revoked.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

403

Section titled “403”

The key or its owner does not hold what the operation needs.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

429

Section titled “429”

A rate limit or the organisation’s daily limit is reached; Retry-After says when to retry.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}

500

Section titled “500”

An unexpected error.

Media typeapplication/problem+json
Problem
object
type
required

https://docs.watchtower15.com/api/errors/<code>/

string format: uri
title
required
string
status
required
integer
code
required
string
detail
required
string
request_id
required
string
errors
object
key
additional properties
Array<string>
limit
integer
used
integer

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "request_id": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "limit": 1,
  "used": 1
}