/scalemgmt/v3/filesystems/{filesystem}/quotas: GET

Lists quota information of an IBM Storage Scale file system.

Availability

Available on all IBM Storage Scale editions.

Description

The GET filesystems/{filesystem}/quotas request retrieves quota information for a file system in the IBM Storage Scale cluster.

Request URL

https://<IP address or host name of API server>:<port>/scalemgmt/v3/filesystems/{filesystem}/quotas

where

filesystem: Specifies the file system name.
quotas: Specifies the quotas as the target of the GET call.

Request headers

Accept: application/json

Parameters

The following parameters can be used in the request URL to customize the request:

Table 1. List of parameters
Parameter name	Description and applicable keywords	Required/optional
filesystem	The file system name.	Required.
page_size	Number of items per page.	Optional.
page_token	Token for pagination.	Optional.
show_perfileset_quotas	Show per-fileset quotas.	Optional.
default	Show default quota limits.	Optional.
filter	Filter expression for quotas.	Optional.
X-StorageScaleDomain	The domain to be authorized against for the request. The default value is `StorageScaleDomain`.	Optional.

Request data

No request data.

Response data

200: A successful response.

{
  "quotas": [
			  {
				"type": "QUOTA_TYPE_USER",
				"id": 0,
				"name": "string",
				"block_usage_bytes": 0,
				"block_soft_limit_bytes": 0,
				"block_hard_limit_bytes": 0,
				"block_in_doubt_bytes": 0,
				"block_grace": "string",
				"file_usage": 0,
				"file_soft_limit": 0,
				"file_hard_limit": 0,
				"file_in_doubt": 0,
				"file_grace": "string",
				"entry_type": "INITIAL",
				"fileset": "string"
			  }
            ],
            "next_page_token": "string"
}

202: The request has been accepted for processing, but the processing has not been completed.
```
{
  "name": "string",
  "done": false
}
```

default: An unexpected error response.

{
  "code": 0,
  "details": [
    {
      "@type": "string",
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    }
  ],
  "message": "string"
}

Examples

The following example lists quota information for filesystem "fs1":

Request data:

curl -X 'GET' \
  'https://localhost:46443/scalemgmt/v3/filesystems/gpfs0/quotas?default=true' \
  -H 'accept: application/json' \
  -n -k

Response data:

{
        "name": "MTozOGUwMGNhMS1mYzQ0LTRmZjAtYjI1NC1kYmViNTFiYzg5NmE=",
        "metadata": {
                "@type": "type.googleapis.com/generic.v3.LongRunningOperationMetadata",
                "job_id": "MTozOGUwMGNhMS1mYzQ0LTRmZjAtYjI1NC1kYmViNTFiYzg5NmE=",
                "operation_details": {
                        "@type": "type.googleapis.com/quota.v3.ListFilesystemQuotasRequest",
                        "filesystem": "gpfs0",
                        "page_size": 1024,
                        "page_token": "",
                        "show_perfileset_quotas": false,
                        "default": true,
                        "filter": ""
                },
                "status": "DONE",
                "check_point": "",
                "request_time": "2026-03-06T19:20:59.612308085Z",
                "completion_time": "2026-03-06T19:20:59.617668252Z",
                "last_update_time": "2026-03-06T19:20:59.617668252Z",
                "output": "",
                "domain_ids": [
                        0
                ]
        },
        "done": true,
        "response": {
                "@type": "type.googleapis.com/quota.v3.ListFilesystemQuotasResponse",
                "quotas": [
                        {
                                "type": "QUOTA_TYPE_USER",
                                "name": "",
                                "block_soft_limit_bytes": "3221225472",
                                "block_hard_limit_bytes": "5368709120",
                                "block_grace": "",
                                "file_usage": "0",
                                "file_soft_limit": "1024",
                                "file_hard_limit": "2048",
                                "file_in_doubt": "0",
                                "file_grace": "",
                                "entry_type": "ROOT_DEFAULT_ON",
                                "fileset": ""
                        },
                        {
                                "type": "QUOTA_TYPE_GROUP",
                                "name": "",
                                "block_soft_limit_bytes": "0",
                                "block_hard_limit_bytes": "0",
                                "block_grace": "",
                                "file_usage": "0",
                                "file_soft_limit": "0",
                                "file_hard_limit": "0",
                                "file_in_doubt": "0",
                                "file_grace": "",
                                "entry_type": "ROOT_DEFAULT_ON",
                                "fileset": ""
                        },
                        {
                                "type": "QUOTA_TYPE_FILESET",
                                "name": "",
                                "block_soft_limit_bytes": "10485760",
                                "block_hard_limit_bytes": "15728640",
                                "block_grace": "",
                                "file_usage": "0",
                                "file_soft_limit": "3072",
                                "file_hard_limit": "4096",
                                "file_in_doubt": "0",
                                "file_grace": "",
                                "entry_type": "ROOT_DEFAULT_ON",
                                "fileset": ""
                        }
                ],
                "next_page_token": ""
        }
}