Management Plane API > Networking > Services > DNS

Associated URIs:

API Description	API Path
Get a paginated list of DNS forwarders Get a paginated list of DNS forwarders.	GET /api/v1/dns/forwarders
Create a DNS forwader Create a DNS forwader upon a logical router. There is only one DNS forwarder can be created upon a given logical router.	POST /api/v1/dns/forwarders
Delete a specific DNS forwarder Delete a specific DNS forwarder.	DELETE /api/v1/dns/forwarders/<forwarder-id>
Retrieve a DNS forwarder Retrieve a DNS forwarder.	GET /api/v1/dns/forwarders/<forwarder-id>
Clear the current cache of the DNS forwarder. Clear the current cache of the DNS forwarder.	POST /api/v1/dns/forwarders/<forwarder-id>?action=clear_cache
Enable the DNS forwarder. Enable the DNS forwarder if the forwarder is currently disabled. If the DNS forwarder is already enabled, the forwarder will not be re-enabled. Please note, once a DNS forwarder is disabled then enabled, the previous DNS forwarder statistics counters will be reset.	POST /api/v1/dns/forwarders/<forwarder-id>?action=enable
Disable the DNS forwarder. Disable the DNS forwarder if the forwarder is currently enbled. If the DNS forwarder is already disabled, the forwarder will not be re-disabled. Please note, once a DNS forwarder is disabled then enabled, the previous DNS forwarder statistics counters will be reset.	POST /api/v1/dns/forwarders/<forwarder-id>?action=disable
Update a specific DNS forwarder Update a specific DNS forwarder.	PUT /api/v1/dns/forwarders/<forwarder-id>
Get the recent failed DNS queries Return the given count of recent failed DNS queries from DNS forwarder. Since the DNS forwarder is running in Acitve/Standby HA mode on transport nodes, the given count of queries will be returned from each nodes. Hence the total queries returned could be doubled. If no count is specified, 100 recent failed queries are returned. If the recent failures is less than the given count, all the failures will be returned. The maximum count is 1,000.	GET /api/v1/dns/forwarders/<forwarder-id>/failed-queries
Resolve a given address via the DNS forwarder Query the nameserver for an ip-address or a FQDN of the given an address optionally using an specified DNS server. If the address is a fqdn, nslookup will resolve ip-address with it. If the address is an ip-address, do a reverse lookup and answer fqdn(s).	GET /api/v1/dns/forwarders/<forwarder-id>/nslookup
Get the realized state of a DNS forwarder Return the realized state information of a DNS forwarder. After a DNS forwarder was created or updated, you can invoke this API to check the realization state of the forwarder.	GET /api/v1/dns/forwarders/<forwarder-id>/state
Get current status of the given DNS forwarder Returns the current status of the given DNS forwarder.	GET /api/v1/dns/forwarders/<forwarder-id>/status