Hosting Account¶
/hosting-account¶
POST¶
Create a new hosting account.
JSON request
|
string |
A valid email address. Used for abuse purposes. |
|
array |
An array of domain names that are already in your account. |
|
string |
Alpha-2 country code (ex. NL, DE, CA, IR, etc.). Used to determine the optimal host to provision the account on. |
|
string |
A type as returned by GET /hosting-type. |
|
number |
Optional, a website builder plan ID. |
|
number |
In megabytes. |
|
number |
In megabytes. |
|
number |
Maximum number of domains that can be linked to the account. |
|
number |
Maximum number of databases that can be created. |
|
number |
Maximum number of FTP users that can be created. |
|
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. |
|
number |
Maximum number of email aliasses/forwards that can be created. |
|
number |
Maximum quota MB for each email user. |
|
boolean |
Enable to allow customers to use a tool to easily install common software packages. |
|
boolean |
Enable to allow customers to retrieve email using their own email client. |
|
boolean |
Enable to allow customers to send email using their own email client. |
|
boolean |
Enable to allow customers to retrieve and send email using their own email client. |
JSON response
object: Hosting Account
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
object: Hosting Account
PUT¶
Update an hosting account.
JSON request
|
string |
A valid email address. Used for abuse purposes. |
|
array |
An array of domain names that are already in your account. |
|
string |
A type as returned by GET /hosting-type. |
|
number |
Optional, a website builder plan ID. |
|
number |
In megabytes. |
|
number |
In megabytes. |
|
number |
Maximum number of domains that can be linked to the account. |
|
number |
Maximum number of databases that can be created. |
|
number |
Maximum number of FTP users that can be created. |
|
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. |
|
number |
Maximum number of email aliasses/forwards that can be created. |
|
number |
Maximum quota MB for each email user. |
|
boolean |
Enable to allow customers to use a tool to easily install common software packages. |
|
boolean |
Enable to allow customers to retrieve email using their own email client. |
|
boolean |
Enable to allow customers to send email using their own email client. |
|
boolean |
Enable to allow customers to retrieve and send email using their own email client. |
JSON response
object: Hosting Account
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
object: Hosting Account