Need help? Call Live Support at +31 (0) 38 453 07 59

Attention! You're currently using the OT&E environment.

Update Domain

Used to update a domain name. Only specified fields are updated, to remove an optional field specify it as empty.

  • POSTMethod
  • /v2/domains/domainName/updateURL
  • application/jsonContent-Type
URL fields
Name Type Description Restrictions
domainName String The domain name
  • Regular expression: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+(?:[a-z][a-z0-9-]{0,61}[a-z0-9])$
  • Minimum length: 3
  • Maximum length: 255
  • Registry specific restrictions may apply
Request parameters
Name Type Required / Optional Description Restrictions
quote Boolean Optional If true, validate the request and request a quote for the action
Request content fields
Name Type Required / Optional Description Restrictions
registrant String Optional New registrant handle for the domain
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
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
  • Maximum length: 64
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 ([])
  • Cannot be used in combination with the "zone" field
  • Regular expression: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+(?:[a-z][a-z0-9-]{0,61}[a-z0-9])$
  • Maximum number of items: 10
  • Minimum length: 4
  • Maximum length: 255
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:

  • OK: Ok
  • INACTIVE: Inactive
  • PENDING_TRANSFER: Pending transfer
  • PENDING_RENEW: Pending renew
  • PENDING_UPDATE: Pending update
  • DELETE_REQUESTED: Delete requested
  • PENDING_DELETE: Pending delete
  • ADD_PERIOD: Add period
  • RENEW_PERIOD: Renew period
  • AUTO_RENEW_PERIOD: Auto renew period
  • TRANSFER_PERIOD: Transfer period
  • REDEMPTION_PERIOD: Redemption period
  • PENDING_RESTORE: Pending restore
  • CLIENT_HOLD: Client hold
  • CLIENT_DELETE_PROHIBITED: Client delete prohibited
  • CLIENT_UPDATE_PROHIBITED: Client update prohibited
  • CLIENT_RENEW_PROHIBITED: Client renew prohibited
  • CLIENT_TRANSFER_PROHIBITED: Client transfer prohibited
  • REGISTRAR_HOLD: Registrar hold
  • REGISTRAR_DELETE_PROHIBITED: Registrar delete prohibited
  • REGISTRAR_UPDATE_PROHIBITED: Registrar update prohibited
  • REGISTRAR_RENEW_PROHIBITED: Registrar renew prohibited
  • REGISTRAR_TRANSFER_PROHIBITED: Registrar transfer prohibited
  • SERVER_HOLD: Server hold
  • SERVER_DELETE_PROHIBITED: Server delete prohibited
  • SERVER_UPDATE_PROHIBITED: Server update prohibited
  • SERVER_RENEW_PROHIBITED: Server renew prohibited
  • SERVER_TRANSFER_PROHIBITED: Server transfer prohibited
  • PENDING_VALIDATION: Domain pending registrant validation
  • PRIVACY_PROTECT_PROHIBITED: Privacy protect prohibited
  • EXPIRED: Domain has expired
  • IRTPC_TRANSFER_PROHIBITED: Transfer prohibited due to IRTP-C
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:

  • NONE
  • OLD
  • NEW
  • BOTH
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 ([])
  • cannot be used in combination with the "ns" and "keyData" fields
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 ([])
  • Cannot be used in combination with the "zone" field
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 ([])
  • Cannot be used in combination with the "zone" field
billables List < billables > Optional Acknowledgment of billables for this request
zone
Name Type Required / Optional Description Restrictions
template String Required Name of the template
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
link Boolean Optional Unless false, the zone is linked to the template
contacts
Name Type Required / Optional Description Restrictions
role Enum Required The role for the contact

Possible values:

  • ADMIN
  • BILLING
  • TECH
handle String Required The contact handle
  • Regular expression: [a-zA-Z0-9\-_@\.]+
  • Minimum length: 3
  • Maximum length: 40
keyData
Name Type Required / Optional Description Restrictions
protocol Integer Required The DNSSEC protocol

Possible values:

  • 3
flags Integer Required The DNSSEC flags

Possible values:

  • 256: 256 (ZSK)
  • 257: 257 (KSK)
algorithm Integer Required The DNSSEC algorithm

Possible values:

  • 3: 3 (DSA/SHA1)
  • 5: 5 (RSA/SHA-1)
  • 6: 6 (DSA-NSEC3-SHA1)
  • 7: 7 (RSASHA1-NSEC3-SHA1)
  • 8: 8 (RSA/SHA-256)
  • 10: 10 (RSA/SHA-512)
  • 12: 12 (GOST R 34.10-2001)
  • 13: 13 (ECDSA Curve P-256 with SHA-256)
  • 14: 14 (ECDSA Curve P-384 with SHA-384)
  • 15: 15 (Ed25519)
  • 16: 16 (Ed448)
publicKey String Required The base64 encoded public key
dsData
Name Type Required / Optional Description Restrictions
keyTag Integer Required The DNSSEC keyTag
  • Maximum value: 65536
  • Minimum value: 0
algorithm Integer Required The DNSSEC algorithm

Possible values:

  • 3: 3 (DSA/SHA1)
  • 5: 5 (RSA/SHA-1)
  • 6: 6 (DSA-NSEC3-SHA1)
  • 7: 7 (RSASHA1-NSEC3-SHA1)
  • 8: 8 (RSA/SHA-256)
  • 10: 10 (RSA/SHA-512)
  • 12: 12 (GOST R 34.10-2001)
  • 13: 13 (ECDSA Curve P-256 with SHA-256)
  • 14: 14 (ECDSA Curve P-384 with SHA-384)
  • 15: 15 (Ed25519)
  • 16: 16 (Ed448)
digestType Integer Required The DNSSEC digest type

Possible values:

  • 1: 1 (SHA-1)
  • 2: 2 (SHA-256)
  • 3: 3 (GOST R 34.11-94)
  • 4: 4 (SHA-384)
digest String Required The digest of the public key
billables
Name Type Required / Optional Description Restrictions
product String Required The product
action Enum Required The action

Possible values:

  • CREATE
  • REQUEST
  • TRANSFER
  • RENEW
  • RESTORE
  • TRANSFER_RESTORE
  • UPDATE
  • REGISTRANT_CHANGE
  • LOCAL_CONTACT
  • NEGATIVE_MARKUP
  • PRIVACY_PROTECT
  • EXTRA_WILDCARD
  • EXTRA_DOMAIN
  • REGISTRY_LOCK
quantity Integer Optional The maximum quantity, default 1

Successful request

Domain has been updated successfully
  • 200 OKHTTP Status
  • application/jsonContent-Type
Domain update has been requested successfully, you will be notified with the final result
  • 202 AcceptedHTTP Status

Failed requests

Besides the generic errors these specific error responses can be expected.

Error responses
Type Status Description
BillableAcknowledgmentNeededException 400 Bad Request
URL fields
The domain name
Request parameters
If true, validate the request and request a quote for the action
Request parameters
New registrant handle for the domain
Privacy protect setting

Specify as empty string: The new auth code for the domain name, if specified as empty string ("") a new random auth code will be generated
The auto renew setting for the domain name
Auto renewal period in months. Registry specific values are available in metadata.

Specify as empty list: List of name servers to use for the domain name, to remove all name servers specify as empty list ([])
New domain statuses, you can only add and remove CLIENT statuses, IRTPC_TRANSFER_PROHIBITED can only be removed, other statuses must remain unchanged
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.
zone
Name of the template
Unless false, the zone is linked to the template
contacts
The role for the contact
The contact handle
The role for the contact
The contact handle
The role for the contact
The contact handle
keyData
DNSSEC Key data for domain, to remove all DS data records specify as empty list ([])
The DNSSEC protocol
The DNSSEC flags
The DNSSEC algorithm
The base64 encoded public key
dsData
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 ([])
The DNSSEC keyTag
The DNSSEC algorithm
The DNSSEC digest type
The digest of the public key
billables
The product
The action
The maximum quantity, default 1
Request

POST /v2/domains/domainName/update
Content-Type: application/json 

{}
Response