Suche in diesem Bereich

Skip to end of metadata
Go to start of metadata


Table of Contents

Description

The Domain object represents the domain.

Structure

Keyword JSON

Keyword XML

Occurs

Type

Format

Description

abuseEmail


0 - 1

string


The email address for abuse emails.

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:

  • 0 = deactivates DNSSEC
  • 1 = actvates DNSSEC

Default = 0

"True" can also be used as a value.

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_job0 - 1object

DNSSecJob

Contains the information about a running AutoDnsSec job.

autoRenewStatus

autorenew

0 - 1

enum

AutoRenewStatusConstants

Describes the status of the domain during the automatic runtime extension (AutoRenew)

cancelationStatus

cancelation0 - 1

enum

CancelationStatusConstants

Describes current cancelation status of the domain.

comment

comment

0 - 1

string


Domain comments.

Updates (JSON) only via:
PUT /domain/{name}/_comment.

The user needs the appropriate ACLs.

confirmOrder

confirm_order

0 - 1

boolean


Some TLDs require the confirmation of the registration conditions.

Possible values:

  • 0 = Do nor confirm conditions
  • 1 = Confirm conditions

Default value= 0

"True" can also be used as a value.

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:

  • 0 oder empty = Agreement is not given. Consequence:   The request is not accepted
  • 1= Agreement is given

Default value = 0 

"True" can also be used as a value.

The confirmation is required since 07.12.2016 due to the new ICANN owner change procedure.

created


0 - 1

String

date-time

Registration date of the domain.

dnssec

dnssec

0 - n

object

DNSSEC

Transfering  the key material to the registry and removing it from the registry.

dnssecData

dnssec0 - nobjectDNSSEC

The DNSSEC Data

domainsafe

domainsafe

0 - 1

boolean


Activate DomainSafe

  • 0 = domain is not in the domainsafe
  • 1 = domain is in the domainsafe

Default = 0

expire


0 - 1

string

date-time

Expiring date of the domain at the registry.

generalRequestEmailgeneral_request_email0 - 1string
email address

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

Possible values:

  • 0 = Whois is not ignored
  • 1 = Whois is ignored

Default = 0

"True" can also be used as a value.

includeWildcard

include_wildcard0 -1

boolean


Activate the IncludeWildcard function.

Possible values:

  • 0 = inactive
  • 1 = active

Default value = 0

includeWWW

www_include0 - 1

boolean


Activate the IncludeWWW function when creating the zone. Only applies to DomainCreate and DomainTransfer.

Possible values:

  • 0 = inactive
  • 1 = active

Default value = 0

logId

log_id0 - 1

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_group0 - 1

string


The name server group, which could be determined from the name servers.

nameServers

nserver

0 - 8*)

object

NameServer


Nameserver

?nsCheck=ALL

nscheck

0 - 1

enum

DNSCheck

Additional name server check is performed. Before the domain operation is executed.

In JSON by query parameter: ?nsCheck=ALL

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

ParkingProviderConstants

Deprecated

payable

payable

1

string

date-time

Current billing date of the domain

The billing date can be queried with the DomainInfo task.

period

period

0 - 1*)

integer

int64

Registration period.

The default value is the minimum registration period. The runtime is automatically extended.

priceClass

price_class

0 - 1

string


Price class. Required for premium domains.

The price class can be inquired by the DomainPremiumList or DomainPremiumInfo task.

priceClassRenew

price_class_renew0 - 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:

  • 0 = Whois Privacy Service is not used
  • 1 = Whois Privacy Service is used

Default= 0

"True" can also be used as a value.

Optional and limited to certain TLDs. The DomainInfo  task enquires the corresponding TLDs.

privacyPlus

use_privacy_plus0 - 1

boolean


Activate PrivacyPlus.

Possible values:

  • 0 = PrivacyPlus ist not activated
  • 1 = PrivacyPlus is activated

Default value = 0

privacyPlusMail

privacy_plus_email0 - 1

string


The PrivacyPlus email

rddsOptIn

rdds_opt_in0 - 1

enum

RddsOptInConstants

Specifies the Whois output:

registrarStatus

registrar_status0 - 1

enum

RegistryStatusConstants

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

RegistryStatusConstants

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:

  • 0 = The cancelation request is not deleted.
  • 1 = The cancelation request is deleted.

Default= 0

"True" can also be used as a value.

If a cancelation order exists and "0" is set, the renew fails.

In JSON, the flag can be used as a query parameter:

 ?removeCancelation

servicesAdd

services_add0 - 1

enum

DomainServices

Add Domain Services

servicesRem

services_rem0 - 1

enum

DomainServices

Remove Domain Services

techc

techc

0 - 1*)

integer/object

int32/Contact

Domain contact ID of the technical contact or complete <contact> - Block

tmchClaimsNoticeExtensions
0 - 1objectDomainTMCHClaimNoticeExtensionsTMCH extensions

trustee

use_trustee

0 - 1

boolean


Usage of Trustee service

Possible values:

  • 0 = Trustee service  is not used
  • 1 = Trustee service  is used

Default = 0

"True" can also be used as a value.

updated

updated

0 - 1

string

date-time

Date of last update.

updater

updater

0 - 1

object

Basic User

User who performed the last update

validCertificate

certificate0 - 1

boolean


There is a suitable certificate for the domain.

Possile values:

  • 0 = No certificate
  • 1 = There is a certificate

Default value = 0

zone

zone

1

object

Domain Zone object for XML, for JSON Zone object.

Zone settings for the domain.

zonec

zonec

0 - 1*)

integer/object

int32/Contact

Domain contact ID of the ZoneC or complete  <contact> –block.


overwrite_authinfo

0 - 1

boolean


Overwrite the AuthInfo when updating the domain.

Possible values:

  • 0 = AuthInfo is not overwritten. An existing AuthInfo is kept.
  • 1 = The AuthInfo is replaced by a new one.

Default = 1

"True" can also be used as a value.

Not usable for TLDs whose registry does not support updating the AuthInfo via a domain update (e.g. Denic)