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

# Actualizar metadatos de volumen

> Actualice la descripción del volumen. Su nombre es inmutable.

<Info>
  Requiere la acción de IAM **`storage:UpdateVolume`**. 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 patch /v1/volumes/{volume_id}
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/volumes/{volume_id}:
    patch:
      tags:
        - Storage
      summary: Actualizar metadatos de volumen
      description: Actualice la descripción del volumen. Su nombre es inmutable.
      operationId: updateVolume
      parameters:
        - $ref: '#/components/parameters/VolumeId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VolumeUpdateRequest'
      responses:
        '200':
          description: Volumen actualizado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: Ya existe un volumen con este nombre en esta organización
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - BearerAuth: []
components:
  parameters:
    VolumeId:
      name: volume_id
      in: path
      description: ID de volumen
      required: true
      schema:
        type: string
        format: uuid
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    VolumeUpdateRequest:
      type: object
      description: >
        Los nombres se fijan en la creación porque forman el CRN utilizado por
        las directivas de IAM. El envío de nombre en una actualización,
        incluyendo un valor sin cambios, vacío o nulo, devuelve un error de
        validación.
      properties:
        description:
          type: string
          example: Primary data volume for app-01
        tags:
          $ref: '#/components/schemas/Tags'
    VolumeResponse:
      type: object
      properties:
        volume:
          $ref: '#/components/schemas/Volume'
    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
    Tags:
      type: object
      additionalProperties:
        type: string
      example:
        environment: production
        team: backend
    Volume:
      type: object
      required:
        - faults
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          example: 5f8d2c1a-9b3e-4d7a-8c6f-1e2a3b4c5d6e
        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:volume/data-volume-01
        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: data-vol-01
        description:
          type: string
          example: Primary data volume for app-01
        tags:
          $ref: '#/components/schemas/Tags'
        volume_type:
          $ref: '#/components/schemas/VolumeTypeName'
        size_gb:
          type: integer
          minimum: 1
          maximum: 16384
          example: 100
        performance:
          $ref: '#/components/schemas/VolumePerformance'
        included_io_limits:
          $ref: '#/components/schemas/IncludedIOLimits'
        status:
          $ref: '#/components/schemas/VolumeStatus'
        bootable:
          type: boolean
          description: >
            Se establece en el momento de la creación cuando el volumen se
            aprovisiona desde una imagen de arranque. Inmutable después de la
            creación.
          example: false
        source_image_id:
          type: string
          format: uuid
          nullable: true
          description: Imagen de la que se clonó el volumen, cuando corresponda.
          example: a3c9e7b1-2d4f-4a6b-8e1c-9f0a1b2c3d4e
        source_snapshot_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            Instantánea del volumen desde el que se clonó (ruta de
            restauración), cuando corresponda.
          example: 019f24a8-4bbe-7441-93af-6bbac0413943
        faults:
          type: array
          readOnly: true
          description: >-
            Fallas activas, más reciente primero. Vacío cuando está sano. El
            estado es error si y solo si existe un fallo activo de gravedad de
            error. El historial resuelto se conserva internamente.
          items:
            $ref: '#/components/schemas/Fault'
        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:31:12Z'
    VolumeTypeName:
      type: string
      enum:
        - hdd
        - ssd
        - nvme
      description: >
        Nivel de almacenamiento orientado al cliente en el que se almacena un
        volumen. Asignado por región a un grupo de almacenamiento por la
        configuración del operador (la asignación es opaca para los llamadores
        de API).
      example: ssd
    VolumePerformance:
      type: object
      readOnly: true
      required:
        - requested
        - applied
        - state
      properties:
        requested:
          $ref: '#/components/schemas/IncludedIOLimits'
        applied:
          $ref: '#/components/schemas/IncludedIOLimits'
        state:
          type: string
          enum:
            - creating
            - pending
            - applied
        operation_id:
          type: string
          format: uuid
        applied_at:
          type: string
          format: date-time
        last_error:
          type: string
          description: Último error reintentable; la solicitud aceptada permanece duradera.
    IncludedIOLimits:
      type: object
      readOnly: true
      description: >
        Por volumen, asignación combinada de lectura/escritura. Todos los
        volúmenes SSD y NVMe, incluidos los volúmenes existentes, incluyen
        exactamente 3000 IOPS y 131072000 bytes/s (125 MiB/s),
        independientemente de la capacidad, sin ráfagas. El cambio de tamaño no
        cambia estos valores. Estos son límites de almacenamiento compartido, no
        un SLA de latencia o reserva. El rendimiento adicional prorrateado se
        cobra por separado solo por encima de esta asignación.
      required:
        - iops
        - bytes_per_sec
        - burst_iops
        - burst_bytes_per_sec
        - burst_seconds
      properties:
        iops:
          type: integer
          minimum: 0
          example: 3000
        bytes_per_sec:
          type: integer
          format: int64
          minimum: 0
          example: 131072000
        burst_iops:
          type: integer
          minimum: 0
          description: >-
            Siempre cero para volúmenes SSD y NVMe; el ráfaga de IOPS está
            deshabilitado.
          example: 0
        burst_bytes_per_sec:
          type: integer
          format: int64
          minimum: 0
          description: >-
            Siempre cero para volúmenes SSD y NVMe; el ráfaga de rendimiento
            está deshabilitado.
          example: 0
        burst_seconds:
          type: integer
          minimum: 0
          description: >-
            Siempre cero para volúmenes SSD y NVMe; no se aplica la duración de
            ráfaga.
          example: 0
    VolumeStatus:
      type: string
      enum:
        - creating
        - available
        - in_use
        - extending
        - deleting
        - error
      example: available
    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
  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
    NotFound:
      description: No se encontró el recurso
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Resource not found
              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.