---
title: "Get a Disk"
method: GET
path: "/disks/{uuid}"
tags: ["disks"]
---

# Get a Disk

`GET /disks/{uuid}`

This operation gets a Disk.

## Path parameters

- `uuid` string, UUID, required

## Response `200`

Success

- DiskIntentResponse — Response object for intentful operations on a disk
  - `status` DiskDefStatus — Disk object.
    - `state` string — The state of the disk.
    - `message_list` MessageResource[] — Any error messages for the disk, if in an error state.
      - `message` string, required — If state is ERROR, a message describing the error.
      - `reason` string, required — If state is ERROR, a machine-readable snake-cased string.
      - `details` object — Custom key-value details relevant to the status.
    - `resources` object, required — Disk resources.
      - `host_reference` Reference — Reference to a kind
        - `kind` string, required
        - `uuid` string, UUID, required
        - `name` string
      - `enabled_features_list` string[] — Disk feature flags - 'CanAddAsNewDisk': Flag to indicate if this disk can be added as new disk. - 'CanAddAsOldDisk': Flag to indicate if the disk can be added as old disk. - 'BootDisk': Flag to indicate if its a boot disk. - 'OnlyBootDisk': Flag to indicate if the disk is boot only and no disk operation to be run on it. - 'SelfEncryptingEnabled': Flag to indicate if the disk has self encryption enabled. - 'PasswordProtected': Flag to indicate if the disk is password protected.
      - `vendor` string — Disk vendor.
      - `mount_path` string — Mount path.
      - `storage_pool_uuid` string, UUID — Storage pool uuid.
      - `slot_number` integer — Disk location in a node.
      - `serial_number` string — Disk serial number.
      - `storage_tier_type` string — Storage tier type.
      - `size_bytes` integer — Disk size in bytes.
      - `state_list` string[] — Array of disk states - 'DataMigrationInitiated': Data Migration Initiated. - 'MarkedForRemovalButNotDetachable': Marked for removal, data migration is in progress. - 'ReadyToDetach': Flag to indicate the disk is detachable. - 'DataMigrated': Flag to indicate if data migration is completed for this disk. - 'MarkedForRemoval': Flag to indicate if the disk is marked for removal. - 'Online': Flag to indicate if the disk is online. - 'Bad': Flag to indicate if the disk is bad. - 'Mounted': Flag to indicate if the disk is mounted. - 'UnderDiagnosis': Flag to indicate if the disk is under diagnosis.
      - `model` string — Disk model.
      - `firmware_version` string — Firmware version.
  - `spec` Disk — Disk specification.
  - `api_version` string, required
  - `metadata` DiskMetadata, required — The disk kind metadata
    - `last_update_time` string, date-time — UTC date and time in RFC-3339 format when disk was last updated
    - `kind` string, required — The kind name
    - `uuid` string, UUID — disk uuid
    - `spec_version` integer — Version number of the latest spec.
    - `creation_time` string, date-time — UTC date and time in RFC-3339 format when disk was created
    - `spec_hash` string — Hash of the spec. This will be returned from server.
    - `should_force_translate` boolean — Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema.
    - `owner_reference` UserReference — The reference to a user
      - `kind` string, required — The kind name
      - `name` string
      - `uuid` string, UUID, required
    - `categories` object — Categories for the disk
    - `name` string — disk name

## Other responses

- `default` — Internal Error

---

[API](https://skmtc.net/nutanix/apis/nutanix-intentful-api.md) · [All operations](https://skmtc.net/nutanix/apis/nutanix-intentful-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nutanix/nutanix-intentful-api/revisions/40395083ab31/schema)