Skip to content

public.databases.storage

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

DatabasesStorageResource

Media typeapplication/json
object
data
required
DatabasesStorageResource
object
measured_at
required

Epoch milliseconds: when the sizes were measured; null before the first measurement.

integer | null
size_bytes
required

The instance’s size.

integer | null
days_to_full
required

Days until the storage is full.

integer | null
forecast_status
required

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

string | null
growth_bytes_per_day
required
integer | null
projections
required

The forecast’s projected size, in bytes, after 30, 90, 180 and 365 days; each null with no forecast or too little history.

object
days_30
required
integer | null
days_90
required
integer | null
days_180
required
integer | null
days_365
required
integer | null
ceiling
required

What the forecast measures against; both null before the first forecast.

object
source
required

One of volume, manual, reported, none.

string | null
bytes
required
integer | null
schemas
required

The current schemas, largest first; empty in counts mode. A name is null unless the database shows identifiers.

Array<object>
object
key
required

The stored schema key, which tells schemas apart when their names are hidden.

string
name
required
string | null
size_bytes
required
integer
table_count
required
integer
tables
required

The current tables, largest first; empty in counts mode. A name is null unless the database shows identifiers.

Array<object>
object
key
required

The stored table key, which tells tables apart when their names are hidden.

string
schema_key
required

The key of the table’s schema.

string | null
name
required
string | null
size_bytes
required
integer
rows_estimate
required
integer | null

Example generated

{
"data": {
"measured_at": 1,
"size_bytes": 1,
"days_to_full": 1,
"forecast_status": "example",
"growth_bytes_per_day": 1,
"projections": {
"days_30": 1,
"days_90": 1,
"days_180": 1,
"days_365": 1
},
"ceiling": {
"source": "example",
"bytes": 1
},
"schemas": [
{
"key": "example",
"name": "example",
"size_bytes": 1,
"table_count": 1
}
],
"tables": [
{
"key": "example",
"schema_key": "example",
"name": "example",
"size_bytes": 1,
"rows_estimate": 1
}
]
}
}

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
}