Domain Branding¶
/domain-brand¶
GET¶
Returns a list of available Brands.
JSON response
array: Domain Brand
Sample
curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/domain-brand" | python -m json.tool
POST¶
Create a new brand to be used for domain related communications.
JSON request
|
string |
Optional, max. length 255. |
|
string |
Contact email address (must be valid and able to receive email). |
|
string |
Max. 3 lines, 63 characters per line. |
|
string |
Max. length 16. |
|
string |
Max. length 255. |
|
string |
Max. length 255. |
|
string |
Alpha-2 country code (ex. NL, DE, CA, IR, etc.) |
|
string |
Max. length 17, +[0-9]{1,3}.[0-9]{1,14} |
|
string |
Optional, max. length 17, +[0-9]{1,3}.[0-9]{1,14} |
JSON response
object: Domain Brand
Possible errors
Sample
curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
--data '
{
"organization": "My Organization",
"email_address": "test-contact@hostcontrol.com",
"address": "Address line 1\nAddress line 2\nAddress line 3",
"zip_code": "1234 AB",
"state": "Some state",
"city": "Some city",
"country": "NL",
"voice": "+31484538930",
"fax": null
}
' \
"{{api_base_url}}/domain-brand" | python -m json.tool
/domain-brand/{handle}¶
GET¶
JSON response
object: Domain Brand
Possible errors
Sample
curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/domain-brand/Axac-134ba" | python -m json.tool
PUT¶
Update an existing brand.
JSON request
|
string |
Optional, max. length 255. |
|
string |
Contact email address (must be valid and able to receive email). |
|
string |
Max. 3 lines, 63 characters per line. |
|
string |
Max. length 16. |
|
string |
Max. length 255. |
|
string |
Max. length 255. |
|
string |
Alpha-2 country code (ex. NL, DE, CA, IR, etc.) |
|
string |
Max. length 17, +[0-9]{1,3}.[0-9]{1,14} |
|
string |
Optional, max. length 17, +[0-9]{1,3}.[0-9]{1,14} |
JSON response
object: Domain Brand
Possible errors
Sample
curl \
--request PUT \
--user "{{api_username}}:{{api_key}}" \
--data '
{
"organization": "My Organization",
"email_address": "test-contact@hostcontrol.com",
"address": "Address line 1\nAddress line 2\nAddress line 3",
"zip_code": "1234 AB",
"state": "Some state",
"city": "Some city",
"country": "NL",
"voice": "+31484538930",
"fax": null
}
' \
"{{api_base_url}}/domain-brand/Axac-134ba" | python -m json.tool