GET DNS Monitor Health.

POST

/api/observability/synthetic_monitor/namespaces/{namespace}/dns-monitors-health

curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/observability/synthetic_monitor/namespaces/example/dns-monitors-health \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "include_latency": true, "monitor_names": [ "example" ], "namespace": "example" }'

• F5 Distributed Cloud Console

Returns list of DNS monitors in namespace with corresponding region health(s)

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Request namespace.

Request Body^required

Media typeapplication/json

GetDNSMonitorHealthRequest

Request of DNS Monitor Health.

object

include_latency

include_latency

True indicate response include latency per monitor per region.

boolean format: boolean

monitor_names

monitor_names

List of monitor names.

Array<string>

namespace

namespace

Request namespace.

string

>= 6 characters <= 1024 characters

Example^generated

{
  "include_latency": true,
  "monitor_names": [
    "example"
  ],
  "namespace": "example"
}

Responses

200

A successful response.

Media typeapplication/json

GetDNSMonitorHealthResponseList

List of health statuses by region for specified monitors.

object

items

items

A list of DNS monitor health responses.

Array<object>

GetDNSMonitorHealthResponse

Health status by region for specified monitor.

object

health

health

Monitor health.

string

<= 1024 characters

monitor_name

monitor_name

Monitor name.

string

<= 1024 characters

sources

sources

List of monitor health by region.

Array<object>

SourceHealthItem

Health status by region.

object

health

health

Monitor health.

string

<= 1024 characters

latency

latency

Current monitor latency, unit is ms.

string

<= 1024 characters

provider

provider

Region provider.

string

>= 3 characters <= 1024 characters

source

source

Monitor source.

string

<= 1024 characters

Example^generated

{
  "items": [
    {
      "health": "example",
      "monitor_name": "example",
      "sources": [
        {
          "health": "example",
          "latency": "example",
          "provider": "example",
          "source": "example"
        }
      ]
    }
  ]
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example