Set DNS records of a name
Set the records of one name and type in the DNS zone of a domain - replacing what is there.
Sets the records of one name and type in the DNS zone of a domain at manitu: the values given replace all records of that name and type. host is relative to the domain ("@" the domain itself, "www", "*.dev"); a value is written as in a zone file, a TXT as the text itself, and a name in a value without a final dot is relative to the domain. The same call again changes nothing (changed false). One more value is manitu_domain_dns_zone_record_addPOST /v1/domain/dns/zone/record/add, removing manitu_domain_dns_zone_record_deletePOST /v1/domain/dns/zone/record/delete, many changes at once manitu_domain_dns_zone_setPOST /v1/domain/dns/zone/set. The NS records of the domain itself are manitu's (apex_ns_not_allowed); NS of a subdomain delegate it, never at a wildcard (wildcard_ns_not_allowed); a CNAME stands alone (cname_not_alone), with one value only (cname_single_value), and never at the domain itself (cname_at_apex). A value that cannot be right is refused with its reason (ipv4_address_invalid, target_hostname_invalid ...), a subdomain delegated to manitu's own name servers with ns_target_is_provider; warnings point at likely mistakes (record_duplicate, an address not of the account or not on the internet ...). Refused with a conflict when manitu does not hold the zone (zone_not_hosted_here), the domain is not active (zone_not_editable) or the zone changed since zone_revision (zone_changed). Every change counts the serial up and answers the new zone_revision, the base of the next change. Made with a session of the customer panel, the call is carried out at once; otherwise the caller confirms it first: approval_required with the way call_again, then the same call again with its approval_token - unless the access is set to make such changes without asking. For a record of type MX, NS, SRV or CAA, at a wildcard, or at the host _acme-challenge, autodiscover or autoconfig (and below), it waits instead until a person signed in to the customer panel approves it (approval_required; its state: manitu_approval_getPOST /v1/approval/get).
Counts against: writes (60 per hour per account)
manitu_domain_dns_zone_record_set on https://mcp.manitu.de/mcpAnnotations as tools/list sends them
Description for the model
Sets the records of one name and type in the DNS zone of a domain at manitu - the values given replace all records of that name and type ("point home at 203.0.113.7", "the MX of the domain are ..."). host is relative to the domain ("@" the domain itself, "www", "*.dev"); a value as in a zone file, a TXT the text itself; a name in a value without a final dot is relative to the domain. The same call again changes nothing (changed false). To add one more value use manitu_domain_dns_zone_record_addPOST /v1/domain/dns/zone/record/add, to remove manitu_domain_dns_zone_record_deletePOST /v1/domain/dns/zone/record/delete; for many changes at once manitu_domain_dns_zone_setPOST /v1/domain/dns/zone/set. Tell the user the name, type and values first and wait for an explicit yes - web site and e-mail of the domain depend on the zone. The NS records of the domain itself are manitu's (apex_ns_not_allowed); NS of a subdomain delegate it, never at a wildcard (wildcard_ns_not_allowed); a CNAME stands alone (cname_not_alone) and never at the domain itself (cname_at_apex). A value that cannot be right is refused with its reason (ipv4_address_invalid, target_hostname_invalid ...), a subdomain delegated to manitu's own name servers with ns_target_is_provider; hints come as warnings (record_duplicate, an address not of the account or not on the internet ...). Refused with a conflict when manitu does not hold the zone (zone_not_hosted_here), the domain is not active (zone_not_editable) or the zone changed since zone_revision (zone_changed). Every change counts the serial up and answers the new zone_revision - pass that one with the next change. A new serial after your own change is expected, not a change by someone else.
Reasons it may answer: resource_not_found, permission_missing, zone_not_hosted_here, zone_not_editable, zone_changed and 21 more. Warnings it may answer: invalid_record_kept, ipv4_address_not_global, ipv6_address_not_global, mx_missing, mx_target_without_address, record_duplicate and 3 more.
Arguments
name (required)stringThe domain name, with international characters or in ASCII.
host (required)stringThe name of the record, relative to the domain: "@" for the domain itself, "www" for www.<domain>, "*.dev" for a wildcard - with international characters or in ASCII.
type (required)stringThe record type.
zone_revisionstringOptional: zone_revision from manitu_domain_dns_zone_getPOST /v1/domain/dns/zone/get or from the answer to the last change - refused with zone_changed if the zone changed since. A new zone_revision after your own change is expected, not a change by someone else.
value_list (required)array of stringThe values - all of them: what is not listed is removed. A CNAME has exactly one.
ttlintegerHow long resolvers may keep it, in seconds. Left out: the zone's default.
approval_tokenstringwrite-onlyThe token of the way call_again from the approval_required answer of the same call - only after the user said yes to everything in its elements. Valid 15 minutes, once.
Result structuredContent, checked against the schema
namestringThe domain, with international characters.
hoststringThe name of the record, relative to the domain, in ASCII; "@" for the domain itself.
typestringchangedbooleanfalse: it was so already - nothing was stored.
ttlinteger | nullThe TTL of the records now, in seconds; null: the zone's default.
value_listarray of stringThe values of this host and type now, as stored - empty when there are none left.
zone_revisionstringThe revision of the zone now.
Authentication
One of X-API-Key, Authorization: Bearer … - never more than one in a request. More
Request body JSON; unknown fields are refused
name (required)stringThe domain name, with international characters or in ASCII.
host (required)stringThe name of the record, relative to the domain: "@" for the domain itself, "www" for www.<domain>, "*.dev" for a wildcard - with international characters or in ASCII.
type (required)stringThe record type.
zone_revisionstringOptional: zone_revision from manitu_domain_dns_zone_getPOST /v1/domain/dns/zone/get or from the answer to the last change - refused with zone_changed if the zone changed since.
value_list (required)array of stringThe values - all of them: what is not listed is removed. A CNAME has exactly one.
ttlintegerHow long resolvers may keep it, in seconds. Left out: the zone's default.
approval_tokenstringwrite-onlyThe token of the way call_again from the approval_required answer of the same call - only after the user said yes to everything in its elements. Valid 15 minutes, once.
Response in data; the rest of the body as on every call
namestringThe domain, with international characters.
hoststringThe name of the record, relative to the domain, in ASCII; "@" for the domain itself.
typestringchangedbooleanfalse: it was so already - nothing was stored.
ttlinteger | nullThe TTL of the records now, in seconds; null: the zone's default.
value_listarray of stringThe values of this host and type now, as stored - empty when there are none left.
zone_revisionstringThe revision of the zone now.
Statuses
200Success.400The input is wrong, or the request itself (INVALID_INPUT). Each entry names its field and its reason - correct the input and call again.401No credential was presented, or it was not recognised (UNAUTHENTICATED).403The credential is valid, but may not do this (PERMISSION_DENIED). The reason says why - another credential is the way, not a repeat.404What the call names does not exist, or not for this caller (NOT_FOUND). Look it up again - do not guess another.409Not possible in the current state (PRECONDITION_FAILED). The reason says what stands in the way; the same call may succeed once it has changed.429Too many calls. The Retry-After header says when to try again.500The server failed. Nothing about the request was wrong. Whether a change took effect is not known - check before trying it again.503The channel this operation forwards through is unavailable.Errors reasons it is known to fail with - all of them
resource_not_foundWhat the call names does not exist in the account, or not for this access.NOT_FOUNDpermission_missingThis access lacks a permission the call needs; the main access of the account can grant it.PERMISSION_DENIEDzone_not_hosted_hereThe zone of the domain is not a primary zone held here - its name servers are elsewhere.PRECONDITION_FAILEDzone_not_editableThe domain is not active, so its zone cannot be changed.PRECONDITION_FAILEDzone_changedThe zone changed since it was read: read it again and apply the change again.PRECONDITION_FAILEDzone_stored_not_readableThe zone as stored cannot be read; the provider has to repair it.PRECONDITION_FAILEDzone_not_loadableThe name server would not load the zone; the old zone stays.INVALID_INPUTcname_not_aloneA CNAME stands alone at its name - no other record beside it.INVALID_INPUTwildcard_ns_not_allowedNS records delegate one name, never a wildcard.INVALID_INPUTcaa_invalidA CAA record is not flags, a tag and a value.INVALID_INPUTipv4_address_invalidAn A record holds no IPv4 address.INVALID_INPUTipv6_address_invalidAn AAAA record holds no IPv6 address.INVALID_INPUTport_out_of_rangeA port is outside 0 to 65535.INVALID_INPUTpriority_out_of_rangeA priority is outside 0 to 65535.INVALID_INPUTsvcb_params_invalidThe parameters of an HTTPS or SVCB record are not valid.INVALID_INPUTtarget_hostname_invalidA target is no host name - no URL, no port, no path.INVALID_INPUTtlsa_invalidA TLSA record is not usage, selector, matching type and a digest of the right length.INVALID_INPUTtype_unknownA record type no zone can hold.INVALID_INPUTvalue_invalidThe value is not one of the type.INVALID_INPUTweight_out_of_rangeA weight is outside 0 to 65535.INVALID_INPUTns_target_is_providerA subdomain delegated to manitu's own name servers, which hold the zone already.INVALID_INPUTapex_ns_not_allowedThe NS records of the domain itself are the provider's - neither added nor removed.INVALID_INPUTcname_at_apexA CNAME cannot stand at the domain itself, beside its SOA and NS.INVALID_INPUThost_invalidThe host is no DNS name.INVALID_INPUTname_needs_final_dotA name written with the domain at its end needs a final dot - or none of the domain.INVALID_INPUTcname_single_valueA CNAME has one value.INVALID_INPUTWarnings never block the call
invalid_record_keptA record is not valid (code), but stored so already - kept, not refused. Tell the user; it should be repaired or removed.ipv4_address_not_globalAn IPv4 address that is not reachable on the internet (private, loopback ...).ipv6_address_not_globalAn IPv6 address that is not reachable on the internet (link-local, unique local ...).mx_missingNo MX record - no mail for the domain is taken.mx_target_without_addressAn MX target within the zone has no A, AAAA or CNAME record.record_duplicateA record is there twice.ipv4_address_not_in_accountAn IPv4 address that is not one of the account's.ipv6_address_not_in_accountAn IPv6 address that is not one of the account's.mx_target_is_mail_client_hostAn MX record names the host for mail programs, which takes no mail from other servers - suggested_target does.