---
title: "Get Volume"
method: GET
path: "/volumes/{volume_id}"
tags: ["Volumes"]
---

# Get Volume

`GET /volumes/{volume_id}`

## Request

- Base URL: `https://am1.portal.api.nasuni.com`
- URL: `https://am1.portal.api.nasuni.com/volumes/{volume_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nasuni/apis/portal-api/docs/volumes/:volume_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a single volume with detailed information.

## Path parameters

- `volume_id` string, required

## Response `200`

Volume retrieved successfully

- VolumeDto
  - `id` string, required
  - `description` string, nullable
  - `remote_access_enabled` boolean, nullable
  - `provider` 'amazons3' | 'amazons3gov' | 'azure' | 'google' | 'googles3' | 'atmos' | 'ironmountain' | 'rackspace' | 'nirvanix' | 'synaptic' | 'castor' | 'delldx' | 'cloudone' | 'hp' | 'cleversafe' | 'vipr' | 'ibmcos' | 'hcp' | 's3_compatible': Cloud provider identity as used by NOC (shortname).
  - `nds_capable` boolean, nullable: NOC's verdict on whether the volume can be indexed by an NDS. Reported by the live volume list; null otherwise.
  - `nds_disqualifications` string[]: NOC's reasons the volume cannot be indexed by an NDS. Empty when it can, or when no verdict was reported.
  - `edges` VolumeEdgesDto
    - `master` VolumeMasterDto, required
      - `id` string, uuid, required
      - `description` string, nullable
    - `connected` string[]
    - `connected_count` integer, required
  - `location` string, nullable
  - `gfl` boolean, required
  - `lock_server` string, required
  - `used_capacity` string, nullable
  - `percent_capacity_used` integer, nullable
  - `compression_data_reduction_percent` integer, nullable
  - `share_features` string, nullable
  - `gfa_mode` boolean, required

## Other responses

- `401`: Not authenticated
- `403`: Insufficient permissions
- `404`: Resource not found
- `422`: Invalid input data
- `500`: Internal server error

---

[API](https://skmtc.dev/nasuni/apis/portal-api.md) - [All operations](https://skmtc.dev/nasuni/apis/portal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nasuni/apis/portal-api/revisions/2a505bec6d14?raw)