API reference

/v1/dns

23 operations

← All groups

MethodPathSummaryAuth
GET/v1/dns/platform-configRead the installation-wide DNS configuration (节点管理 > DNS配置, platform administrator)Session
PUT/v1/dns/platform-configSave the installation-wide DNS configuration and synchronise every tenant copySession
POST/v1/dns/platform-config/{kind}Start 记录修复 (repair) or 清除CDN无关解析 (cleanup) as background jobsSession
GET/v1/dns/platform-zonesList the CNAME domains (CNAME域名)Session
POST/v1/dns/platform-zonesAdd a CNAME domain (copied into every tenant; the first is the default allocation zone)Session
PATCH/v1/dns/platform-zones/{id}Edit a CNAME domain; renaming one with allocated CNAMEs is refused (dns_zone_in_use)Session
DELETE/v1/dns/platform-zones/{id}Delete a CNAME domain and its tenant copies; refused while sites use it (dns_zone_in_use)Session
GET/v1/dns/providersList DNS provider configurationsSession
POST/v1/dns/providersStore an encrypted DNS provider configurationSession
PATCH/v1/dns/providers/{id}Update provider metadata or replace encrypted credentialsSession
DELETE/v1/dns/providers/{id}Delete an unreferenced DNS provider configurationSession
POST/v1/dns/providers/{id}/verifyVerify a DNS provider credential against its upstream APISession
GET/v1/dns/recordsList structured records in a zoneSession
POST/v1/dns/recordsCreate a validated draft DNS recordSession
PATCH/v1/dns/records/{id}Update a validated draft DNS recordSession
DELETE/v1/dns/records/{id}Delete a draft DNS recordSession
GET/v1/dns/settingsRead the DNS settings for the active tenant scopeSession
PATCH/v1/dns/settingsUpdate the compatibility DNS TTL with compare-and-swap semanticsSession
GET/v1/dns/settings/operations/{operation_id}Read a DNS DNS operation statusSession
POST/v1/dns/settings/{kind}Enqueue record repair or CDN-unrelated record cleanupSession
GET/v1/dns/zonesList DNS zonesSession
POST/v1/dns/zonesCreate a draft DNS zoneSession
DELETE/v1/dns/zones/{id}Delete an unreferenced draft DNS zoneSession

Contract file:api/openapi/v1/control.yaml api/openapi/v1/dns-acme.yaml