> ## 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 las políticas de instantáneas

> Enumera las directivas de instantáneas de propiedad de la cuenta solicitante en la región de destino, primero la más reciente. Keyset-paginado por id de política (UUIDv7).


<Info>
  Requiere la acción de IAM **`storage:ListSnapshotPolicies`**. Consulte [permisos de almacenamiento](/es/storage/permissions) para obtener la lista completa, lo que cubre cada una y un ejemplo de política.
</Info>


## OpenAPI

````yaml /es/api-reference/specs/storage.yaml get /v1/snapshot-policies
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/snapshot-policies:
    get:
      tags:
        - Storage
      summary: Listar las políticas de instantáneas
      description: >
        Enumera las directivas de instantáneas de propiedad de la cuenta
        solicitante en la región de destino, primero la más reciente.
        Keyset-paginado por id de política (UUIDv7).
      operationId: listSnapshotPolicies
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 50
            example: 50
        - name: marker
          in: query
          schema:
            type: string
            format: uuid
            example: 3c9f1b2e-6d4a-4e8b-9f1c-2a3b4c5d6e7f
          description: 'Resume token: el último id de política de la página anterior.'
        - name: volume
          in: query
          schema:
            type: string
            example: 5f8d2c1a-9b3e-4d7a-8c6f-1e2a3b4c5d6e
          description: >-
            UUID, CRN o nombre exacto del volumen de propiedad de la cuenta.
            Restringe a la política adjunta a ese volumen.
        - name: enabled
          in: query
          schema:
            type: boolean
            example: true
          description: Restringir a las políticas habilitadas (o pausadas).
        - name: name
          in: query
          schema:
            type: string
            example: nightly
          description: >-
            Coincidencia exacta de nombres con ámbito de cuenta; un valor vacío
            no coincide con nada.
        - 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: Una página de políticas de instantáneas
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnapshotPolicyListResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  schemas:
    SnapshotPolicyListResponse:
      type: object
      properties:
        snapshot_policies:
          type: array
          items:
            $ref: '#/components/schemas/SnapshotPolicy'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
    SnapshotPolicy:
      type: object
      required:
        - faults
      description: >
        Un programa adjunto a un volumen: tomar una instantánea cada
        `interval_minutes`, luego mantener como máximo `retention_count` de las
        instantáneas creadas por esta política.


        La retención solo elimina las instantáneas que la propia política ha
        creado (las que llevan su `snapshot_policy_id`) — una instantánea tomada
        a mano nunca se recoge. Tampoco elimina nunca una instantánea de la que
        algo depende: una instantánea de la que se creó un volumen, incluida una
        restauración todavía en curso, se omite y se vuelve a examinar más
        tarde.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          example: 3c9f1b2e-6d4a-4e8b-9f1c-2a3b4c5d6e7f
        crn:
          type: string
          readOnly: true
          description: Nombre de recurso de Cloud (basado en nombre, con ámbito de región).
          example: crn:storage:sa-saopaulo-1:my-account:snapshot-policy/nightly
        volume_id:
          type: string
          format: uuid
          description: >-
            El volumen al que se adjunta esta programación. Un volumen admite
            hasta 16 políticas independientes.
          example: 5f8d2c1a-9b3e-4d7a-8c6f-1e2a3b4c5d6e
        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
          maxLength: 128
          example: nightly
        description:
          type: string
          example: Nightly snapshots of the database volume
        enabled:
          type: boolean
          description: >
            Al desactivarla, se detiene toda la política: no se programan
            instantáneas ni se retienen datos. Un programa en pausa que seguía
            cosechando borraría el historial mientras lo estabas viendo.
          example: true
        interval_minutes:
          $ref: '#/components/schemas/SnapshotIntervalMinutes'
        retention_count:
          $ref: '#/components/schemas/SnapshotRetentionCount'
        retention_days:
          $ref: '#/components/schemas/SnapshotRetentionDays'
        next_run_at:
          type: string
          format: date-time
          readOnly: true
          description: >
            Cuando se debe realizar la siguiente instantánea. Se vuelve a marcar
            a `now + interval_minutes` cada vez que se dispara la política,
            nunca a `previous + interval`, por lo que una ventana perdida
            mientras la región estaba ocupada cuesta una instantánea, no una por
            ventana perdida.
          example: '2026-01-16T00:00:00Z'
        last_run_at:
          type: string
          format: date-time
          readOnly: true
          description: >-
            Cuando la política disparó por última vez. Ausente hasta el primer
            incendio.
          example: '2026-01-15T00:00:00Z'
        faults:
          type: array
          readOnly: true
          description: >-
            Fallos de advertencia activos, más nuevos primero; vacío cuando está
            sano. Las políticas no tienen estado de error y los fallos nunca
            cambian habilitados. La ejecución y la retención se recuperan de
            forma independiente; el historial resuelto se conserva internamente.
          items:
            $ref: '#/components/schemas/Fault'
        tags:
          $ref: '#/components/schemas/Tags'
        created_at:
          type: string
          format: date-time
          readOnly: true
          example: '2026-01-15T09:30:00Z'
        updated_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
    SnapshotIntervalMinutes:
      type: integer
      minimum: 1
      maximum: 43200
      description: >
        Minutos entre instantáneas: un intervalo mínimo, no una cadencia exacta.
        Un pase periódico toma lo que haya vencido y re-basea la siguiente
        ejecución de cada política desde el momento en que se ejecutó, por lo
        que una instantánea aterriza en o después de `interval_minutes` y nunca
        antes, y puede aterrizar un minuto o dos más tarde cuando el pase está
        ocupado. Una ventana que el pase no consigue cuesta una instantánea en
        lugar de producir una ráfaga de recuperación después.


        El mínimo es de un minuto, porque ese paso es lo que evalúa el horario y
        nada más fino puede ser honrado; el máximo es de 30 días. `snapshots`
        Por lo tanto, elija el intervalo más grande que cumpla con su objetivo
        de punto de recuperación.
      example: 1440
    SnapshotRetentionCount:
      type: integer
      minimum: 1
      maximum: 256
      description: >
        Cuántas instantáneas de esta política se deben conservar. Cuando un
        incendio lleva la cuenta más allá de esto, el más viejo va primero.
      example: 7
    SnapshotRetentionDays:
      type: integer
      minimum: 0
      maximum: 3650
      default: 0
      description: >
        Opcional edad limitada, aplicada encima de `retention_count`: se recoge
        una instantánea fuera de la ventana EITHER. 0 significa que no hay edad
        limitada. La única instantánea más reciente está exenta de la edad
        limitada, por lo que un volumen que no se pudo instantanear durante más
        tiempo que la ventana nunca pierde todo su historial.
      example: 30
    Fault:
      type: object
      required:
        - code
        - severity
        - message
        - details
        - first_at
        - last_at
        - occurrences
      properties:
        code:
          type: string
          description: >-
            Código legible por máquina estable propiedad de la operación de
            informes.
          example: BACKUP_FAILED
        severity:
          type: string
          enum:
            - error
            - warning
        message:
          type: string
          example: Backup upload failed.
        details:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Contexto estructurado; las cadenas heredadas se conservan en
            legacy_text.
        first_at:
          type: string
          format: date-time
          description: Primera observación en esta serie de ocurrencias activas.
        last_at:
          type: string
          format: date-time
          description: Última observación en esta serie de ocurrencias activas.
        occurrences:
          type: integer
          minimum: 1
          example: 1
    Tags:
      type: object
      additionalProperties:
        type: string
      example:
        environment: production
        team: backend
  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
    Forbidden:
      description: Permisos 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: Error interno del 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: >+
        Un token bearer de OAuth 2.0, enviado como `Authorization: Bearer
        <token>`. 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.