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

Hosting Account Set functions

  • add

    Add a new hosting account (to your set of hosting accounts)

  • list

    List your hosting accounts

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

Transaction functions

  • get

    Get details for a transaction

  • list

    List transactions for any period

  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