Skip to content
WatchTower15Docs

public.alarms.list

GET
/alarms
curl --request GET \
  --url 'https://rest.watchtower15.com/v1/alarms?entity_type=domain&entity_uuid=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&include_total=true' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
entity_type
required
string
Allowed values: domain service server log_source custom_metric database_instance server_port server_system_service server_volume
entity_uuid
required
string format: uuid
limit
integer | null
>= 1 <= 100
cursor
string | null
<= 512 characters
include_total
string | null
Allowed values: true false 1 0

Responses

Section titled “Responses”

200

Section titled “200”

AlarmsListResource

Media typeapplication/json
object
data
required
Array<object>
object
uuid
required
string
name
required

The alarm’s own name, else its rule’s.

string
rule_slug
required
metric_name
required

The catalogue rule’s name.

description
required
string | null
alarm_type
required

boolean or threshold, as the catalogue rule says.

string | null
unit
required
string | null
comparison_operator
required
string
aggregation
required
string | null
warning_threshold
required

The alarm’s own value, else the rule’s default.

number | null
critical_threshold
required

The alarm’s own value, else the rule’s default.

number | null
warning_window_minutes
required
integer | null
critical_window_minutes
required
integer | null
warning_consecutive_failures_count
required

Consecutive evaluations before a warning: the alarm’s own count, else the rule’s default.

integer
critical_consecutive_failures_count
required

Consecutive evaluations before a critical: the alarm’s own count, else the rule’s default.

integer
self_resolving
required

Whether the alarm clears itself when the condition ends (it sends no resolve notification).

boolean
active
required

Whether the alarm is switched on.

boolean
state
required

One of ok, warning, critical, inactive.

string
Allowed values: critical warning ok inactive
inactive_reason
required

switched_off or resource_inactive while state is inactive; null otherwise.

string | null
state_since
required

Epoch milliseconds: when the open incident was triggered, while state is warning or critical.

integer | null
acknowledged
required

Whether the open incident has been acknowledged.

boolean
next_cursor
required
string | null
total

The whole list’s size; present only with include_total=true.

integer
meta
object
entity
required

The resource whose alarms these are.

object
type
required

One of the types that have alarms.

string
uuid
required
string
name
required
string | null

Example 

{
  "data": [
    {
      "state": "critical"
    }
  ]
}

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
}