Skip to content

DNS

DNS configuration within virtual networks, including zone and record management for resolving names across the overlay network. Requires virtual-networks::read to view, virtual-networks::modify to manage.

Operations

Get a network's DNS configuration

Request

Requires virtual-networks::read permission.

Security
JWTAuthorizer
Path
networkNamestringrequired

Network name

domainNamestringrequired

Domain name

curl -i -X GET \
  'https://apidocs.trustgrid.io/_mock/v2/domain/{domainName}/network/{networkName}/dns' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
enabledboolean

Whether DNS is enabled for the network

serverstring

IP address of the DNS server

Example:"1.1.1.13"
orgIdstring

Organization ID

networkNamestring

Virtual network name this config belongs to

domainNamestring

Domain name this config belongs to

typestring

Object type discriminator

Example:"DNSConfig"
Response
{
  "enabled": true,
  "server": "1.1.1.13",
  "orgId": "string",
  "networkName": "string",
  "domainName": "string",
  "type": "DNSConfig"
}