> ## 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.

# Listar cotas

> Lista de cotas para a organização do chamador, juntamente com o uso atual e quaisquer substituições por organização. Filtrar por região com `?region=`; omitir isso retorna somente cotas de escopo global.

Cotas por recurso (ex. `domains_per_certificate`) NÃO são retornados aqui — eles são caps por pai, exibidos apenas como erros de validação na API de recursos relevante. Requer `quota:GetQuotas` permissão.


<Info>
  Requer a ação do IAM **`quota:GetQuotas`**. Consulte [permissões de cotas](/quota/permissions) para obter a lista completa, o que cada uma cobre e um exemplo de política.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/quota.yaml get /v1/quotas
openapi: 3.0.3
info:
  title: API de Basaltic Quota
  version: 1.0.0
  description: >
    Limites de cota da organização e consumo atual, por tipo de recurso e
    região. O acesso requer uma política de organização que conceda ações de
    cota.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://quota.basaltic.sh
    description: Endpoint global da API
security:
  - BearerAuth: []
paths:
  /v1/quotas:
    get:
      tags:
        - Quota
      summary: Listar cotas
      description: >
        Lista de cotas para a organização do chamador, juntamente com o uso
        atual e quaisquer substituições por organização. Filtrar por região com
        `?region=`; omitir isso retorna somente cotas de escopo global.


        Cotas por recurso (ex. `domains_per_certificate`) NÃO são retornados
        aqui — eles são caps por pai, exibidos apenas como erros de validação na
        API de recursos relevante. Requer `quota:GetQuotas` permissão.
      operationId: listQuotas
      parameters:
        - name: region
          in: query
          description: Região para filtrar cotas regionais. Omitir para global somente.
          required: false
          schema:
            type: string
            example: sa-saopaulo-1
      responses:
        '200':
          description: Lista de cotas efetivas + uso.
          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: >
            O serviço que possui a cota. Juntamente com resource_type, ele
            identifica a cota — resource_type sozinho não é único (ex. tanto
            compute quanto banco de dados têm uma cota de `instances`).
          example: compute
        resource_type:
          type: string
          description: >
            O recurso ao qual o limite se aplica. Veja
            migrations/quota/001_quotas.sql para a lista de seeds (instâncias,
            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: >-
            Limite efetivo (-1 = ilimitado). Substituir se definido, caso
            contrário padrão.
          example: 20
        in_use:
          type: integer
          description: >
            Recursos que estão consumindo essa cota. Zero para cotas por_recurso
            (sem contador em execução — o limite aplica-se por recurso pai).
          example: 5
        reserved:
          type: integer
          description: >
            Recursos temporariamente reservados durante a criação assíncrona.
            Zero para cotas por_recurso.
          example: 1
        available:
          type: integer
          description: limit - in_use - reservado, limitado a 0; -1 se ilimitado.
          example: 14
        is_default:
          type: boolean
          description: >-
            True se o limite for o padrão do sistema; false se houver uma
            substituição por organização.
          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: Código de erro identificando o tipo de erro
              example: INVALID_INPUT
            message:
              type: string
              description: Mensagem de erro legível pelo ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores não sensíveis opcionais para interpolação de erros
                localizados, codificados por código de erro. Nunca presente para
                erros de servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuração
              example: 550e8400-e29b-41d4-a716-446655440000
  responses:
    Unauthorized:
      description: Autenticação necessária ou token inválido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Permissões insuficientes
      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: Erro interno do servidor
      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:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Um token bearer OAuth 2.0, enviado como `Authorization: Bearer <token>`.
        Esta é a forma recomendada de autenticação.


        Obtenha o token trocando o par de chaves de acesso de uma conta de
        serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`.
        Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis
        com OAuth podem obter e renovar o token para você.


        ```

        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```


        Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso
        também serve como credencial AWS SigV4 para o endpoint de objetos
        compatível com S3, que aceita somente esse método de autenticação.


````

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