Return local disk quota information

This function retrieves the cPanel account's quota for the server where you run the function. For example, a distributed cPanel account could approach its quota. The servers will balance that cPanel user's quota between the parent and the child node.

Note:

This function runs on only the local server. To retrieve the cPanel account's total quota, use the UAPI Quota::get_quota function instead.

SecurityBasicAuth

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/Quota/get_local_quota_info

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Quota \
  get_local_quota_info

Response samples

application/json

{"apiversion": 3,
"func": "get_local_quota_info",
"module": "Quota",
"result": {"data": {"byte_limit": 262144000,
"bytes_used": 4149284,
"inode_limit": 0,
"inodes_used": 1035
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}