---
title: "Update a disk object"
method: PATCH
path: "/disks/{DiskId}"
tags: ["Disks"]
---

# Update a disk object

`PATCH /disks/{DiskId}`

## Request

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

Perform operations like init, resize etc. on a disk

## Path parameters

- `DiskId` string, required

## Query parameters

- `nodename` string
- `dgname` string

## Request body

- DiskDetailV2v0
  - `DiskId` string: Disk identifier
  - `Name` string: Disk name
  - `LunSize` string: LUN size of the disk (use "auto" keyword to claim all additional space in case of disk resize)
  - `TotalUsableSize` string: Length of the public region of the disk
  - `DiskgroupName` string: Name of diskgroup or pool
  - `DiskgroupState` string: State of the diskgroup(imported/deported)
  - `State` 'online' | 'offline': State of the disk(online/offline). State will be offline in case disk is in error state.
  - `MediaFormat` string: Media format of the disk
  - `Initialized` boolean: Specifies if the disk is initialized or not (use "true" in case of PATCH to setup a disk and "false" to unsetup a disk)
  - `Privlen` string: Length of the private region of the disk (default size of this area will be 32MB if not specified during disk setup PATCH operation)
  - `Udid` string: Unique identifier of disk
  - `Numpaths` integer: Number of paths of disk
  - `Paths` Path[]: A list consisting of a map of `Native path` as key and `Hardware path` as it's corresponding value.
  - `Sectorsize` integer: Sector size in bytes
  - `Mediatype` string: Mediatype of disk (hdd/ssd)
  - `Flags` string: Flags set on the disk
  - `Attribute` string: Attributes of disk
  - `Tags` TagSchema[]: Tags set on the disk (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
  - `Connectivity` DiskConnectivity[]: Connectivity information of the disk
    - `HostName` string: Hostname to which the disk is connected to
    - `href` string, url: Link to the system
  - `HostConnectivity` 'fullshared' | 'partialshared' | 'local': Type of the disk like fullshared, partialshared or local.
  - `FreeSize` string: Available/free size in a disk
  - `DmpDevice` string: Metadevice name that represents the multiple paths to a disk
  - `Operations` Operation[]: Operations supported on a particular disk
    - `Name` string: Operation name
    - `href` string, uri: Link to the operation

## Response `200`

The request has succeeded.

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

## Other responses

- `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)