Skip to content

public.databases.view

GET
/databases/{database_uuid}
curl --request GET \
--url https://rest.watchtower15.com/v1/databases/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>'
database_uuid
required
string format: uuid

DatabasesViewResource

Media typeapplication/json
object
data
required
DatabasesViewResource
object
uuid
required
string
name
required
string
description
required
string | null
provider
required

The hosting provider’s key, such as aws_rds_mysql.

string | null
provider_edition
required
string | null
engine
required
string | null
engine_version
required
string | null
engine_flavour
required
string | null
privacy_mode
required

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

string
tls_mode
required
string | null
health_status
required

One of unknown, healthy, warning, critical.

string
status
required

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

string
over_privileged
required

Whether a collector holds more privilege than it needs.

boolean
layers_available
required

What the collector’s probe found it can read, by layer; null before the first probe.

object | null
storage
required
object
size_bytes
required
integer | null
growth_30d_bytes
required

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

integer | null
days_to_full
required
integer | null
forecast_status
required

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

string | null
ceiling_gib
required

The storage ceiling set by hand, in GiB.

integer | null
measured_at
required

Epoch milliseconds: when the size was measured.

integer | null
schema
required

The schema collector’s state; its first seven fields are null while no pass has run.

object
outcome
required

The last attempt’s outcome.

string | null
last_attempt_at
required

Epoch milliseconds: the last attempt.

integer | null
last_pass_at
required

Epoch milliseconds: the last pass the database answered.

integer | null
next_pass_at
required

Epoch milliseconds: the next pass.

integer | null
paused_reason
required

Why passes are paused, when they are.

string | null
paused_since
required

Epoch milliseconds: since when passes are paused.

integer | null
object_counts
required

Int, views: int, routines: int}|null The object counts of the last answered pass; null before one.

object
tables
required
integer
views
required
integer
routines
required
integer
history_started_at
required

Epoch milliseconds: when the schema history began.

integer | null
last_change_at
required

Epoch milliseconds: the last schema change.

integer | null
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

Example generated

{
"data": {
"uuid": "example",
"name": "example",
"description": "example",
"provider": "example",
"provider_edition": "example",
"engine": "example",
"engine_version": "example",
"engine_flavour": "example",
"privacy_mode": "example",
"tls_mode": "example",
"health_status": "example",
"status": "example",
"over_privileged": true,
"layers_available": "example",
"storage": {
"size_bytes": 1,
"growth_30d_bytes": 1,
"days_to_full": 1,
"forecast_status": "example",
"ceiling_gib": 1,
"measured_at": 1
},
"schema": {
"outcome": "example",
"last_attempt_at": 1,
"last_pass_at": 1,
"next_pass_at": 1,
"paused_reason": "example",
"paused_since": 1,
"object_counts": {
"tables": 1,
"views": 1,
"routines": 1
},
"history_started_at": 1,
"last_change_at": 1
},
"last_received_at": 1,
"tags": [
{
"uuid": "example",
"name": "example"
}
],
"console_url": "example"
}
}

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
}

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
}

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
}

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
}

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
}

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
}