---
title: "Update a volume"
method: PATCH
path: "/diskgroups/{DgId}/volumes/{VolId}"
tags: ["Volumes"]
---

# Update a volume

`PATCH /diskgroups/{DgId}/volumes/{VolId}`

## Request

- Base URL: `https://sort.veritas.com/infoscale/api/2.0`
- URL: `https://sort.veritas.com/infoscale/api/2.0/diskgroups/{DgId}/volumes/{VolId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/veritas/apis/veritas-infoscale-api/docs/diskgroups/:DgId/volumes/:VolId/patch.ts> (a function with typed inputs; its response is checked against the schema)

Perform operations like resize, settag, rmtag etc. on a volume

## Path parameters

- `DgId` string, required
- `VolId` string, required

## Query parameters

- `nodename` string

## Request body

- VolumeDetailV2v0
  - `Name` string: User provided name of the volume
  - `Size` string: Size of the volume
  - `DiskgroupId` string: Unique diskgroup identifier
  - `DiskgroupName` string: Name of diskgroup or pool
  - `State` string: State of volume (use "start" keyword to start the volume and "stop" keyword to stop the volume in case of PATCH)
  - `Layout` string: Layout of volume Eg mirror, concat
  - `KernelState` string: Kernel state of volume(Enable/Disable)
  - `RvgId` string, uri: Replicated Volume Group link of volume
  - `VsetId` string, uri: Volume set link
  - `DiskList` object[]: List of disks desired for mirror creation
    - `DmName` string: Disk media name
  - `Logtype` string: Type of log associated like dco, dcm, old style drl etc.
  - `Nlog` integer: Specifies the number of log plexes
  - `Loglen` string: Specifies size of log
  - `Nstripe` integer: Number of stripes/columns
  - `Stripeunit` string: Stripe unit size
  - `Nmirror` integer: Number of mirrors for mirrored layout
  - `Mirror` string: Specifies that volumes should be mirrored across instances of a particular disk class like array (enclr), ctlr, host, site etc
  - `Stripe` string: Specifies that volumes should be striped across instances of a particular disk class like array (enclr), ctlr, host, site etc
  - `MirrorConfine` string: Specifies a required list of disk classes for confining a mirror.
  - `NSnapMirror` integer: Specifies mirrors to a volume for use in creating third-mirror break-off snapshots.
  - `NSnapMirrorsInSync` integer: Specifies mirrors to a volume that are in sync for use in creating third-mirror break-off snapshots.
  - `StorageSpecification` string: Storage specification to select certain types of disks for the allocation during mirror creation like ctlr:c1 or mediatype:ssd etc.
  - `Tags` TagSchema[]: Tags set on the Volume (Prefix TagName field with '!' for remove tag PATCH operation)
    - `TagName` string, required: The tag name to be set (Prefix with '!' for remove tag PATCH operation)
    - `TagValue` string: The tag value to be set
  - `Operations` Operation[]: Operations supported on a particular volume
    - `Name` string: Operation name
    - `href` string, uri: Link to the operation
  - `Flags` string: Flags like encrypted, vxcloud, fscloud etc. set on the volume
  - `ExtendableSize` string: Maximum size a volume can be extended to
  - `Mode` string: Mode/Permissions set on the volume
  - `User` string: User that owns a volume record to the user specified as the attribute value. The attribute value can be either a login name from the /etc/passwd database, or a numeric user ID
  - `Group` string: Group that owns a volume record to the group specified as the attribute value. The attribute value can be either a group name from the group database, or a numeric group ID
  - `Mounted` boolean: Display whether volume is mounted or not
  - `IsSnapshot` boolean: Display whether volume is snapshot or not

## Response `200`

The request has succeeded.

- Response
  - `detail` string: Error details.
  - `status` integer: http code

## Other responses

- `202`: The request has been initiated.
- `400`: Bad request
- `401`: The requested operation requires authentication.
- `403`: Forbidden
- `404`: Object that the endpoint is working on is not found.

---

[API](https://skmtc.dev/veritas/apis/veritas-infoscale-api.md) - [All operations](https://skmtc.dev/veritas/apis/veritas-infoscale-api/llms.txt) - [OpenAPI document](https://skmtc.dev/veritas/apis/veritas-infoscale-api/revisions/1e3d3f7145bb?raw)