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

# Get Volume Details

`GET /volumes/{volume_id}/details`

## Request

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

Get enriched volume details with per-edge state

Args:
    volume_id: The ID of the volume to retrieve details for

Returns:
    VolumeDetailsDto: The volume with per-edge state and configuration

## Path parameters

- `volume_id` string, required

## Response `200`

Volume details retrieved successfully

- VolumeDetailsDto: Enriched volume response — volume-scoped fields only. Display fields below are pre-formatted server-side (``protocol``, ``permission_policy``, ``security_mode``, ``snapshot_retention``) so direct WebAPI consumers see UI-ready values instead of raw filer enums/bitmasks. The flat ``VolumeDto`` (``GET /volumes/{id}``) intentionally keeps the raw forms for backward compatibility. Per-edge state is **not** on this DTO. Callers needing per-mount data (share/export counts, per-edge schedules, per-edge dirty bytes, …) call ``GET /volume_connections?volume_id=<id>`` — the resource split keeps the API resource-oriented and lets external consumers compose their own views without a UI-shaped "details+connections" fusion endpoint.
  - `volume_id` string, required
  - `volume_name` string, nullable
  - `edges` VolumeEdgesDto
    - `master` VolumeMasterDto, required
      - `id` string, uuid, required
      - `description` string, nullable
    - `connected` string[]
    - `connected_count` integer, required
  - `cloud_region` string, nullable
  - `used_capacity` string, nullable
  - `percent_capacity_used` integer, nullable
  - `compression_percent` integer, nullable
  - `protocol` Protocol[]
  - `remote_access_enabled` boolean, nullable
  - `cloud_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).
  - `bucket` string, nullable
  - `permission_policy` 'POSIX Mixed Mode' | 'UNIX/NFS Permissions Only Mode' | 'Unauthenticated Access Mode' | 'NTFS Compatible Mode' | 'NTFS Exclusive Mode' | 'NTFS Multiprotocol Mode'
  - `security_mode` 'Publicly Available' | 'Active Directory' | 'LDAP Directory'
  - `case_sensitive` boolean, nullable
  - `connection_permission` 'READONLY' | 'READWRITE' | 'Custom'
  - `antiransom_enabled` boolean, nullable
  - `antivirus_enabled` boolean, nullable
  - `safe_delete_enabled` boolean, nullable
  - `audit_enabled` boolean, nullable
  - `audit_output_type` string, nullable
  - `snapshot_retention` string, nullable
  - `encryption_keys` string[]
  - `chunk_size` integer, nullable
  - `compression` boolean, nullable
  - `dedupe` boolean, nullable
  - `volume_version` string, nullable
  - `cloud_credential_name` string, nullable
  - `cloud_credential_hostname` string, nullable
  - `cloud_credential_note` string, nullable

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