Schemas
These models describe how API requests and responses are shaped. Each one is linked from the endpoints that use it.
| Schema | Description | Endpoints |
|---|---|---|
A |
— | — |
AAAA |
— | — |
ALIAS |
— | — |
authinfoResponse |
— | 1 |
baseResult |
— | 38 |
CAA |
— | — |
CNAME |
— | — |
csr |
PEM encoded certificate signing request (CSR). | — |
dnssecCapabilities |
— | — |
dnssecDisplayState |
High-level DNSSEC status. | — |
dnssecJobResponse |
— | 1 |
dnssecMode |
Requested DNSSEC operating mode. - none: no registry DNSSEC should remain active - regfish: regfish signs the zone and manages registry trust anchors - external: the caller supplies DNSSEC records for external authoritative nameservers |
— |
dnssecRecord |
— | — |
dnssecRecordKind |
— | — |
dnssecRequest |
— | 1 |
dnssecResponse |
— | 4 |
dnssecState |
Fine-grained registry DNSSEC state. | — |
dnsZoneCounts |
— | — |
dnsZoneDelegationNameserver |
— | — |
dnsZoneDetailResponse |
— | 1 |
dnsZoneRecordResponse |
Superset record representation returned by the detailed zone endpoint. Record-specific fields such as priority, flags, or tag are included when applicable. |
— |
dnsZoneSOA |
— | — |
dnsZoneSummaryResponse |
— | 1 |
domain_name_checkable |
A domain name to check. Unlike fqdn_relaxed this also accepts internationalised names (e.g. müller-shop.de); they are converted to punycode and validated against the public suffix list server-side. |
1 |
domainAvailabilityResponse |
— | 1 |
domainDetailsResponse |
— | 1 |
domainListFilter |
— | — |
domainListResponse |
— | 1 |
domainListSortKey |
— | 1 |
domainResponse |
— | — |
Error |
— | 163 |
fqdn |
Fully Qualified Domain Name (FQDN, ending with a period). | — |
fqdn_or_subdomain |
Fully Qualified Domain Name (FQDN) or subdomain. You can use the @ symbol to represent your apex domain (e.g., example.com). Wildcards are supported. |
— |
fqdn_relaxed |
Fully Qualified Domain Name. | 12 |
helpSearchResponse |
— | 1 |
hostingAlias |
— | 1 |
hostingDatabase |
— | 1 |
hostingPackage |
— | 2 |
ipv4 |
— | — |
ipv6 |
— | — |
MX |
— | — |
nameserversResponse |
— | 2 |
nameserversUpdateRequest |
— | 1 |
record |
— | — |
recordRequest |
— | 1 |
recordRequestFQDN |
— | 2 |
recordResponse |
— | 5 |
recordResponseAdditionalReqFQDN |
— | — |
recordResponseAdditionalReqRRID |
— | — |
recordResponseAdditionalState |
— | — |
recordType |
— | — |
rrid |
Resource Record ID | 3 |
sortOrder |
— | 1 |
tlsCertificateCancelRequest |
— | 1 |
tlsCertificateCompleteRequest |
— | 1 |
tlsCertificateDcvMethod |
— | — |
tlsCertificateDownloadFormat |
— | 1 |
tlsCertificateId |
Public TLS certificate ID | 7 |
tlsCertificateOrderCancellationMode |
— | — |
tlsCertificateOrderCancelRequest |
— | 1 |
tlsCertificateOrganization |
— | — |
tlsCertificateProduct |
regfish TLS certificate product identifier. | — |
tlsCertificateProvider |
— | — |
tlsCertificateReissueRequest |
— | 1 |
tlsCertificateReissueResponse |
— | — |
tlsCertificateReissueStatus |
— | — |
tlsCertificateRequest |
— | 1 |
tlsCertificateResponse |
— | 8 |
tlsCertificateRevocationReason |
Revocation reason. | — |
tlsCertificateRevocationScope |
— | — |
tlsCertificateRevokeRequest |
— | 1 |
tlsCertificateStatus |
— | — |
tlsOrganizationCreateRequest |
— | 1 |
tlsOrganizationId |
Public TLS organization ID | 2 |
tlsOrganizationPatchRequest |
— | 1 |
tlsOrganizationResponse |
— | 4 |
tlsOrganizationStatus |
— | — |
tlsProductAuthority |
— | — |
tlsProductResponse |
— | 1 |
tlsProductSpecs |
— | — |
tlsProductValidationLevel |
— | — |
tlsProductValidationType |
— | — |
tlsValidation |
— | — |
tlsValidationDnsRecord |
— | — |
tokenInfoResponse |
— | 1 |
ttl |
Time To Live (60-604800) | — |
TXT |
— | — |
type |
— | — |