Get an IP Address for a DNS Name
get
/api/device/Devices/readIpForDns
Gets the IPv4 or IPv6 address for the specified DNS name.
Request
Query Parameters
-
DNSName(required): string
The DNS name to get the IP address for.Example:
router1.example.com
-
Type(required): string
The type of IP address to get. Valid values are IPv4 and IPv6.Example:
IPv4
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: string
The IP address for the specified DNS name.Example:
192.0.2.1
-
message:
The response message.Example:
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object