> ## 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
> Muestra los buckets propiedad de la cuenta solicitante, ordenados por nombre en orden ascendente. Paginación por cursor usando el nombre del bucket (único globalmente) — pasa el último nombre de la página anterior como `marker` para buscar la siguiente.
Requiere la acción de IAM **`storage:ListAllMyBuckets`**. Consulte [permisos de almacenamiento](/es/storage/permissions) para obtener la lista completa, lo que cubre cada una y un ejemplo de política.
## OpenAPI
````yaml /es/api-reference/specs/storage.yaml get /v1/buckets
openapi: 3.0.3
info:
title: API de almacenamiento de Basaltic
version: 1.0.0
description: >
Las referencias de almacenamiento aceptan UUID, CRN o nombres de ámbito en
un campo. Los nombres de instantáneas requieren un volumen fijo;
source_snapshot solo acepta UUID o CRN anidado. Bloquee volúmenes con sus
instantáneas y políticas de instantáneas, además de la administración de
buckets para el almacenamiento de objetos. El protocolo de cable S3 en sí se
sirve por separado en `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: Punto final de API regional
variables:
region:
default: sa-saopaulo-1
description: Código de región
security:
- BearerAuth: []
paths:
/v1/buckets:
get:
tags:
- Buckets
summary: Listar buckets
description: >
Muestra los buckets propiedad de la cuenta solicitante, ordenados por
nombre en orden ascendente. Paginación por cursor usando el nombre del
bucket (único globalmente) — pasa el último nombre de la página anterior
como `marker` para buscar la siguiente.
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: 'Resume token: el último nombre de depósito de la página anterior.'
- name: name
in: query
description: >-
Nombre exacto del depósito con ámbito de cuenta; un valor vacío no
coincide con nada.
schema:
type: string
- name: crn
in: query
description: >-
Filtro CRN exacto. Los CRN mal formados devuelven 400; las cuentas,
regiones o tipos de recursos extranjeros devuelven una página vacía.
Interseca todos los demás filtros.
schema:
type: string
responses:
'200':
description: Depósitos en la cuenta solicitante.
content:
application/json:
schema:
$ref: '#/components/schemas/BucketListResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
description: El llamador carece del permiso IAM requerido.
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: >-
Los nombres de los recursos no deben comenzar con el prefijo literal
crn: ni ser UUID (en cualquier caso, en las formas canónica,
compacta, entre corchetes o urn:uuid:).
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 versionado. `suspended` significa que el control de
versiones estaba activado y desactivado — las versiones existentes
se mantienen, las nuevas escrituras dejan de crearlas — lo cual es
distinto de `disabled`, un bucket que nunca lo ha tenido habilitado.
El punto final compatible con S3 escribe los mismos estados
`Enabled` / `Suspended` en su XML, e informa `disabled` al omitir el
elemento.
enum:
- disabled
- enabled
- suspended
example: disabled
deletion_protection:
type: boolean
description: >-
Cuando es true, DeleteBucket programa la eliminación en lugar de
eliminar el depósito inmediatamente. El valor predeterminado false
preserva deliberadamente la eliminación inmediata de S3.
default: false
example: false
recovery_window_days:
type: integer
description: >-
Configuración de la ventana de recuperación en días enteros (por
defecto 7). Las nuevas escrituras requieren 1-30; los buckets
históricos deshabilitados pueden conservar valores heredados fuera
de rango.
example: 7
deleted_at:
type: string
format: date-time
nullable: true
readOnly: true
description: >-
Cuando se solicitó la eliminación; nulo cuando no está pendiente o
para ventanas históricas.
scheduled_purge_at:
type: string
format: date-time
readOnly: true
description: >-
Plazo de purga, presente mientras la eliminación está pendiente.
Restaurar antes de este tiempo 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 artículos
example: 150
limit:
type: integer
description: Número de artículos por página
example: 20
marker:
type: string
description: >-
Cursor opaco para la página siguiente. Pasalo de vuelta como el
parámetro de consulta `marker`; trátalo como un token, no como un
valor para analizar.
example: 550e8400-e29b-41d4-a716-446655440000
has_more:
type: boolean
description: Si hay más artículos
example: true
Error:
type: object
required:
- error
properties:
error:
type: object
required:
- code
- message
- request_id
properties:
code:
type: string
description: Código de error que identifica el tipo de error
example: INVALID_INPUT
message:
type: string
description: Mensaje de error legible por el ser humano
example: Invalid request parameters
params:
type: object
additionalProperties: true
description: >-
Valores no sensibles opcionales para la interpolación de errores
localizados, codificados por código de error. Nunca presente por
errores del servidor.
example:
instances: 2
pools: 0
request_id:
type: string
format: uuid
description: Solicitar ID para depuración
example: 550e8400-e29b-41d4-a716-446655440000
responses:
BadRequest:
description: Parámetros de solicitud no vá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: Se requiere autenticación o el token no es vá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: >+
Un token bearer de OAuth 2.0, enviado como `Authorization: Bearer
`. Esta es la forma recomendada de autenticación.
Obtén el token intercambiando el par de claves de acceso de una cuenta
de servicio en `POST /v1/oauth/token` con
`grant_type=client_credentials`. Es el flujo estándar de credenciales de
cliente; las bibliotecas compatibles con OAuth pueden obtener y renovar
el token por ti.
```
curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
https://iam.basaltic.sh/v1/oauth/token
```
Los tokens duran una hora por defecto. El mismo par de claves de acceso
también sirve como credencial AWS SigV4 para el endpoint de objetos
compatible con S3, que solo acepta ese método de autenticación.
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.