Return resource usage and custom statistics

This function retrieves resource usage and custom statistics for a cPanel user account.

Authorizations:

Responses

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

Request samples

uapi --user=username ResourceUsage get_usages

Response samples

Content type
application/json
{
  • "apiversion": 3,
  • "func": "get_usages",
  • "module": "ResourceUsage",
  • "result": {
    • "data": [
      • {
        • "description": "MySQL® Databases",
        • "error": null,
        • "formatter": "format_bytes",
        • "id": "mysql_databases",
        • "maximum": 15,
        • "url": "sql/index.html",
        • "usage": 0
        }
      ],
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}