Used to update a domain name. Only specified fields are updated, to remove an optional field specify it as empty.
For more information about DNS zone operations and the interactions with domains see our Knowledge Base and the DNS operations tab below.
Name | Type | Description | Restrictions |
---|---|---|---|
domainName | String | The domain name |
|
Name | Type | Required / Optional | Description | Restrictions |
---|---|---|---|---|
quote | Boolean | Optional | If true, validate the request and request a quote for the action |
Name | Type | Required / Optional | Description | Restrictions |
---|---|---|---|---|
registrant | String | Optional | New registrant handle for the domain |
|
privacyProtect | Boolean | Optional | Privacy protect setting | |
authcode | String | Optional | The new auth code for the domain name, if specified as empty string ("") a new random auth code will be generated |
|
autoRenew | Boolean | Optional | The auto renew setting for the domain name | |
autoRenewPeriod | Integer | Optional | Auto renewal period in months. Registry specific values are available in metadata. | |
ns | List <String> | Optional | List of name servers to use for the domain name, to remove all name servers specify as empty list ([]). If a managed zone exists and the name servers are changed the managed zone is deleted after 7 days. If you want to change the vanity name servers of a zone, make sure the "zone" field is specified. |
|
status | List <Enum> | Optional | New domain statuses, you can only add and remove CLIENT statuses, IRTPC_TRANSFER_PROHIBITED can only be removed, other statuses must remain unchanged |
Possible values:
|
designatedAgent | Enum | Optional | 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. To use this field with any other value then "NONE" the requesting user must have the "DESIGNATED_AGENT" permission. |
Possible values:
|
zone | zone | Optional | DNS template to use for the domain name, to remove an existing zone without creating a new one omit this field and specify the "ns" field as an empty list ([]) |
|
contacts | List < contacts > | Optional | Domain contacts and their role | |
keyData | List < keyData > | Optional | DNSSEC Key data for domain, to remove all DS data records specify as empty list ([]) | |
dsData | List < dsData > | Optional | DNSSEC DS data for domain, the system does not accept new DS data records, this field can only be used to remove DS data records. If a matching key data record is added the corresponding DS data record is automatically removed. To remove all DS data records specify as empty list ([]) | |
billables | List < billables > | Optional | Acknowledgment of billables for this request |
Name | Type | Required / Optional | Description | Restrictions |
---|---|---|---|---|
service | Enum | Optional | DNS service to provision, defaults to BASIC for new zone, otherwise the service of the existing managed zone |
Possible values:
|
template | String | Optional | The template to use, removes any existing records/master |
|
link | Boolean | Optional | Unless false, the zone is linked to the template | |
master | String | Optional | The IP address of the (hidden) master, removes any existing records/template |
|
dnssec | Boolean | Optional | DNSSEC signing service for zone | |
managed | Boolean | Optional | Used to convert a managed zone to unmanaged by specifying als 'false' |
Name | Type | Required / Optional | Description | Restrictions |
---|---|---|---|---|
protocol | Integer | Required | The DNSSEC protocol |
Possible values:
|
flags | Integer | Required | The DNSSEC flags |
Possible values:
|
algorithm | Integer | Required | The DNSSEC algorithm |
Possible values:
|
publicKey | String | Required | The base64 encoded public key |
|
Name | Type | Required / Optional | Description | Restrictions |
---|---|---|---|---|
keyTag | Integer | Required | The DNSSEC keyTag |
|
algorithm | Integer | Required | The DNSSEC algorithm |
Possible values:
|
digestType | Integer | Required | The DNSSEC digest type |
Possible values:
|
digest | String | Required | The digest of the public key |
|
Name | Type | Required / Optional | Description | Restrictions |
---|---|---|---|---|
product | String | Required | The product |
|
action | Enum | Required | The action |
Possible values:
|
quantity | Integer | Optional | The maximum quantity, default 1 |
Besides the generic errors these specific error responses can be expected.
Type | Status | Description |
---|---|---|
BillableAcknowledgmentNeededException | 400 Bad Request |
POST
/v2/domains/domainName/update
Content-Type: application/json
{}
Many different scenarios for changes to DNS settings exist, below are general rules to follow and examples for common scenarios.
The way the records are provisioned can be changed both via update domain and update zone, some examples for update domain
{ "zone": { "link": false } }
{ "zone": { "template": "example" } }
{ "zone": { "master": "1.2.3.4" } }
{ "zone": { "master": "" } }
It is possible to change DNS service, migrating the existing records to the new service. If the zone currently has a master only the records and a optional link with a template are migrated, the master synchronisation is not. The zone at the old service is marked for deletion in 7 days.
A zone of the target service must not yet exist, otherwise the existing zone is adopted.
{ "zone": { "service": "BASIC" } }
To avoid deletion of a zone, always specify the zone field when changing vanity name servers.
For details on how to setup correct resolution of vanity name server see our Knowledge Base
{ "ns": ["ns1.yourname.com", "ns2.yourname.com"], "zone": { "service": "PREMIUM", "template: "example" } }
{ "ns": ["ns1.yourname.com", "ns2.yourname.com"], "zone": {} }
{ "ns": ["ns1.other.com", "ns2.other.com"] }
{ "ns": [] }
Adoption of zones cannot be combined with changes to the zone, the service must be specified to adopt other a zone other than BASIC. Other zone field must be omitted or equal to the current zone.
If the current zone is pending deletion it can be reinstated and adopted by, if however a template or master is specified a new zone will be created instead and the pending deletion zone is removed immediately.
{ "zone": {} }
After decoupling, both the zone and domain remain unchanged, however any future changes to the zone or domain that are interdependent are not synchronised automatically anymore. e.g. dnssec changes, vanity name server changes, key rollover, zone cleanup after domain deletion.
This is not supported on BASIC zones since those are only ever active in DNS when in a managed state.
This can be useful if you want to transfer the domain but keep the zone active.
{ "zone": { "managed": false } }