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

# List quotas

> List quotas for the caller's organization, joined with current
usage and any per-org overrides. Filter by region with `?region=`;
omitting it returns global-scoped quotas only.

Per-resource quotas (e.g. `domains_per_certificate`) are NOT
returned here — they're per-parent caps, surfaced only as
validation errors at the relevant resource API.
Requires `quota:GetQuotas` permission.




## OpenAPI

````yaml /api-reference/specs/quota.yaml get /v1/quotas
openapi: 3.0.3
info:
  title: Basaltic Quota API
  version: 1.0.0
  description: |
    The account's limits and its current consumption, per resource type and
    region.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://quota.basaltic.sh
    description: Global API endpoint
security:
  - SignatureAuth: []
paths:
  /v1/quotas:
    get:
      tags:
        - Quota
      summary: List quotas
      description: |
        List quotas for the caller's organization, joined with current
        usage and any per-org overrides. Filter by region with `?region=`;
        omitting it returns global-scoped quotas only.

        Per-resource quotas (e.g. `domains_per_certificate`) are NOT
        returned here — they're per-parent caps, surfaced only as
        validation errors at the relevant resource API.
        Requires `quota:GetQuotas` permission.
      operationId: listQuotas
      parameters:
        - name: region
          in: query
          description: Region to filter regional quotas by. Omit for global only.
          required: false
          schema:
            type: string
            example: sa-saopaulo-1
      responses:
        '200':
          description: List of effective quotas + usage.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuotaListResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    QuotaListResponse:
      type: object
      required:
        - quotas
      properties:
        quotas:
          type: array
          items:
            $ref: '#/components/schemas/QuotaItem'
    QuotaItem:
      type: object
      required:
        - service
        - resource_type
        - scope
        - limit
        - in_use
        - reserved
        - available
        - is_default
        - description
      properties:
        service:
          type: string
          description: |
            The service that owns the quota. Together with resource_type it
            identifies the quota — resource_type alone is not unique (e.g. both
            compute and database have an `instances` quota).
          example: compute
        resource_type:
          type: string
          description: |
            The resource the cap applies to. See migrations/quota/001_quotas.sql
            for the seeded list (instances, vcpus, ram_mb, volumes, …,
            domains_per_certificate, records_per_zone, …).
          example: instances
        scope:
          type: string
          enum:
            - regional
            - global
            - per_resource
          example: regional
        limit:
          type: integer
          description: >-
            Effective limit (-1 = unlimited). Override if set, otherwise
            default.
          example: 20
        in_use:
          type: integer
          description: |
            Resources currently consuming this quota. Zero for per_resource
            quotas (no running counter — the cap applies per parent resource).
          example: 5
        reserved:
          type: integer
          description: |
            Resources temporarily reserved during async creation. Zero for
            per_resource quotas.
          example: 1
        available:
          type: integer
          description: limit - in_use - reserved, floored at 0; -1 if unlimited.
          example: 14
        is_default:
          type: boolean
          description: >-
            True if the limit comes from the system default; false if there is a
            per-org override.
          example: true
        description:
          type: string
          example: Maximum number of compute instances
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Error code identifying the type of error
              example: INVALID_INPUT
            message:
              type: string
              description: Human-readable error message
              example: Invalid request parameters
            request_id:
              type: string
              format: uuid
              description: Request ID for debugging
              example: 550e8400-e29b-41d4-a716-446655440000
  responses:
    Unauthorized:
      description: Authentication required or token invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INTERNAL_ERROR
              message: An internal error occurred
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    SignatureAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >
        Request signing with an access key issued to a service account. An

        HMAC-SHA256 over a canonical form of the request, close to AWS SigV4.

        The `basaltic` CLI signs for you.


        Send `Authorization`, `X-Date` (UTC, `YYYYMMDDTHHMMSSZ`) and `X-Nonce`

        (random per request); add `X-Content-Sha256` to bind a body, and

        `X-Amz-Security-Token` when using temporary credentials.


        ```

        Authorization: BASALTIC-HMAC-SHA256
        Credential=<access_key_id>/<date>/<region>/basaltic/basaltic_request,
        SignedHeaders=host;x-date;x-nonce, Signature=<hex>

        ```


        `<region>` is the region code you are calling, or `global` for the
        global

        services. A signature is valid for 5 minutes from `X-Date`, and mutating

        requests are replay-guarded on the nonce.


        **Full signing procedure, including a working implementation:**

        https://docs.basaltic.sh/authentication


        ## Rate limits

        There is no global request budget. A limit applies only where an

        operation documents a `429`, and that operation says what it counts.

        Those responses carry `X-RateLimit-Limit`, `X-RateLimit-Remaining`,

        `X-RateLimit-Reset` and, on a `429`, `Retry-After` — read them rather

        than hard-coding a number. Retrying before `Retry-After` is refused and

        extends the window. Everything else is bounded by quota, not by request

        rate.

````