UtilitiesWAN

testSiteSsrDnsResolution

POST
/api/v1/sites/{site_id}/devices/{device_id}/resolve_dns

DNS resolutions are performed on the Device.

The output will be available through websocket. As there can be multiple commands issued against the same SSR at the same time and the output all goes through the same websocket stream, session is used for demux.

Subscribe to Device Command outputs

WS /api-ws/v1/stream

{    "subscribe": "/sites/{site_id}/devices/{device_id}/cmd"}
Example output from ws stream
 Router      | Hostname               | Resolved | Last Resolved        | Expiration-------------|------------------------|----------|----------------------|--------------------- test-device | xxx.yyy.net            | Y        | 2022-03-28T03:56:49Z | 2022-03-28T03:57:49Z

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

site_id*string
Formatuuid
device_id*string
Formatuuid

Response Body

curl -X POST "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab/devices/000000ab-00ab-00ab-00ab-0000000000ab/resolve_dns"
{  "session": "19e73828-937f-05e6-f709-e29efdb0a82b"}