Skip to main content
GET
/
volumes
List volumes
curl --request GET \
  --url https://mycluster.domino.tech/volumes
{
  "data": [
    {
      "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
    }
  ],
  "meta": {
    "filters": [
      {
        "key": "<string>",
        "values": [
          "<string>"
        ]
      }
    ],
    "order": "<string>",
    "pagination": {
      "limit": 123,
      "offset": 123,
      "totalCount": 123
    },
    "search": "<string>",
    "sortBy": "<string>"
  }
}

Query Parameters

limit
integer

Limit

offset
integer

Offset

order
string

Order

Search

sort_by
string

Sort by

filter_strictly_by_volume_roles
boolean

Filter strictly by volume roles

project_id
string[]

Project ID

data_plane_id
string[]

Data Plane ID

status
string[]

Status

Response

OK

data
object[]
meta
object