hostingaccount::get_bandwidth_utilisation

1. Index
2. > Function reference
3. > hostingaccount::get_bandwidth_utilisation

Description

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

Multiply by 100 to get the percentage of bandwidth used.

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

Request details

• Method

  GET

• URL

  https://api.hostingreborn.com/hostingaccount/get_bandwidth_utilisation/

Arguments

key

API key

domain

Hosting account domain name

Responses

<?xml version="1.0" encoding="utf-8"?>
<bandwidthutilisation>0.188132667542</bandwidthutilisation>
	

<?xml version="1.0" encoding="utf-8"?>
<bandwidthutilisation>false</bandwidthutilisation>
	

bandwidthutilisation

false

Unable to retrieve bandwidth utilisation

Any other value

Current bandwidth utilisation

Exceptions

• database

• access

Examples

GET /hostingaccount/get_bandwidth_utilisation/?key=acbd18db4cc2f85cedef654fccc4a4d8&domain=test01.example.com

<?xml version="1.0" encoding="utf-8"?>
<bandwidthutilisation>0.188132667542</bandwidthutilisation>
	

See also

• hostingaccount::get

  Get summary details for a hosting account

• hostingaccount::get_bandwidth_cost

  Get bandwidth cost for any period

• hostingaccount::get_bandwidth_limit

  Get current monthly bandwidth limit

• hostingaccount::get_bandwidth_usage

  Get bandwidth usage for any period

• hostingaccount::get_storage_cost

  Get storage cost for any period

• hostingaccount::get_storage_limit

  Get current storage limit

• hostingaccount::get_storage_usage

  Get storage usage for any period

• hostingaccount::get_storage_utilisation

  Get current storage utilisation

• hostingaccount::get_suspended_url

  Get redirect URL for when a hosting account is suspended