Read usage and limits

GET /v1/tenants/{tenant}/usage

Compare current usage with declared limitsA null capacity value is unknown, not unlimited.

Request tenant usageRead configuration, limits and live counters.
Compare units and scopeSeparate overall used counters from per-table usage.
Plan from known capacityInterpret each limit using its reported unit.

Before you start

Use your database bearer token.

Path parameters

Field	Type	Required
`tenant`	`string`	Required

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Read the result

used contains current counters and schemas contains per-table usage. Read each value with its unit; a null capacity value is unknown here, not an unlimited allowance.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
429	Honor Retry-After when present; back off.
502	Check service availability and the write outcome.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request GET "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/usage" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "tenant": "your-tenant",
  "meter": {},
  "used": {
    "store_keys": 20,
    "storage_bytes": 512,
    "graph_nodes": 3,
    "graph_edges": 3,
    "graph_counts_reconciled": true,
    "max_connections": null,
    "vector_counter_lost_bumps": 0,
    "ask_in_flight": 0,
    "vector_embeddings": 2,
    "reactive_subscriptions": 0
  },
  "schemas": [
    {
      "schema": "demo.people",
      "rows": 3,
      "bytes": 256,
      "segments": 1
    }
  ],
  "addon_calls": []
}

Illustrative counters for a standalone seeded tenant with no tier configuration; meter:{} means healthy. Storage and key counts are synthetic, not measured.

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Read the resultCopy Anchor Link

Response statusesCopy Anchor Link

Before you start

Path parameters

Headers

Read the result

Response statuses