hostingaccount::get_storage_utilisation

Description

Get current storage utilisation. This is the amount of storage used divided by the storage limit, expressed as a floating point number between 0 and 1.

Multiply by 100 to get the percentage of storage used.

Hosting accounts with no storage limit will always return zero utilisation.

Request details

Arguments

key
API key
domain
Hosting account domain name

Responses

<?xml version="1.0" encoding="utf-8"?>
<storageutilisation>0.188132667542</storageutilisation>
	
<?xml version="1.0" encoding="utf-8"?>
<storageutilisation>false</storageutilisation>
	
storageutilisation
false
Unable to retrieve storage utilisation
Any other value
Current storage utilisation

Exceptions

Examples

GET /hostingaccount/get_storage_utilisation/?key=acbd18db4cc2f85cedef654fccc4a4d8&domain=test01.example.com
<?xml version="1.0" encoding="utf-8"?>
<storageutilisation>0.188132667542</storageutilisation>
	

See also

  1. Index
  2. About the API

    1. Summary
    2. Specification
    3. Do not use undocumented features
    4. Change log
  3. Using the API

    1. Requests
      1. Authenticated requests
      2. Limits
      3. Common request value data types
    2. Understanding responses
      1. HTTP status codes used
      2. Exceptions
        1. access
        2. account
        3. database
        4. hostingaccount
        5. server
        6. system
  4. Function reference