Cloady Docs
API ReferenceEndpointsApplications

Read a database's tables, sizes and unused indexes

Returns each database's size, the largest 100 tables or collections with rows, table and index bytes, dead tuples and vacuum state on Postgres and reclaimable space elsewhere, and the indexes nothing has used since the counters began. Names the schema, so it needs the developer role.

GET
/api/workspaces/{workspaceSlug}/apps/{appSlug}/services/{serviceName}/engine/storage

Authorization

cloady
AuthorizationBearer <token>

Personal API token (cldy_…)

In: header

Path Parameters

workspaceSlug*string
appSlug*string
serviceName*string

Query Parameters

env?string

Value in

  • "production"
  • "preview"
  • "development"
region?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/workspaces/string/apps/string/services/string/engine/storage"
{  "ts": 0,  "engine": "postgres",  "databases": [    {      "name": "string",      "bytes": 0    }  ],  "tables": [    {      "database": "string",      "schema": "string",      "name": "string",      "kind": "string",      "rows": 0,      "tableBytes": 0,      "indexBytes": 0,      "deadRows": 0,      "deadRatio": 0,      "reclaimableBytes": 0,      "lastVacuum": 0,      "vacuumBehind": true    }  ],  "deadRows": 0,  "reclaimableBytes": 0,  "unused": [    {      "database": "string",      "table": "string",      "name": "string",      "bytes": 0    }  ],  "unusedSince": 0,  "unusedNote": "string",  "note": "string"}

Cancel a session's query or terminate the session DELETE

Cancels the statement a session is running (`mode=cancel`) or ends its connection (`mode=terminate`, the default): pg_cancel_backend or pg_terminate_backend, KILL QUERY or KILL, killOp on MongoDB, KILL QUERY on ClickHouse. `sessionId` comes from streamEngineSessions.

Read a service's volume usage over time GET

Returns the bytes used and the capacity of the volumes the compose service mounts, as the kubelet reports their filesystems, across `range`, and the growth per day over the last day of samples.