Function reference
API functions allow you to manage your account and your hosting accounts, and retrieve details on pricing, transactions and hosting servers.
Account functions
-
cancel_new_email
Cancel a request to change your account's email address
-
confirm_new_email
Confirm choice to change email address (not for new account email address verification)
-
get
Get summary details (email address, balance, status) for an account
-
get_balance
Get account balance at any time
-
get_new_email
Get a chosen new email address before it has been verified
-
get_notification_settings
Get settings related to balance warning, usage summary and usage level notifications
-
get_suspended_url
Get default redirect URL for this account's suspended hosting accounts
-
reset_password
Reset account password
-
set_notification_settings
Set settings related to balance warning, usage summary and usage level notifications
-
set_suspended_url
Set default redirect URL for this account's suspended hosting accounts
-
verify_email
Verify ownership of a chosen new account email address (not for changes to email addresses of existing accounts)
Hosting Account functions
-
get
Get summary details for a hosting account
-
get_bandwidth_cost
Get bandwidth cost for any period
-
get_bandwidth_limit
Get current monthly bandwidth limit
-
get_bandwidth_usage
Get bandwidth usage for any period
-
get_bandwidth_utilisation
Get current bandwidth utilisation
-
get_storage_cost
Get storage cost for any period
-
get_storage_limit
Get current storage limit
-
get_storage_usage
Get storage usage for any period
-
get_storage_utilisation
Get current storage utilisation
-
get_suspended_url
Get redirect URL for when a hosting account is suspended
-
reset_password
Reset a hosting account's password
-
set_bandwidth_limit
Set monthly bandwidth limit
-
set_storage_limit
Set storage limit
-
set_suspended_url
Set redirect URL for when a hosting account is suspended
-
suspend
Suspend a hosting account
-
terminate
Terminate (delete) a hosting account
-
unsuspend
Unsuspend a suspended hosting account
Hosting Account Set functions
Key functions
-
get
Get an account's API key
Notification functions
-
verify
Verify the authenticity of a received notification
Price functions
-
calculate
Calculate the cost of using a given amount of storage space and bandwidth over any period
-
data_transfer
Get current data transfer price (pence per gigabyte)
-
storage
Get current storage price (pence per megabyte per month)
Server functions
-
get
Get summary details for a server