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

> Lista os buckets de propriedade da conta solicitante, ordenados por nome em ordem crescente. Paginação por cursor usando o nome do bucket (globalmente único) — passa o último nome da página anterior como `marker` para buscar a próxima.


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


## OpenAPI

````yaml /pt/api-reference/specs/storage.yaml get /v1/buckets
openapi: 3.0.3
info:
  title: API de armazenamento Basaltic
  version: 1.0.0
  description: >
    As referências de armazenamento aceitam UUIDs, CRNs ou nomes de escopo em um
    campo. Os nomes de snapshot requerem um volume fixo; source_snapshot aceita
    somente UUID ou CRN aninhado. Bloqueie volumes com seus snapshots e
    políticas de snapshot, além de gerenciamento de bucket para armazenamento de
    objetos. O próprio protocolo de fio S3 é servido separadamente em
    `objects.{region}.basaltic.cloud`.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://storage.{region}.basaltic.sh
    description: Endpoint de API regional
    variables:
      region:
        default: sa-saopaulo-1
        description: Código de região
security:
  - BearerAuth: []
paths:
  /v1/buckets:
    get:
      tags:
        - Buckets
      summary: Listar buckets
      description: >
        Lista os buckets de propriedade da conta solicitante, ordenados por nome
        em ordem crescente. Paginação por cursor usando o nome do bucket
        (globalmente único) — passa o último nome da página anterior como
        `marker` para buscar a próxima.
      operationId: listBuckets
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 50
            example: 50
        - name: marker
          in: query
          schema:
            type: string
            example: my-app-assets
          description: >-
            Token de continuação — o último nome do intervalo da página
            anterior.
        - name: name
          in: query
          description: >-
            Nome exato do intervalo com escopo de conta; um valor vazio não
            corresponde a nada.
          schema:
            type: string
        - name: crn
          in: query
          description: >-
            Filtro CRN exato. CRNs malformados retornam 400; contas
            estrangeiras, regiões ou tipos de recursos retornam uma página
            vazia. Intersecta todos os outros filtros.
          schema:
            type: string
      responses:
        '200':
          description: Compartimentos na conta solicitante.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BucketListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: O chamador não tem a permissão IAM necessária.
      security:
        - BearerAuth: []
components:
  schemas:
    BucketListResponse:
      type: object
      properties:
        buckets:
          type: array
          items:
            $ref: '#/components/schemas/Bucket'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    Bucket:
      type: object
      required:
        - id
        - name
        - crn
        - acl
        - versioning
        - deletion_protection
        - recovery_window_days
        - deleted_at
        - created_at
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          example: c4e2a1f8-6b3d-4e9a-8c7f-2d1e0a3b4c5d
        name:
          description: >-
            Os nomes de recursos não devem começar com o prefixo literal crn: ou
            ser UUIDs (formas canônicas, compactas, entre colchetes ou
            urn:uuid:, em qualquer caso).
          type: string
          example: my-app-assets
        crn:
          type: string
          example: crn:storage:sa-saopaulo-1:platform:bucket/my-app-assets
          readOnly: true
        acl:
          type: string
          example: private
        versioning:
          type: string
          description: >-
            Estado de versionamento. `suspended` significa que o versionamento
            estava ligado e foi desligado — as versões existentes são mantidas,
            novas gravações param de criá-las — o que é distinto de `disabled`,
            um bucket que nunca o teve habilitado. O endpoint compatível com S3
            escreve os mesmos estados `Enabled` / `Suspended` em seu XML e
            relata `disabled` omitindo o elemento.
          enum:
            - disabled
            - enabled
            - suspended
          example: disabled
        deletion_protection:
          type: boolean
          description: >-
            Quando true, DeleteBucket agenda a exclusão em vez de remover o
            bucket imediatamente. O padrão false deliberadamente preserva a
            exclusão imediata do S3.
          default: false
          example: false
        recovery_window_days:
          type: integer
          description: >-
            Janela de recuperação configurada em dias inteiros (padrão 7). Novas
            gravações exigem 1-30; buckets históricos desabilitados podem reter
            valores legados fora do intervalo.
          example: 7
        deleted_at:
          type: string
          format: date-time
          nullable: true
          readOnly: true
          description: >-
            Quando a exclusão foi solicitada; nulo quando não pendente ou para
            janelas históricas.
        scheduled_purge_at:
          type: string
          format: date-time
          readOnly: true
          description: >-
            Prazo de limpeza, presente enquanto a exclusão está pendente.
            Restaure antes desse tempo para cancelar.
          example: '2026-01-22T09:30:00Z'
        created_at:
          type: string
          format: date-time
          readOnly: true
          example: '2026-01-15T09:30:00Z'
    PaginationMeta:
      type: object
      properties:
        total:
          type: integer
          description: Número total de itens
          example: 150
        limit:
          type: integer
          description: Número de itens por página
          example: 20
        marker:
          type: string
          description: >-
            Cursor opaco para a próxima página. Passe-o de volta como o
            parâmetro de consulta `marker`; trate-o como um token, não um valor
            para analisar.
          example: 550e8400-e29b-41d4-a716-446655440000
        has_more:
          type: boolean
          description: Se há mais itens
          example: true
    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:
    BadRequest:
      description: Parâmetros de solicitação inválidos
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: INVALID_INPUT
              message: Invalid request parameters
              request_id: 550e8400-e29b-41d4-a716-446655440000
    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
  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.