Used to update a domain name. Only specified fields are updated, to remove an optional field specify it as empty.
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 ([]) |
|
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 |
---|---|---|---|---|
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
{}