> ## Documentation Index
> Fetch the complete documentation index at: https://docs.akua.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# List quota usage for the authenticated user

> Returns current usage and limits for all quota metrics. With workspace context, allocation quotas are scoped to that workspace. Without context, allocation quotas retain the user-wide view. Rate quotas are user-scoped, and concurrency quotas are per-cluster when `cluster_id` is supplied.



## OpenAPI

````yaml /openapi-public.json get /quotas
openapi: 3.1.0
info:
  title: Akua API
  version: 1.0.0
  description: >-
    Public API for managing Akua workspaces, clusters, products, and installs.


    Authenticate with a workspace API token via the `Authorization: Bearer
    sk_akua_...` header.


    A workspace-owned token implies its workspace. Broad tokens select the
    active workspace via the optional `Akua-Context` header.
  contact:
    name: Akua API support
    email: support@akua.dev
    url: https://akua.dev/docs
servers:
  - url: https://api.akua.dev/v1
    description: Production
security: []
tags:
  - name: Auth
    description: Authentication and token management.
  - name: Agent events
    description: Persisted agent transcripts and response recovery.
  - name: Custom domains
    description: Workspace custom domains and routing targets.
  - name: Cloudflare
    description: Cloudflare account credentials and gateway control.
  - name: Clusters
    description: Kubernetes clusters and cluster access operations.
  - name: ComputeConfigs
    description: Workspace compute provider configurations.
  - name: Entitlements
    description: Effective workspace capabilities and limits.
  - name: Dashboards
    description: Dashboard and widget resources.
  - name: Installs
    description: Installation and render operations.
  - name: Machines
    description: Compute machines and lifecycle events.
  - name: Notifications
    description: User notification state.
  - name: Offer Channels
    description: Private offer channels and policy versions.
  - name: Offers
    description: Marketplace offers and redemption tracking.
  - name: Operations
    description: Long-running operation status and controls.
  - name: Order Drafts
    description: Draft checkout orders and checkout sessions.
  - name: Organizations
    description: Organizations, memberships, and managed workspaces.
  - name: Packages
    description: Software packages, versions, and input schemas.
  - name: Products
    description: Marketplace product catalog resources.
  - name: Preview hostnames
    description: Install preview hostnames and routing state.
  - name: Quotas
    description: Workspace quota limits and usage.
  - name: Regions
    description: Available deployment regions.
  - name: Registry
    description: Container registry credentials and repositories.
  - name: Repository change requests
    description: Fork-backed repository change reviews and lifecycle actions.
  - name: Repositories
    description: Source repositories available to the workspace.
  - name: Secrets
    description: Workspace secrets and secret versions.
  - name: Snippets
    description: Reusable snippets and snippet runs.
  - name: Workspace subdomains
    description: Workspace subdomain identity.
  - name: Workspaces
    description: Workspace resources, members, and billing state.
paths:
  /quotas:
    get:
      tags:
        - Quotas
      summary: List quota usage for the authenticated user
      description: >-
        Returns current usage and limits for all quota metrics. With workspace
        context, allocation quotas are scoped to that workspace. Without
        context, allocation quotas retain the user-wide view. Rate quotas are
        user-scoped, and concurrency quotas are per-cluster when `cluster_id` is
        supplied.
      operationId: quotas.list
      parameters:
        - name: akua-context
          in: header
          schema:
            type: string
            minLength: 1
            maxLength: 53
            description: >-
              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.
            examples:
              - ws_j572abc123def456
          required: false
        - name: cluster_id
          in: query
          schema:
            type: string
            description: Cluster ID to include cluster-scoped concurrency quotas
            minLength: 1
            maxLength: 54
          required: false
      responses:
        '200':
          description: Quota info for all metrics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuotaInfoList'
        '401':
          description: Missing, invalid or expired credential.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiUnauthorized'
        '403':
          description: The credential may not act in this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiForbidden'
      security:
        - BearerAuth: []
components:
  schemas:
    QuotaInfoList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/QuotaInfo'
        has_more:
          type: boolean
          description: True if more items exist after this page.
        next_cursor:
          anyOf:
            - type: string
            - type: 'null'
          description: Opaque cursor for the next page, or null if no more pages.
      required:
        - data
        - has_more
        - next_cursor
      additionalProperties: false
    ApiUnauthorized:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - Unauthorized
        success:
          type: boolean
          enum:
            - false
        errors:
          type: array
          prefixItems:
            - $ref: '#/components/schemas/ApiErrorEntry'
          minItems: 1
          items:
            $ref: '#/components/schemas/ApiErrorEntry'
        result:
          type: object
          additionalProperties: false
      required:
        - _tag
        - success
        - errors
        - result
      additionalProperties: false
    ApiForbidden:
      type: object
      properties:
        _tag:
          type: string
          enum:
            - Forbidden
        success:
          type: boolean
          enum:
            - false
        errors:
          type: array
          prefixItems:
            - $ref: '#/components/schemas/ApiErrorEntry'
          minItems: 1
          items:
            $ref: '#/components/schemas/ApiErrorEntry'
        result:
          type: object
          additionalProperties: false
      required:
        - _tag
        - success
        - errors
        - result
      additionalProperties: false
    QuotaInfo:
      type: object
      properties:
        metric:
          type: string
          description: >-
            Metric: service/resource. Not unique on its own — see the `scope`
            field. Index by `(metric, scope)`.
          examples:
            - compute/machines
        type:
          type: string
          enum:
            - allocation
            - rate
            - concurrency
            - lifetime
          description: >-
            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`.
          examples:
            - allocation
        scope:
          type: string
          enum:
            - workspace
            - principal
            - cluster
          description: >-
            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.
          examples:
            - workspace
        display_name:
          type: string
          examples:
            - Compute machines
        unit:
          type: string
          enum:
            - count
            - cores
            - bytes
            - seconds
            - count/day
            - count/minute
            - cents/day
          description: Unit the limit/usage numbers are measured in.
          examples:
            - count
        limit:
          type: number
          examples:
            - 1
        usage:
          type: number
          examples:
            - 0
        remaining:
          type: number
          examples:
            - 1
        resets_at:
          type: integer
          description: >-
            For rate quotas only: Unix timestamp (seconds) at which the window
            resets. Absent on every other type, including `lifetime`, which has
            no period.
          minimum: 0
        grant_state:
          type: string
          enum:
            - available
            - consumed
            - revoked
          description: 'For `lifetime` quotas only: state of the one-time grant.'
          examples:
            - available
      required:
        - metric
        - type
        - scope
        - display_name
        - unit
        - limit
        - usage
        - remaining
      additionalProperties: false
    ApiErrorEntry:
      type: object
      properties:
        code:
          type: integer
          description: Machine-readable error code
          examples:
            - 7002
        message:
          type: string
          description: Human-readable error message
          examples:
            - Resource not found
        path:
          type: array
          items:
            type: string
          description: Field path that caused the error, when applicable
          examples:
            - - body
              - name
        metadata:
          type: object
          additionalProperties:
            type: string
      required:
        - code
        - message
      additionalProperties: false
  securitySchemes:
    BearerAuth:
      description: >-
        workspace API token (sk_akua_...) or OAuth2 JWT. Create tokens at
        https://akua.dev/developers/api-tokens
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.