---
title: "Update a volume."
method: PUT
path: "/v1/{tenantId}/volumes/{id}"
tags: ["Volume"]
---

# Update a volume.

`PUT /v1/{tenantId}/volumes/{id}`

## Request body

- VolumeUpdate
  - `Description` string — The volume name specified by user, - Optional
  - `Size` integer — The volume size, - Optional
  - `Type` integer — The volume Type, - Optional
  - `Iops` integer — The Iops, - Optional
  - `Tags` Tag[] — The volume tags, - Optional
    - `key` string — Key of the Tag object.
    - `Value` string — Value of the Tag object.
  - `Metadata` object — Metadata for cloud backend specific data, - Optional

## Response `200`

successful operation

- VolumeResult — Volume Response
  - `Id` string — The volume ID, generated by server
  - `CreatedAt` string — The time of creation of the volume.
  - `UpdatedAt` string — The time at which the volume was updated.
  - `TenantId` string — The tenant UUID in a multi-tenancy environment.
  - `UserId` string — The user UUID in a multi-tenancy environment.
  - `BackendId` string — The backend ID
  - `Backend` string — The backend Name.
  - `Name` string — The volume name specified by user.
  - `Description` string — The volume description specified by user.
  - `Type` string — The volume type.
  - `Size` integer — The volume size.
  - `Region` string — The region for the volume.
  - `AvailabilityZone` string — The availability zone for the volume.
  - `Status` 'available' | 'creating' | 'inUse' | 'error' | 'updating' | 'deleting' | 'errorDeleting' | 'deleted' — The volume status.
  - `Tags` Tag[]
    - `key` string — Key of the Tag object.
    - `Value` string — Value of the Tag object.
  - `SnapshotId` string — The volume snapshot id.
  - `Encrypted` boolean — Flag for encryted volume.
  - `EncryptedSettings` object — Encryted volume Keys.
  - `Metadata` object
    - `fields` VolumeFields
      - `CreationTimeAtBackend` object
        - `kind` object
          - `StringValue` string
      - `StartTimeAtBackend` object
        - `kind` object
          - `StringValue` string
      - `VolumeId` object
        - `kind` object
          - `StringValue` string
      - `Progress` object
        - `kind` object
          - `NumberValue` integer

## Other responses

- `401` — Unauthorized. Token not found in header
- `404` — The resource does not exist.

---

[API](https://skmtc.net/sodafoundation/apis/soda-multi-cloud-api.md) · [All operations](https://skmtc.net/sodafoundation/apis/soda-multi-cloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sodafoundation/soda-multi-cloud-api/versions/df048c8349b6/schema)