Domain¶
/domain¶
GET¶
Returns a list of domains.
JSON request
|
string |
Comma separated list of client references that uniquely identifies a domain. |
|
string |
Full or partial domain name to search for. |
|
string |
UUID type field used for sync of BO and RP domains. |
|
string |
Reseller reference to filter on. |
|
string |
Domain Contact handle. Generated identifier of contact. Unique per RTR account. |
|
string |
Role of Domain Contact assigned to Domain. |
|
list |
List of Name Servers assigned to Domain. |
|
string |
Domain state to search for. |
|
string |
Field by which domain resulting queryset will be filtered. |
JSON response
array: Domain
Possible errors
Sample
curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/domain" | python -m json.tool
POST¶
Register a new domain. A contact must be specified for each role (‘registrant’, ‘admin’, ‘billing’ and ‘tech’). The provided nameservers must be unique on hostname.
JSON request
|
string |
The IDNA encoded domain name including the TLD. |
||||||
|
array |
|
||||||
|
array |
|
||||||
|
boolean |
Determines whether this domain is managed by the system. Set false for domains which are already registered and which you don’t want to transfer. |
||||||
|
boolean |
Set to true to enable automatic renewals (and billing of them) by the system. |
||||||
|
string |
TLD specific language code to be used. |
||||||
|
string |
Client reference to be used for filtering and in Events. |
||||||
|
boolean |
If privacy protect should be enabled for this domain. |
JSON response
object: Domain
Possible errors
Sample
curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
--data '
{
"name": "example.com",
"contacts": [
{
"role": "registrant",
"contact": "RP934K83F9k30K2904L"
},
{
"role": "admin",
"contact": "RP934K83F9k30K2904L"
},
{
"role": "billing",
"contact": "RP934K83F9k30K2904L"
},
{
"role": "tech",
"contact": "RP934K83F9k30K2904L"
}
],
"name_servers": [
{
"hostname": "ns1.example.com"
},
{
"hostname": "ns2.example.com"
}
]
}
' \
"{{api_base_url}}/domain" | python -m json.tool
/domain/{id}¶
GET¶
Get detailed information about a domain.
Query parameters
|
boolean |
Set to true if you need extended information (might be slower!). |
JSON response
object: Domain
Possible errors
Sample
curl \
--request GET \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/domain/{id}" | python -m json.tool
PUT¶
Update domain settings like auto renew, name servers, contacts and the transfer lock.
JSON request
|
array |
|
||||||
|
array |
|
||||||
|
boolean |
Enable or disable the transfer lock. |
||||||
|
boolean |
Enable or disable automatic renewals for this domain. |
||||||
|
boolean |
OPTIONAL: Enable or disable privacy protect. Only possible when supported by TLD Note: This is an a-synchronous process. The result is not immediately visible this can take a while (a couple of minutes) |
||||||
|
string |
OPTIONAL: Possible values: ‘NONE’, ‘OLD’, ‘NEW’, ‘BOTH’ Indicates for whom you are acting as a designated agent. If a registry does not allow you to be designated agent or interaction with the registrant is still required this parameter is silently ignored. |
JSON response
object: Domain
Possible errors
Sample
curl \
--request PUT \
--user "{{api_username}}:{{api_key}}" \
--data '
{
"contacts": [
{
"role": "registrant",
"contact": "RP934K83F9k30K2904L"
},
{
"role": "admin",
"contact": "RP934K83F9k30K2904L"
},
{
"role": "billing",
"contact": "RP934K83F9k30K2904L"
},
{
"role": "tech",
"contact": "RP934K83F9k30K2904L"
}
],
"name_servers": [
{
"hostname": "ns1.example.com"
},
{
"hostname": "ns2.example.com"
}
]
}
' \
"{{api_base_url}}/domain/{id}" | python -m json.tool
DELETE¶
Possible errors
Sample
curl \
--request DELETE \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/domain/{id}" | python -m json.tool
/domain/{id}/renew¶
POST¶
Manually renew a domain. current_expiration_date
must be provided to prevent accidental renews.
JSON request
|
string |
ISO-8601 date format. |
JSON response
object: Domain
Possible errors
Sample
curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
--data '
{
"current_expiration_date": "2016-04-22"
}
' \
"{{api_base_url}}/domain/{id}/renew" | python -m json.tool
/domain/{id}/restore¶
POST¶
Restore a domain that entered redemption period after deletion.
JSON response
object: Domain
Possible errors
Sample
curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/domain/{id}/restore" | python -m json.tool
/domain/{id}/park¶
POST¶
Park a domain. If park_addresses
is ommited, the default park server is used.
JSON request
|
string |
|
Possible errors
Sample
curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
"{{api_base_url}}/domain/{id}/park" | python -m json.tool
/domain/{id}/link¶
POST¶
Link a domain to an hosting account.
JSON request
|
string |
The hosting account ID you wish to link the domain to. |
Possible errors
Sample
curl \
--request POST \
--user "{{api_username}}:{{api_key}}" \
--data '
{
"hosting_account": "ac-56fk2"
}
' \
"{{api_base_url}}/domain/{id}/link" | python -m json.tool