Hosting Account

/hosting-account

POST

Create a new hosting account.

JSON request

owner_email_address string A valid email address. Used for abuse purposes.
domains array An array of domain names that are already in your account.
country string Alpha-2 country code (ex. NL, DE, CA, IR, etc.). Used to determine the optimal host to provision the account on.
type string A type as returned by GET /hosting-type.
website_builder_plan number Optional, a website builder plan ID.
storage_quota number In megabytes.
traffic_quota number In megabytes.
max_domain_count number Maximum number of domains that can be linked to the account.
max_database_count number Maximum number of databases that can be created.
max_user_count number Maximum number of FTP users that can be created.
max_email_user_count number Maximum number of email accounts that can be created. This limit is only used for the ‘basic’ email user type. The other types override this limit.
max_email_forward_count number Maximum number of email aliasses/forwards that can be created.
max_email_user_storage_quota number Maximum quota MB for each email user.
is_installations_enabled boolean Enable to allow customers to use a tool to easily install common software packages.
is_pop3_enabled boolean Enable to allow customers to retrieve email using their own email client.
is_smtp_enabled boolean Enable to allow customers to send email using their own email client.
is_imap_enabled boolean Enable to allow customers to retrieve and send email using their own email client.

JSON response

Sample

curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
--data '
    {
        "type": "website-builder",
        "country": "NL",
        "owner_email_address": "test@hostcontrol.com",
        "storage_quota": 400,
        "traffic_quota": null,
        "max_domain_count": 1,
        "max_database_count": 0,
        "max_user_count": 0,
        "is_installations_enabled": false,
        "max_email_user_count": 2,
        "max_email_forward_count": 2,
        "max_email_user_storage_quota": 200,
        "is_pop3_enabled": false,
        "is_smtp_enabled": false,
        "is_imap_enabled": false,
        "website_builder_plan": 1
    }
' \
"{{api_base_url}}/hosting-account" | python -m json.tool

/hosting-account/{id}

GET

Get detailed information about an hosting account

Sample

curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/hosting-account/{id}" | python -m json.tool

JSON response

PUT

Update an hosting account.

JSON request

owner_email_address string A valid email address. Used for abuse purposes.
domains array An array of domain names that are already in your account.
type string A type as returned by GET /hosting-type.
website_builder_plan number Optional, a website builder plan ID.
storage_quota number In megabytes.
traffic_quota number In megabytes.
max_domain_count number Maximum number of domains that can be linked to the account.
max_database_count number Maximum number of databases that can be created.
max_user_count number Maximum number of FTP users that can be created.
max_email_user_count number Maximum number of email accounts that can be created. This limit is only used for the ‘basic’ email user type. The other types override this limit.
max_email_forward_count number Maximum number of email aliasses/forwards that can be created.
max_email_user_storage_quota number Maximum quota MB for each email user.
is_installations_enabled boolean Enable to allow customers to use a tool to easily install common software packages.
is_pop3_enabled boolean Enable to allow customers to retrieve email using their own email client.
is_smtp_enabled boolean Enable to allow customers to send email using their own email client.
is_imap_enabled boolean Enable to allow customers to retrieve and send email using their own email client.

JSON response

Sample

curl \
--request PUT \
--user "{{api_username}}:{{api_key}}" \
--data '
    {
        "type": "bulk",
        "max_database_count": 1,
        "max_user_count": 1,
        "is_installations_enabled": true,
        "website_builder_plan": null
    }
' \
"{{api_base_url}}/hosting-account/{id}" | python -m json.tool

DELETE

Delete an webhosting account. You have 30 days to restore the account. After 30 days the account will be purged.

Sample

curl \
--request DELETE \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/hosting-account/{id}" | python -m json.tool

/hosting-account/{id}/restore

POST

Restore a deleted account. Can only be called if the account has not been purged yet.

Sample

curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/hosting-account/{id}/restore" | python -m json.tool

JSON response