Skip to content
WatchTower15Docs

public.databases.list

GET
/databases
curl --request GET \
  --url 'https://rest.watchtower15.com/v1/databases?sort=name&direction=asc&include_total=true' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
search
string | null
<= 255 characters
status
Array<string> | null
Allowed values: draft awaiting_collector verifying active failing paused
provider
Array<string> | null
health
Array<string> | null
Allowed values: unknown healthy warning critical
tag_uuids
Array<string> | null
sort
string | null
Allowed values: name health_status status last_received_at
direction
string | null
Allowed values: asc desc
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”

DatabasesListResource

Media typeapplication/json
object
data
required
Array<object>
object
uuid
required
string
name
required
string
engine
required
string | null
engine_version
required
string | null
provider
required

The hosting provider’s key, such as aws_rds_mysql.

string | null
health_status
required

One of unknown, healthy, warning, critical.

string
status
required

One of draft, awaiting_collector, verifying, active, failing, paused.

string
status_reason
required

Why the status is what it is, in words.

string | null
active
required

Whether monitoring is switched on.

boolean
privacy_mode
required

How much of the database’s text the monitor keeps: hashed, identifiers or counts.

string
qps
required

Queries per second, the latest value; null without a report in the last 2 minutes.

number | null
connections_percent
required

Connections in use as a percentage of the maximum; null without a report in the last 2 minutes.

number | null
storage_size_bytes
required
integer | null
storage_growth_30d_bytes
required

The 30-day projection less the size, while the forecast is ok.

integer | null
storage_days_to_full
required
integer | null
storage_forecast_status
required

The forecast’s status; null before the first forecast.

string | null
over_privileged
required

Whether a collector holds more privilege than it needs.

boolean
last_received_at
required

Epoch milliseconds: when a report last arrived; null if none ever did.

integer | null
tags
required
Array<object>
object
uuid
required
string
name
required
string
console_url
required

The database’s page in the console.

string
next_cursor
required
string | null
total

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

integer

Example generated

{
  "data": [
    {
      "uuid": "example",
      "name": "example",
      "engine": "example",
      "engine_version": "example",
      "provider": "example",
      "health_status": "example",
      "status": "example",
      "status_reason": "example",
      "active": true,
      "privacy_mode": "example",
      "qps": 1,
      "connections_percent": 1,
      "storage_size_bytes": 1,
      "storage_growth_30d_bytes": 1,
      "storage_days_to_full": 1,
      "storage_forecast_status": "example",
      "over_privileged": true,
      "last_received_at": 1,
      "tags": [
        {
          "uuid": "example",
          "name": "example"
        }
      ],
      "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
}