Skip to content
WatchTower15Docs

public.health.map

GET
/health/map
curl --request GET \
  --url 'https://rest.watchtower15.com/v1/health/map?include_healthy=true' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
types
Array<string> | null
unique items
Allowed values: servers domains services log_sources custom_metrics databases
include_healthy
string | null
Allowed values: true false 1 0
limit
integer | null
>= 1 <= 100

Responses

Section titled “Responses”

200

Section titled “200”

HealthMapResource

Media typeapplication/json
object
data
required
HealthMapResource
object
types
required
Array<object>
object
type
required
string
available
required
boolean
total
integer
counts
object
critical
required
integer
unreachable
required
integer
warning
required
integer
unknown
required
integer
healthy
required
integer
unwatched
required
integer
rows
Array<object>
object
entity
required
object
type
required
string
uuid
required
string
name
required
string
console_url
required
string
health
required
string
bucket
required
string
note
required
string | null
since_at
required
integer | null
issue_count
required
integer
issues
required
Array<object>
object
severity
required
string
name
required
string
subject
required
string | null
since_at
required
integer | null
acknowledged
required
boolean
rows_omitted
integer

Example generated

{
  "data": {
    "types": [
      {
        "type": "example",
        "available": true,
        "total": 1,
        "counts": {
          "critical": 1,
          "unreachable": 1,
          "warning": 1,
          "unknown": 1,
          "healthy": 1,
          "unwatched": 1
        },
        "rows": [
          {
            "entity": {
              "type": "example",
              "uuid": "example",
              "name": "example"
            },
            "console_url": "example",
            "health": "example",
            "bucket": "example",
            "note": "example",
            "since_at": 1,
            "issue_count": 1,
            "issues": [
              {
                "severity": "example",
                "name": "example",
                "subject": "example",
                "since_at": 1,
                "acknowledged": true
              }
            ]
          }
        ],
        "rows_omitted": 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
}

404

Section titled “404”

No such record in this organisation (an absent id and another organisation’s answer alike).

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
}

422

Section titled “422”

The request is invalid; errors names the parameters.

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
}