Skip to main content
GET
/
volumes
/
unique-name
/
{uniqueName}
Get a volume by unique name
curl --request GET \
  --url https://mycluster.domino.tech/volumes/unique-name/{uniqueName}
{
  "capacity": 123,
  "createdAt": "<string>",
  "createdBy": {
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>",
    "userName": "<string>"
  },
  "dataPlaneId": "<string>",
  "filesystemId": "<string>",
  "id": "<string>",
  "maxSnapshots": 123,
  "name": "<string>",
  "numSnapshots": 123,
  "path": "<string>",
  "uniqueName": "<string>",
  "updatedAt": "<string>",
  "updatedBy": {
    "firstName": "<string>",
    "id": "<string>",
    "lastName": "<string>",
    "userName": "<string>"
  },
  "description": "<string>",
  "filesystemName": "<string>",
  "grants": [
    {
      "isOrganization": true,
      "targetId": "<string>",
      "targetName": "<string>"
    }
  ],
  "lastMountedTime": "<string>",
  "projects": [
    {
      "addedAt": "<string>",
      "addedBy": {
        "firstName": "<string>",
        "id": "<string>",
        "lastName": "<string>",
        "userName": "<string>"
      },
      "name": "<string>",
      "projectId": "<string>",
      "volumeId": "<string>"
    }
  ],
  "storageSize": 123
}

Path Parameters

uniqueName
string
required

Unique name of volume to retrieve

Response

OK

capacity
integer
required

Maximum size in bytes

createdAt
string
required
createdBy
object
required
dataPlaneId
string
required
filesystemId
string
required
id
string
required

Links to ONTAP volume name

maxSnapshots
integer
required
name
string
required
numSnapshots
integer
required
path
string
required
status
enum<string>
required
Available options:
Active,
MarkedForDeletion,
Deleted
uniqueName
string
required
updatedAt
string
required
updatedBy
object
required
description
string
filesystemName
string
grants
object[]
lastMountedTime
string
projects
object[]
storageSize
integer

Used size in bytes