NSX-T Data Center REST API

Associated URIs:

API Description API Path

Delete DNS configuration for tier-1 instance


Delete DNS configuration for tier-1 instance
DELETE /policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder
DELETE /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder

Read the DNS Forwarder for the given tier-1 instance


Read the DNS Forwarder for the given tier-1 instance
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder

Create or update the DNS Forwarder


Create or update the DNS Forwarder
PATCH /policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder
PATCH /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder

Perform the specified DNS forwarder action


Perform the specified action for Tier0 DNS forwarder on specified enforcement point.
POST /policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder
POST /policy/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder
POST /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder

Create or update the DNS Forwarder


Create or update the DNS Forwarder
PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder
PUT /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder

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 Active/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 /policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder/failed-queries
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder/failed-queries
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder/failed-queries

Resolve a given address via the dns forwarder at Tier1


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).
If enforcement point is specified, then DNS forwarder nslookup answer will get fetched from
specified enforcement point. Otherwise from all enforcement points.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder/nslookup
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder/nslookup
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder/nslookup

Get tier-1 DNS forwarder statistics


Get statistics of tier-1 DNS forwarder.
- no enforcement point path specified: Statistics will be evaluated on each enforcement
point.
- {enforcement_point_path}: Statistics are evaluated only on the given enforcement point.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder/statistics
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder/statistics
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder/statistics

Get current status of tier-1 DNS forwarder


Get current status of tier-1 DNS forwarder.
- no enforcement point path specified: Status will be evaluated on each enforcement
point.
- {enforcement_point_path}: Status will be evaluated only on the given enforcement
point.
GET /policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder/status
GET /policy/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder/status
GET /policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/tier-1s/{tier-1-id}/dns-forwarder/status