- Home
- API Enriched
- 🌐 Dns API
🌐 Dns API
Name resolution with zone transfers and health checks. Record types and delegation support.
- Category: Networking
- Complexity: advanced
- Paths: 49 | Schemas: 285
- Tier: Standard
- Related domains:
virtual,network
Use Cases
Section titled “Use Cases”- Configure DNS load balancing
- Manage DNS zones and domains
- Configure DNS compliance policies
- Manage resource record sets (RRSets)
Primary Resources
Section titled “Primary Resources”- dns_zone: Authoritative DNS zone with record management capabilities
- dns_domain: DNS domain delegation and configuration settings
- dns_load_balancer: DNS-based traffic distribution with geographic routing and failover
Endpoints
Section titled “Endpoints”| Method | Path | Description |
|---|---|---|
| POST | /api/config/namespaces/{metadata.namespace}/dns_compliance_checkss | Create DNS Compliance Checks. |
| PUT | /api/config/namespaces/{metadata.namespace}/dns_compliance_checkss/{metadata.name} | Replace DNS Compliance Checks. |
| GET | /api/config/namespaces/{namespace}/dns_compliance_checkss | List Configure DNS Compliance Checks. |
| GET | /api/config/namespaces/{namespace}/dns_compliance_checkss/{name} | GET DNS Compliance Checks. |
| DELETE | /api/config/namespaces/{namespace}/dns_compliance_checkss/{name} | DELETE Configure DNS Compliance Checks. |
| POST | /api/config/namespaces/{metadata.namespace}/dns_proxies | Create DNS Proxy. |
| PUT | /api/config/namespaces/{metadata.namespace}/dns_proxies/{metadata.name} | Replace DNS Proxy. |
| GET | /api/config/namespaces/{namespace}/dns_proxies | List Configure DNS Proxy. |
| GET | /api/config/namespaces/{namespace}/dns_proxies/{name} | GET DNS Proxy. |
| DELETE | /api/config/namespaces/{namespace}/dns_proxies/{name} | DELETE Configure DNS Proxy. |
| POST | /api/config/namespaces/{metadata.namespace}/dns_domains | Create DNS Domain. |
| PUT | /api/config/namespaces/{metadata.namespace}/dns_domains/{metadata.name} | Replace DNS Domain. |
| POST | /api/config/namespaces/{namespace}/dns_domain/{name}/verify | Verify DNS Domain. |
| GET | /api/config/namespaces/{namespace}/dns_domains | List DNS Domain. |
| GET | /api/config/namespaces/{namespace}/dns_domains/{name} | GET DNS Domain. |
| DELETE | /api/config/namespaces/{namespace}/dns_domains/{name} | DELETE DNS Domain. |
| POST | /api/config/dns/namespaces/system/suggest-values | Suggest Values. |
| POST | /api/config/dns/namespaces/{metadata.namespace}/dns_load_balancers | Create DNS Load Balancer. |
| PUT | /api/config/dns/namespaces/{metadata.namespace}/dns_load_balancers/{metadata.name} | Replace DNS Load Balancer. |
| GET | /api/config/dns/namespaces/{namespace}/dns_load_balancers | List DNS Load Balancer. |
| GET | /api/data/namespaces/{namespace}/dns_load_balancers/health_status | DNS Load Balancer Health Status List. |
| GET | /api/data/namespaces/{namespace}/dns_load_balancers/pool_members_health_status | DNS Load Balancer Pool Members Health Status List. |
| GET | /api/data/namespaces/{namespace}/dns_load_balancers/{dns_lb_name}/dns_lb_pools/{dns_lb_pool_name}/health_status | DNS Load Balancer Pool Health Status. |
| GET | /api/data/namespaces/{namespace}/dns_load_balancers/{dns_lb_name}/dns_lb_pools/{dns_lb_pool_name}/pool_members/{pool_member_address}/health_status_change_events | DNS Load Balancer Pool Member Health Status Change Events. |
| GET | /api/config/dns/namespaces/{namespace}/dns_load_balancers/{name} | GET DNS Load Balancer. |
| DELETE | /api/config/dns/namespaces/{namespace}/dns_load_balancers/{name} | DELETE DNS Load Balancer. |
| GET | /api/data/namespaces/{namespace}/dns_load_balancers/{name}/health_status | DNS Load Balancer Health Status. |
| POST | /api/config/dns/namespaces/{metadata.namespace}/dns_lb_health_checks | Create DNS Load Balancer Health Check. |
| PUT | /api/config/dns/namespaces/{metadata.namespace}/dns_lb_health_checks/{metadata.name} | Replace DNS Load Balancer Health Check. |
| GET | /api/config/dns/namespaces/{namespace}/dns_lb_health_checks | List DNS Load Balancer Health Check. |
| GET | /api/config/dns/namespaces/{namespace}/dns_lb_health_checks/{name} | GET DNS Load Balancer Health Check. |
| DELETE | /api/config/dns/namespaces/{namespace}/dns_lb_health_checks/{name} | DELETE DNS Load Balancer Health Check. |
| POST | /api/config/dns/namespaces/{metadata.namespace}/dns_lb_pools | Create DNS Load Balancer Pool. |
| PUT | /api/config/dns/namespaces/{metadata.namespace}/dns_lb_pools/{metadata.name} | Replace DNS Load Balancer Pool. |
| GET | /api/config/dns/namespaces/{namespace}/dns_lb_pools | List DNS Load Balancer Pool. |
| GET | /api/config/dns/namespaces/{namespace}/dns_lb_pools/{name} | GET DNS Load Balancer Pool. |
| DELETE | /api/config/dns/namespaces/{namespace}/dns_lb_pools/{name} | DELETE DNS Load Balancer Pool. |
| POST | /api/config/dns/namespaces/system/dns_zone/clone_from_dns_domain | Clone from DNSDomain. |
| POST | /api/config/dns/namespaces/system/dns_zone/import | Import F5 Cloud Services DNS Zone. |
| POST | /api/config/dns/namespaces/system/dns_zone/import_axfr | Import DNS Zone. |
| POST | /api/config/dns/namespaces/system/dns_zone/import_bind_create | Import BIND Files. |
| POST | /api/config/dns/namespaces/system/dns_zone/import_bind_validate | Validate BIND Files. |
| POST | /api/config/dns/namespaces/{metadata.namespace}/dns_zones | Create DNS Zone. |
| PUT | /api/config/dns/namespaces/{metadata.namespace}/dns_zones/{metadata.name} | Replace DNS Zone. |
| GET | /api/config/dns/namespaces/{namespace}/dns_zone/{dns_zone_name}/local_zone_file | GET Local Zone File. |
| GET | /api/config/dns/namespaces/{namespace}/dns_zone/{dns_zone_name}/remote_zone_file | GET Remote Zone File. |
| GET | /api/config/dns/namespaces/{namespace}/dns_zone/{dns_zone_name}/zone_file/export | Export Zone File. |
| GET | /api/config/dns/namespaces/{namespace}/dns_zones | List DNS Zone. |
| POST | /api/data/namespaces/{namespace}/dns_zones/metrics | DNS Zone Metrics. |
| POST | /api/data/namespaces/{namespace}/dns_zones/request_logs | GET DNS Zone Request Logs. |
| GET | /api/config/dns/namespaces/{namespace}/dns_zones/{name} | GET DNS Zone. |
| DELETE | /api/config/dns/namespaces/{namespace}/dns_zones/{name} | DELETE DNS Zone. |
| POST | /api/config/dns/namespaces/system/dns_zones/{dns_zone_name}/rrsets/{group_name} | Create |
| GET | /api/config/dns/namespaces/system/dns_zones/{dns_zone_name}/rrsets/{group_name}/{record_name}/{type} | GET |
| DELETE | /api/config/dns/namespaces/system/dns_zones/{dns_zone_name}/rrsets/{group_name}/{record_name}/{type} | DELETE |
| PUT | /api/config/dns/namespaces/system/dns_zones/{dns_zone_name}/rrsets/{group_name}/{record_name}/{type} | Replace |
| POST | /api/config/dns/namespaces/system/dns_management/addon/subscribe | Subscribe to DNS Management. |
| POST | /api/config/dns/namespaces/system/dns_management/addon/unsubscribe | Unsubscribe to DNS Management. |