List DNS servers

GET 
/network/dns/:interfaceName

Retrieve the list of currently configured DNS servers for a specific network interface.

Request

Path Parameters

interfaceName stringrequired

The name of the network interface to retrieve DNS configuration for. Must only contain letters and numbers.

Responses

200

List of DNS servers.

application/json

Schema

Schema

servers string[]

List of configured DNS servers.

search_domains string[]

List of search domains.

Example (from schema)

{
  "servers": [
    "string"
  ],
  "search_domains": [
    "string"
  ]
}

400

Invalid interface name provided.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

401

Unauthorized - API key required

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

403

Forbidden - Insufficient permissions

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

500

Error retrieving DNS servers.

application/json

Schema

Schema

error string

A description of the error that occurred.

details string

Additional details about the error.

code integer

The error code.

Example (from schema)

{
  "error": "Failed to retrieve status.",
  "details": "Failed due to network timeout.",
  "code": 500
}

Loading...