Skip to main content
GET
Get quota usage for a specific metric

Authorizations

Authorization
string
header
required

workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at https://akua.dev/developers/api-tokens

Headers

akua-context
string

Optional workspace/scope context for the request. Carries a single workspace wire id (ws_…) today. Only needed for broad tokens — a workspace-owned token implies its workspace.

Required string length: 1 - 53
Example:

"ws_j572abc123def456"

Path Parameters

metric
string
required

Quota metric (URL-encoded service/resource).

Example:

"compute/machines"

Query Parameters

cluster_id
string

Cluster ID to include cluster-scoped concurrency quotas

Required string length: 1 - 54

Response

Quota info

metric
string
required

Metric: service/resource. Not unique on its own — see the scope field. Index by (metric, scope).

Example:

"compute/machines"

type
enum<string>
required

Allocation = max owned, rate = max per time window, concurrency = max in-flight, lifetime = a one-time grant. Only rate has a resets_at: a lifetime entitlement has no period, is never released by deleting the resource it funded, and reports its position in that one-way lifecycle as grant_state.

Available options:
allocation,
rate,
concurrency,
lifetime
Example:

"allocation"

scope
enum<string>
required

Identity the limit/usage numbers are bound to, and the second half of an entry's key. workspace is occupancy inside the workspace; principal aggregates across every workspace and organization owned by the same authenticated identity, so a new workspace does not grant fresh free capacity; cluster bounds in-flight work for one cluster. A metric enforced against more than one identity — every free-tier allocation, for example — returns one entry per scope, so (metric, scope) is the composite key. Indexing a listing by metric alone silently drops entries.

Available options:
workspace,
principal,
cluster
Example:

"workspace"

display_name
string
required
Example:

"Compute machines"

unit
enum<string>
required

Unit the limit/usage numbers are measured in.

Available options:
count,
cores,
bytes,
seconds,
count/day,
count/minute,
cents/day
Example:

"count"

limit
number
required
Example:

1

usage
number
required
Example:

0

remaining
number
required
Example:

1

resets_at
integer

For rate quotas only: Unix timestamp (seconds) at which the window resets. Absent on every other type, including lifetime, which has no period.

Required range: x >= 0
grant_state
enum<string>

For lifetime quotas only: state of the one-time grant.

Available options:
available,
consumed,
revoked
Example:

"available"