Skip to content
WatchTower15Docs

public.servers.incidents

GET
/servers/{server_uuid}/incidents
curl --request GET \
  --url 'https://rest.watchtower15.com/v1/servers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/incidents?direction=asc&include_total=true' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
server_uuid
required
string format: uuid

Query Parameters

Section titled “Query Parameters”
status
Array<string> | null
Allowed values: open acknowledged resolved
direction
string | null
Allowed values: asc desc
period
string | null

A relative window ending now: 1 to 9999 minutes, hours, days or weeks (3h, 2w). Not with from and to. The operation names its longest window and its default.

from
string | null

The start of a pinned window, epoch milliseconds or RFC 3339 with an offset. Needs to. A start before the oldest data kept is served from it.

to
string | null

The end of a pinned window, epoch milliseconds or RFC 3339 with an offset, after from. A window that ends before the oldest data kept, or in the future, is refused.

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”

ServersIncidentsResource

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

One of open, acknowledged, resolved.

string
severity
required

One of warning, critical.

string
message
required
string
rule_name
required

The alarm’s own name, which tells apart two alarms on one metric.

string
rule_slug
required
metric_name
required
scan_type
required
entity
required

The resource the incident is about: the server, or one of its volumes, ports or units.

object
type
required
uuid
required
name
required
parent_entity
required

The server of a volume, port or unit; null for every other entity.

object
type
required
string
uuid
required
string
triggered_at
required
integer | null
acknowledged_at
required
integer | null
acknowledged_by
required
object
name
required
string | null
resolved_at
required
integer | null
resolved_by
required
object
name
required
string | null
resolved_by_system
required

Whether the system resolved it (the condition cleared), not a person.

boolean
console_url
required
string
next_cursor
required
string | null
total

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

integer

Example generated

{
  "data": [
    {
      "uuid": "example",
      "status": "example",
      "severity": "example",
      "message": "example",
      "rule_name": "example",
      "rule_slug": "example",
      "metric_name": "example",
      "scan_type": "example",
      "entity": {
        "type": "example",
        "uuid": "example",
        "name": "example"
      },
      "parent_entity": {
        "type": "example",
        "uuid": "example"
      },
      "triggered_at": 1,
      "acknowledged_at": 1,
      "acknowledged_by": {
        "name": "example"
      },
      "resolved_at": 1,
      "resolved_by": {
        "name": "example"
      },
      "resolved_by_system": true,
      "console_url": "example"
    }
  ],
  "next_cursor": "example",
  "total": 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
}