---
title: "Domain object"
url: "https://help.internetx.com/en/api/core-domain-object/"
lang: "en"
section: "API reference — API reference (XML/JSON)"
breadcrumb: "API documentation (JSON/XML) > Objects"
updated: "2023-09-25"
---

# Domain object

## Description

The _Domain_ object represents the domain.

## Structure

| **Keyword JSON** | **Keyword XML** | **Occurs** | **Type** | **Format** | **Description** |
| --- | --- | --- | --- | --- | --- |
| abuseEmail |  | 0 - 1 | string |  | Deprecated |
| action |  | 0 - 1 | Enum |  | Deprecated |
| adminc | adminc | 0 - 1\*) | integer/object | int32/[Contact](/en/api/core-contact-object/) | Domain contact ID of the administrative contact person or complete <contact> - block<br>Example with ID:<br>JSON: "adminc":{"id":100000}<br>XML: <adminc>100000</adminc><br>Example with a new contact (no ID):<br>JSON: "adminc":{ "fname":"john", "lname":"doe", //... }<br>XML: <adminc><br><fname>john</fname><br><lname>doe</lname> <!-- ... -→ </adminc> |
| authInfo |  | 0 - 1 | string |  | The AuthInfo for a transfer. |
| autoDnsSec | use\_auto\_dnssec | 0 - 1 | boolean |  | Enables or disables the use of DNSSEC.<br>Possible values:<br>• false = deactivates DNSSEC<br>• true = activates DNSSEC<br>Default value = false<br>For XML, 0 (false) and 1 (true) can also be used.<br>This keyword can only be used if the system manages DNSSEC completely. This only works for certain name servers, e.g. NodeSecure.<br>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 | [AutoRenewStatus Constants](/en/api/core-auto-renew-status-constants/) | Describes the status of the domain during the automatic runtime prolongation (AutoRenew). |
| cancelationStatus | cancelation | 0 - 1 | enum | [CancelationStatus Constants](/en/api/core-cancelation-status-constants/) | Describes the status of the domain at cancellation. |
| comment | comment | 0 - 1 | string |  | Domain comments.<br>Updates (JSON) only via: PUT /domain/{name}/\_comment.<br>The user needs the appropriate ACLs. |
| confirmOrder | confirm\_order | 0 - 1 | boolean |  | Some TLDs require the confirmation of the registration conditions.<br>Possible values:<br>• false = Do not confirm conditions<br>• true = Confirm conditions<br>Default value = false<br>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.<br>Possible values:<br>• false oder empty = Agreement is not given. Consequence:   The request is not accepted<br>• true= Agreement is given<br>Default value = false<br>For XML, 0 (false) and 1 (true) can also be used.<br>The confirmation is required since 07.12.2016 due to the new ICANN owner change procedure. |
| created |  | 0 - 1 | String | date-time | Date of creation. |
| dnssec | dnssec | 0 - n | object | [DNSSEC](/en/api/core-dnssec-object/) | Indicates whether DNSSEC is enabled for the domain or not. Transferring the key material to the registry and removing it from the registry. |
| dnssecData | dnssec | 0 - n | object | [DNSSEC](/en/api/core-dnssec-object/) | Submits the key material to the registry. If the list is empty, the key material is deleted at the registry. If the key is omitted during an update, the data is retained. |
| domainsafe | domainsafe | 0 - 1 | boolean |  | Activate DomainSafe<br>• false = domain is not in the domainsafe<br>• true= domain is in the domainsafe<br>Default value = false<br>For XML, 0 (false) and 1 (true) can also be used. |
| expire |  | 0 - 1 | string | date-time | The expire date of the domain at the registry |
| generalRequestEmail | general\_request\_email | 0 - 1 | string |  | Deprecated |
| parkingExtensions | extension | 0 -1 | object |  | Deprecated |
| 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<br>Possible values:<br>• false= Whois is not ignored<br>• true = Whois is ignored<br>Default value = false<br>For XML, 0 (false) and 1 (true) can also be used.<br>In JSON the behavior is set via the query parameter "ignoreWhois", e.g. "?ignoreWhois". |
| includeWildcard | include\_wildcard | 0 -1 | boolean |  | Activate the IncludeWildcard function.<br>Possible values:<br>• false = inactive<br>• true = active<br>Default value = false<br>For XML, 0 (false) and 1 (true) can also be used. |
| includeWWW | www\_include | 0 - 1 | boolean |  | Activate the IncludeWWW function when creating the zone. Only applies to _DomainCreate_ and _DomainTransfer_.<br>Possible values:<br>• false = inactive<br>• true = active<br>Default value = false<br>For XML, 0 (false) and 1 (true) can also be used.<br>If an Ip address is entered in the "mainIP" field, the www record is created on the name server. |
| logId | log\_id | 0 - 1 | integer64 |  | The identifier 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.<br>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](/en/api/core-name-server-object/) | Nameserver |
| ?nsCheck=ALL | nscheck | 0 - 1 | enum | [DNSCheck](/en/api/core-dns-check-enum/) | Additional name server check is performed. Before the domain operation is executed.<br>In JSON by query parameter: `?nsCheck=ALL` |
| owner | owner | 0 - 1 |  |  | The object owner. |
| ownerc | ownerc | 0 - 1\*) | integer/object | int32/[Contact](/en/api/core-contact-object/) | Domain contact ID of the domain owner or complete <contact> - Block |
| parking | parking | 0 - 1 | enum | [ParkingProvider Constants](/en/api/core-parking-provider-constants/) | Deprecated |
| payable | payable | 1 | string | date-time | The date on which the domain will be billed the next time<br>The billing date can be queried with the [DomainInfo](/en/api/core-domain-info/) task. |
| period | period | 0 - 1\*) | integer | int64 | Registration period.<br>Default value is the minimum term. The period is automatically extended. |
| priceClass | price\_class | 0 - 1 | string |  | Price class. Required for premium domains.<br>The price class can be inquired by the [_DomainPremiumList_](/en/api/core-domain-premium-list/) or [_DomainPremiumInfo_](/en/api/core-domain-premium-info/) task. |
| priceClassRenew | price\_class\_renew | 0 - 1 | string |  | The price class to be used for the Domain 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.<br>Possible values:<br>• false = Whois Privacy Service is not used<br>• true = Whois Privacy Service is used<br>Default value = false<br>For XML, 0 (false) and 1 (true) can also be used.<br>Optional and limited to certain TLDs. The [DomainInfo](/en/api/core-domain-info/)  task enquires the corresponding TLDs. |
| privacyPlus | use\_privacy\_plus | 0 - 1 | boolean |  | Activate PrivacyPlus.<br>Possible values:<br>• false = PrivacyPlus ist not activated<br>• true = PrivacyPlus is activated<br>Default value = false<br>For XML, 0 (false) and 1 (true) can also be used. |
| privacyPlusMail | privacy\_plus\_email | 0 - 1 | string |  | The Privacy Plus email. With WHOIS Privacy Plus, an individual email address is generated for each domain. |
| rddsOptIn | rdds\_opt\_in | 0 - 1 | enum | [RddsOptInConstants](/en/api/core-rdds-optin-constants/) | Controls the information to be displayed in Whois. Currently only NOT\_SET and ALL are supported. |
| registrarStatus | registrar\_status | 0 - 1 | enum | [RegistryStatus Constants](/en/api/core-registry-status-constants/) | Status of the domain at the registry. |
| registrarStatusReason | registrar\_status\_reason | 0 - 1 | string |  | Reason for the set status of the domain at the registrar. |
| registryStatus | registry\_status | 0 - 1 | enum | [RegistryStatus Constants](/en/api/core-registry-status-constants/) | 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.<br>Possible values:<br>• false = The cancelation request is not deleted.<br>• true = The cancelation request is deleted.<br>Default value = false<br>For XML, 0 (false) and 1 (true) can also be used.<br>If a cancelation order exists and "0" is set, the renew fails.<br>In JSON, the flag can be used as a query parameter:<br>`?removeCancelation` |
| servicesAdd | services\_add | 0 - 1 | enum | [DomainServices](/en/api/core-domain-services-object/) | Add Domain Services |
| servicesRem | services\_rem | 0 - 1 | enum | [DomainServices](/en/api/core-domain-services-object/) | Remove Domain Services |
| techc | techc | 0 - 1\*) | integer/object | int32/[Contact](/en/api/core-contact-object/) | Domain contact ID of the technical contact or complete <contact> - Block |
| tmchClaimsNoticeExtensions |  | 0 - 1 | object | [DomainTMCHClaim NoticeExtensions](/en/api/core-domain-tmch-claim-notice-extensions/) | TMCH extensions |
| trustee | use\_trustee | 0 - 1 | boolean |  | Enable trustee service for the domain.<br>Possible values:<br>• false = Trustee service is not used<br>• true = Trustee service is used<br>Default value = false<br>For XML, 0 (false) and 1 (true) can also be used. |
| updated | updated | 0 - 1 | string | date-time | Date of the last update. |
| updater | updater | 0 - 1 | object | [Basic User](/en/api/core-basic-user-object/) | User who performed the last update. |
| validCertificate | certificate | 0 - 1 | boolean |  | There is a suitable certificate for the domain.<br>Possible values:<br>• false = No certificate<br>• true = There is a certificate<br>Default value = false<br>For XML, 0 (false) and 1 (true) can also be used. |
| zone | zone | 1 | object | [Domain Zone](/en/api/core-domain-zone-object/) object for XML, for JSON Zone object. | Zone settings for the domain. (DNS settings) |
| zonec | zonec | 0 - 1\*) | integer/object | int32/[Contact](/en/api/core-contact-object/) | Domain contact ID of the ZoneC or complete  <contact> –block. |
|  | overwrite\_authinfo | 0 - 1 | boolean |  | Overwrite the AuthInfo when updating the domain.<br>Possible values:<br>• false = AuthInfo is not overwritten. An existing AuthInfo is kept.<br>• true = The AuthInfo is replaced by a new one.<br>Default value = false<br>For XML, 0 (false) and 1 (true) can also be used.<br>Not usable for TLDs whose registry does not support updating the AuthInfo via a domain update (e.g. Denic) |

\*) depends on the registry.