Skip to content
WatchTower15Docs

public.databases.findings

GET
/databases/{database_uuid}/findings
curl --request GET \
  --url 'https://rest.watchtower15.com/v1/databases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/findings?status=open&severity=critical&group=configuration&rule=config.buffer_pool_small&include_total=true' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Query Parameters

Section titled “Query Parameters”
status
string | null
Allowed values: open resolved dismissed
severity
string | null
Allowed values: critical warning info
group
string | null
Allowed values: configuration schema workload hardening
rule
string | null
Allowed values: config.buffer_pool_small config.connections_headroom config.tmp_disk_tables_high config.redo_capacity_low config.binlog_retention_short config.durability_relaxed config.table_open_cache_small schema.no_primary_key schema.redundant_index schema.unused_index schema.row_versions_near_limit schema.digest_table_full workload.no_index_statements workload.examined_vs_sent workload.full_joins hardening.secure_transport_off hardening.local_infile_on hardening.secure_file_priv_empty hardening.replica_writable hardening.open_accounts hardening.tls_certificate_expiring
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”

DatabasesFindingsResource

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

The advisor rule’s key, such as schema.no_primary_key.

string
group
required

The rule’s group: config, schema, workload or hardening.

string | null
object_kind
required

What the finding is about: instance, table, index, statement, account and so on.

string
object_key
required

The object’s key, which tells objects apart when their names are hidden.

string
object_names
required

The object’s names; null unless the database shows identifiers.

object | null
severity
required

One of critical, warning, info.

string
status
required

One of open, resolved, dismissed.

string
statement_text
required

A statement’s text; null unless the database shows identifiers.

string | null
first_seen_at
required

Epoch milliseconds.

integer | null
last_seen_at
required

Epoch milliseconds.

integer | null
resolved_at
required

Epoch milliseconds: when it stopped applying; null while it is open.

integer | null
dismissed_at
required

Epoch milliseconds: when it was dismissed; null otherwise.

integer | null
next_cursor
required
string | null
total

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

integer

Example generated

{
  "data": [
    {
      "uuid": "example",
      "rule_key": "example",
      "group": "example",
      "object_kind": "example",
      "object_key": "example",
      "object_names": "example",
      "severity": "example",
      "status": "example",
      "statement_text": "example",
      "first_seen_at": 1,
      "last_seen_at": 1,
      "resolved_at": 1,
      "dismissed_at": 1
    }
  ],
  "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
}