Schemas
Diese Modelle beschreiben, wie Anfragen und Antworten der API aufgebaut sind. Jedes ist von den Endpunkten verlinkt, die es verwenden.
| Schema | Beschreibung | Endpunkte |
|---|---|---|
A | ||
AAAA | ||
ALIAS | ||
authinfoResponse | 1 | |
baseResult | 39 | |
CAA | ||
CNAME | ||
csr | PEM-kodierter Certificate Signing Request (CSR). | |
dnssecCapabilities | ||
dnssecDisplayState | Übergeordneter DNSSEC-Status. | |
dnssecJobResponse | 1 | |
dnssecMode | Gewünschter DNSSEC-Betriebsmodus. none: Es soll kein Registry-DNSSEC aktiv bleiben; regfish: regfish signiert die Zone und verwaltet die Trust Anchors bei der Registry; external: Der Aufrufer liefert die DNSSEC-Records für externe autoritative Nameserver | |
dnssecRecord | ||
dnssecRecordKind | ||
dnssecRequest | 1 | |
dnssecResponse | 4 | |
dnssecState | Feingranularer DNSSEC-Zustand bei der Registry. | |
dnsZoneCounts | ||
dnsZoneDelegationNameserver | ||
dnsZoneDetailResponse | 1 | |
dnsZoneRecordResponse | Record-Darstellung als Obermenge, wie sie der Endpunkt für die Zone im Detail liefert. Record-spezifische Felder wie priority, flags oder tag sind enthalten, soweit sie zutreffen. | |
dnsZoneSOA | ||
dnsZoneSummaryResponse | 1 | |
domain_name_checkable | Zu prüfender Domainname. Anders als bei fqdn_relaxed werden hier auch internationalisierte Namen akzeptiert (z. B. müller-shop.de); sie werden serverseitig in Punycode umgewandelt und gegen die Public Suffix List geprüft. | 1 |
domainAvailabilityResponse | 1 | |
domainDetailsResponse | 1 | |
domainListFilter | ||
domainListResponse | 1 | |
domainListSortKey | 1 | |
domainResponse | ||
Error | 172 | |
fqdn | Fully Qualified Domain Name (FQDN, mit abschließendem Punkt). | |
fqdn_or_subdomain | Fully Qualified Domain Name (FQDN) oder Subdomain. Das Zeichen @ steht dabei für die Apex-Domain (z. B. example.com). Wildcards werden unterstützt. | |
fqdn_relaxed | Fully Qualified Domain Name. | 12 |
helpSearchResponse | 1 | |
HINFOStored | ||
hostingAlias | 1 | |
hostingDatabase | 1 | |
hostingPackage | 2 | |
ipv4 | ||
ipv6 | ||
MX | ||
nameserversResponse | 2 | |
nameserversUpdateRequest | 1 | |
NAPTRStored | ||
NSStored | ||
prepareOrderPosition | ||
prepareOrderRequest | 1 | |
prepareOrderResponse | 1 | |
PTRStored | ||
record | ||
recordRequest | 1 | |
recordRequestFQDN | 2 | |
recordResponse | 5 | |
recordResponseAdditionalReqFQDN | ||
recordResponseAdditionalReqRRID | ||
recordResponseAdditionalState | ||
recordStored | Ein Record eines Typs, den die API so zurückgibt, wie er gespeichert ist, aber weder anlegt noch ändert (Verwaltung im dash). data enthält die Rohdaten des Records. Die NS-Records am Apex gehören nicht zur Record-Liste; dafür gibt es die Nameserver-Endpunkte. | |
recordType | ||
recordTypeStored | ||
RPStored | ||
rrid | Resource-Record-ID | 3 |
sortOrder | 1 | |
SRV | Service-Record (RFC 2782). Der Name trägt die Labels für Dienst und Protokoll (_imaps._tcp.example.com), data ist der Zielhost als FQDN mit abschließendem Punkt. Clients versuchen zuerst die niedrigste Priorität und verteilen die Last innerhalb derselben Priorität nach Gewicht. | |
TLSA | TLSA-Record (DANE, RFC 6698 und RFC 7672). Der Name trägt die Labels für Port und Protokoll (_25._tcp.mail.example.com), data sind die Zertifikatsdaten als Hexadezimalziffern (Leerzeichen erlaubt, Groß- und Kleinschreibung egal). Gespeichert wird der Record als usage selector matching_type data, das Hex in Kleinbuchstaben ohne Leerzeichen. Die Daten müssen die Länge des gewählten Hashs haben: 64 Hexziffern für SHA-256 (Matching Type 1), 128 für SHA-512 (Matching Type 2). Matching Type 0 (vollständige Daten) wird bis zu einer gespeicherten Länge von 250 Zeichen angenommen; für alles Längere verwenden Sie einen Hash. | |
tlsCertificateCancelRequest | 1 | |
tlsCertificateCompleteRequest | 1 | |
tlsCertificateDcvMethod | ||
tlsCertificateDownloadFormat | 1 | |
tlsCertificateId | Öffentliche TLS-Zertifikats-ID | 7 |
tlsCertificateOrderCancellationMode | ||
tlsCertificateOrderCancelRequest | 1 | |
tlsCertificateOrganization | ||
tlsCertificateProduct | Bezeichner des regfish-TLS-Zertifikatsprodukts. | |
tlsCertificateProvider | ||
tlsCertificateReissueRequest | 1 | |
tlsCertificateReissueResponse | ||
tlsCertificateReissueStatus | ||
tlsCertificateRequest | 1 | |
tlsCertificateResponse | 8 | |
tlsCertificateRevocationReason | Widerrufsgrund. | |
tlsCertificateRevocationScope | ||
tlsCertificateRevokeRequest | 1 | |
tlsCertificateStatus | ||
tlsOrganizationCreateRequest | 1 | |
tlsOrganizationId | Öffentliche TLS-Organisations-ID | 2 |
tlsOrganizationPatchRequest | 1 | |
tlsOrganizationResponse | 4 | |
tlsOrganizationStatus | ||
tlsProductAuthority | ||
tlsProductResponse | 1 | |
tlsProductSpecs | ||
tlsProductValidationLevel | ||
tlsProductValidationType | ||
tlsValidation | ||
tlsValidationDnsRecord | ||
tokenInfoResponse | 1 | |
ttl | Time To Live in Sekunden (60-86400) | |
TXT | ||
type |