Skip to content
SupaCloud Docs
Select themeSelect language

`GET /api/usages` — every App-quota dimension the active workspace consumes (apps / storage / build minutes / bandwidth), each with its live tally + plan limit, in one round-trip.

GET
/api/usages
curl --request GET \
  --url https://example.com/api/usages

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

The aggregated App-quota usage for a workspace, returned by GET /api/usages.

object
apps
required

One usage dimension: a stable key, the live used tally and the plan limit in the same unit. limit = None means the plan grants unlimited (the bar renders neutral / unconstrained).

object
key
required

The entitlement feature key this dimension caps against.

string
limit

Plan ceiling in the same unit, or None for unlimited.

integer | null format: int64
used
required

Current usage in the dimension’s natural unit (count / MB / minutes / GB).

integer format: int64
bandwidth_gb
required

One usage dimension: a stable key, the live used tally and the plan limit in the same unit. limit = None means the plan grants unlimited (the bar renders neutral / unconstrained).

object
key
required

The entitlement feature key this dimension caps against.

string
limit

Plan ceiling in the same unit, or None for unlimited.

integer | null format: int64
used
required

Current usage in the dimension’s natural unit (count / MB / minutes / GB).

integer format: int64
build_minutes
required

One usage dimension: a stable key, the live used tally and the plan limit in the same unit. limit = None means the plan grants unlimited (the bar renders neutral / unconstrained).

object
key
required

The entitlement feature key this dimension caps against.

string
limit

Plan ceiling in the same unit, or None for unlimited.

integer | null format: int64
used
required

Current usage in the dimension’s natural unit (count / MB / minutes / GB).

integer format: int64
storage_mb
required

One usage dimension: a stable key, the live used tally and the plan limit in the same unit. limit = None means the plan grants unlimited (the bar renders neutral / unconstrained).

object
key
required

The entitlement feature key this dimension caps against.

string
limit

Plan ceiling in the same unit, or None for unlimited.

integer | null format: int64
used
required

Current usage in the dimension’s natural unit (count / MB / minutes / GB).

integer format: int64
workspace_id
required
string format: uuid
Examplegenerated
{
  "apps": {
    "key": "example",
    "limit": 1,
    "used": 1
  },
  "bandwidth_gb": {
    "key": "example",
    "limit": 1,
    "used": 1
  },
  "build_minutes": {
    "key": "example",
    "limit": 1,
    "used": 1
  },
  "storage_mb": {
    "key": "example",
    "limit": 1,
    "used": 1
  },
  "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}