- Home
- API reference
- API documentation (JSON/XML)
- Objects
Domain restore object (JSON) restore object (XML)
Description
The Restore (XML) or DomainRestore (JSON) object maps a domain to be restored.
Structure
Keyword JSON | Keyword XML | Occurs | Type | Format | Description |
|---|---|---|---|---|---|
abuseEmail | 0 - 1 | string | The email address for abuse emails. | ||
| action | action | 0 - 1 | enum | Deprecated | |
| adminc | adminc | 0 - 1*) | integer/object | int32/Contact | Domain contact ID of the administrative contact person or complete <contact> - block |
| authInfo | 0 - 1 | string | The AuthInfo for a transfer | ||
| autoDnsSec | use_auto_dnssec | 0 - 1 | boolean | Enables or disables the use of DNSSEC. Possible values:
Default value = false For XML, 0 (false) and 1 (true) can also be used. This keyword can only be used if the system manages DNSSEC completely. This only works for certain name servers, e.g. NodeSecure. To manage only the key material, use the keyword DNSSEC. | |
| autodnsSecJob | auto_dnssec_job | 0 - 1 | object | DNSSecJob | Contains the information about a running AutoDnsSec job. |
| autoRenewStatus | autorenew | 0 - 1 | enum | Describes the status of the domain during the automatic runtime extension (AutoRenew) | |
| cancelationStatus | cancelation | 0 - 1 | enum | Describes current cancelation status of the domain. | |
| comment | comment | 0 - 1 | string | Domain comments. Updates (JSON) only via: The user needs the appropriate ACLs. | |
| confirmOrder | confirm_order | 0 - 1 | boolean | Some TLDs require the confirmation of the registration conditions. Possible values:
Default value = false For XML, 0 (false) and 1 (true) can also be used. | |
| confirmOwnerConsent | confirm_owner_consent | 0 - 1*) | boolean | Confirmation of the domain holder's agreement to changes. Required for gTLDs and new gTLDs when changing the name, email address or organization of the domain holder. Possible values:
Default value = false For XML, 0 (false) and 1 (true) can also be used. The confirmation is required since 07.12.2016 due to the new ICANN owner change procedure. | |
| created | 0 - 1 | string | date-time | Date on which the restore object was created. | |
| deleted | deleted | 0 -1 | string | date-time | Cancelation date |
dnssec | dnssec | 0 - n | object | Transfering the key material to the registry and removing it from the registry. | |
dnssecData | dnssec | 0 - n | object | DNSSEC | The DNSSEC Data |
| domainCreated | domain_created | 0 - 1 | string | date-time | Date on which the domain was registered at the registry. |
domainsafe | domainsafe | 0 - 1 | boolean | Activate DomainSafe
Default value = false For XML, 0 (false) and 1 (true) can also be used. | |
expire | 0 - 1 | string | date-time | Expiring date of the domain at the registry. | |
| extensions | object | Additional data required by some registries. | |||
| generalRequestEmail | general_request_email | 0 - 1 | string | Email address | |
| idn | 0 - 1 | string | Is set if the domain is an IDN domain and the domain name is written in UTF-8, e.g. müller.de. | ||
| ignoreWhois | ignore_whois | 0 - 1 | boolean | Avoid availability query Possible values:
Default value = false For XML, 0 (false) and 1 (true) can also be used. | |
logId | log_id | 0 - 1 | number | integer64 | Log ID that is required for the DomainHistoryInfo task. |
name | name | 1 | string | domain | Name of the domain |
nameServerEntries | nsentry | 0 - 5*) | string | Nsentry entry. For .de domains only. If nsentry is used, the request must not contain an nserver. For bulk requests, specify nsentry in the "Default" block, the domain must then be replaced with the placeholder {domain}. | |
nameServerGroup | ns_group | 0 - 1 | string | The name server group, which could be determined from the name servers. | |
nameServers | nserver | 0 - 8*) | object | Nameserver | |
| nicMemberLabel | nic_member_label | 0 - 1 | string | The NIC Member Label | |
owner | owner | 0 - 1 | The owner of the object | ||
ownerc | ownerc | 0 - 1*) | integer/object | int32/Contact | Domain contact ID of the domain owner or complete <contact> - Block |
parking | parking | 0 - 1 | enum | Deprecated | |
payable | payable | 1 | string | date-time | |
period | period | 0 - 1*) | integer | int64 | Registration period. The default value is the minimum registration period. The runtime is automatically extended. |
priceClassRenew | price_class_renew | 0 - 1 | string | Priceclass for Renew | |
privacy | use_privacy | 0 - 1 | boolean | Use of the Whois Privacy Service, which prevents your contact information from being displayed in the public Whois of the domain. Possible values:
Default value = false For XML, 0 (false) and 1 (true) can also be used. Optional and limited to certain TLDs. The DomainInfo task enquires the corresponding TLDs. | |
privacyPlus | use_privacy_plus | 0 - 1 | boolean | Activate PrivacyPlus. Possible values:
Default value = false For XML, 0 (false) and 1 (true) can also be used. | |
privacyPlusMail | privacy_plus_email | 0 - 1 | string | The PrivacyPlus email | |
rddsOptIn | rdds_opt_in | 0 - 1 | enum | Specifies the Whois output. | |
registrarStatus | registrar_status | 0 - 1 | enum | Status of the domain at the registrar. | |
registrarStatusReason | registrar_status_reason | 0 - 1 | string | Reason for the set status of the domain at the registrar. | |
registryStatus | registry_status | 0 - 1 | enum | Sets the status of the domain after the "Create" process. | |
removeCancelation | remove_cancelation | 0 - 1 | boolean | If the domain is renewed, a cancelation reqest can be deleted at the same time. Possible values:
Default value = false For XML, 0 (false) and 1 (true) can also be used. If a cancelation order exists and "0" is set, the renew fails. In JSON, the flag can be used as a query parameter:
| |
| restorePhaseEnd | end_of_phase | 0 - 1 | string | date-time | The end of the current restore phase. |
servicesAdd | services_add | 0 - 1 | enum | Add Domain Services | |
servicesRem | services_rem | 0 - 1 | enum | Remove Domain Services | |
techc | techc | 0 - 1*) | integer/object | int32/Contact | Domain contact ID of the technical contact or complete <contact> - Block |
| tmchClaimsNoticeExtensions | 0 - 1 | object | DomainTMCHClaim NoticeExtensions | TMCH extensions | |
trustee | use_trustee | 0 - 1 | boolean | Usage of Trustee service Possible values:
Default value = false For XML, 0 (false) and 1 (true) can also be used. | |
updated | updated | 0 - 1 | string | date-time | Date of last update. |
updater | updater | 0 - 1 | object | User who performed the last update | |
validCertificate | certificate | 0 - 1 | boolean | There is a suitable certificate for the domain. Possile values:
Default value = false For XML, 0 (false) and 1 (true) can also be used. | |
zone | zone | 1 | object | Domain Zone (XML) | Zone settings for the domain. |
zonec | zonec | 0 - 1*) | integer/object | int32/Contact | Domain contact ID of the ZoneC or complete <contact> –block. |