Hosting Domain¶
/hosting-domain¶
GET¶
Get a list of domains linked to this account.
Sample
curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/hosting-account/{id}/domain" | python -m json.tool
POST¶
Deprecation warning.
- NOTE: This endpoint is deprecated, please use /api/v1/domain/{id}/link instead.
/hosting-domain/{id}¶
GET¶
Sample
curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/hosting-domain/{id}" | python -m json.tool
JSON response
object: Hosting Domain
PUT¶
Update the settings of a linked domain.
JSON request
|
boolean |
If true, sub-domain management based on created folders is enabled. If the customer would create a folder ‘test’ in his public_html folder, the hostname ‘test.<domain>.<tld>’ would point directly to this folder. |
|
string |
Can be used to override the Open-Xchange SMTP server to let it authenticate against another server when sending email. |
|
string |
Can be used to override the Open-Xchange IMAP server to let it authenticate against another server when reading email. |
JSON response
object: Hosting Domain
Possible errors
Sample
curl \
--request PUT \
--user "{{api_username}}:{{api_key}}" \
--data '
{
"is_sub_domains_enabled": 1,
"ox_remote_smtp": "smtp.example.com",
"ox_remote_imap": "imap.example.com",
}
' \
"{{api_base_url}}/hosting-domain/{id}" | python -m json.tool
DELETE¶
Unlink a domain from a hosting account. This also free’s up any resources linked to this account domain.
Sample
curl \
--request DELETE \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/hosting-domain/{id}" | python -m json.tool