Skip to main content
GET
Show a site's database status

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, an opaque member token, or a verified One Auth identity access token. The credential alone identifies the member and company. Member session JWTs, and portal JWTs the server minted read-only, are refused with 403 on every write.

Path Parameters

site_id
string<uuid>
required

Public id of one of the member's sites.

Response

The database's state and limits.

The state and limits of a site's database.

status
integer
required

HTTP status code (mirrors the response status line).

data
object
required

The state and limits of a site's database. It holds no storage figure, no address, no secret and no vendor id.

meta
object
required

Envelope metadata present on every response.