Get volumes

Contributors netapp-ranuk Download PDF of this page

You can retrieve the list of volumes.

1. Select the working environment

Perform the workflow Get working environments and choose the publicId value for the working environment used in the workingEnvironmentId path parameter.

2. Get the volumes

HTTP method Path



curl example
curl --location --request GET '<WORKING_ENV_ID>' --header 'Content-Type: application/json' --header 'x-agent-id: <AGENT_ID>' --header 'Authorization: Bearer <ACCESS_TOKEN>'

Query parameter <WORKING_ENV_ID> (workingEnvironmentId)


The JSON output example includes the list of volumes for the working environment.

JSON output example
        "name": "ziv02vol01",
        "uuid": "cb488216-5bd1-11eb-8a9b-615eb82c79d8",
        "svmName": "svm_ziv01we02",
        "size": {
            "size": 100.0,
            "unit": "GB"
        "usedSize": {
            "size": 5.18798828125E-4,
            "unit": "GB"
        "junctionPath": "/ziv02vol01",
        "volumeTotalInodes": 3112959,
        "volumeUsedInodes": 96,
        "mountPoint": "",
        "compressionSpaceSaved": {
            "size": 0.0,
            "unit": "GB"
        "deduplicationSpaceSaved": {
            "size": 0.0,
            "unit": "GB"
        "thinProvisioning": true,
        "compression": true,
        "deduplication": true,
        "snapshotPolicy": "default",
        "securityStyle": "unix",
        "exportPolicyInfo": {
            "name": "export-svm_ziv01we02-ziv02vol01",
            "policyType": "custom",
            "ips": [
            "nfsVersion": [
        "shareNames": [],
        "shareInfo": [],
        "parentVolumeName": "",
        "rootVolume": false,
        "state": "online",
        "volumeType": "rw",
        "aggregateName": "aggr1",
        "parentSnapshot": null,
        "autoSizeMode": "grow",
        "maxGrowSize": {
            "size": 1100.0,
            "unit": "GB"
        "providerVolumeType": "gp2",
        "cloneNames": [],
        "moving": false,
        "primaryNoFailoverMountPoint": null,
        "secondaryNoFailoverMountPoint": null,
        "capacityTier": null,
        "capacityTierUsedSize": null,
        "cifsShareAccessPoint": null,
        "primaryCifsShareAccessPoint": null,
        "secondaryCifsShareAccessPoint": null,
        "tieringPolicy": "none",
        "tierInactiveUserData": {
            "size": 0.0,
            "unit": "GB"
        "tierInactiveUserDataPercent": 0,
        "comment": null,
        "qosPolicyGroupName": null,
        "snaplockType": "non_snaplock",
        "constituentsAggregates": [],
        "snapshotsUsedSize": {
            "size": 1597440.0,
            "unit": "Byte"
        "cbsBackupsInfo": null,
        "minimumCoolingDays": null,
        "targetName": "",
        "iscsiEnabled": false,
        "isFlexGroupVolume": false