Replace DNS Monitor.

PUT

/api/observability/synthetic_monitor/namespaces/{metadata.namespace}/v1_dns_monitors/{metadata.name}

curl --request PUT \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/observability/synthetic_monitor/namespaces/example/v1_dns_monitors/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "metadata": { "annotations": {}, "description": "example", "disable": true, "labels": {}, "name": "example", "namespace": "example" }, "spec": { "domain": "example", "external_sources": [ { "aws": { "regions": [ "example" ] }, "f5xc": { "regions": [ "example" ] } } ], "health_policy": { "dynamic_threshold": { "eval_period": "EVAL_PERIOD_3_MINS", "std_dev_val": "STD_DEV_VAL_3" }, "dynamic_threshold_disabled": {}, "static_max_threshold": { "eval_period": "EVAL_PERIOD_3_MINS", "max_response_time": 1 }, "static_max_threshold_disabled": {}, "static_min_threshold": { "eval_period": "EVAL_PERIOD_3_MINS", "min_response_time": 1 }, "static_min_threshold_disabled": {} }, "interval_12_hours": {}, "interval_15_mins": {}, "interval_1_day": {}, "interval_1_hour": {}, "interval_1_min": {}, "interval_30_mins": {}, "interval_30_secs": {}, "interval_5_mins": {}, "interval_6_hours": {}, "lookup_timeout": 1, "name_servers": [ { "name_server": "example", "port": 1 } ], "on_failure_count": 1, "on_failure_to_all": {}, "on_failure_to_any": {}, "protocol": "example", "receive": "example", "record_type": "example", "source_critical_threshold": 1 } }'

• F5 Distributed Cloud Console

Replace the contents of a DNS Monitor.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

metadata.namespace

required

string

Namespace This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

metadata.name

required

string

Name The configuration object to be replaced will be looked up by name.

Request Body^required

Media typeapplication/json

ReplaceRequest is used to replace contents of a v1_dns_monitor

This is the input message of the ‘Replace’ RPC.

object

metadata

object

annotations

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

object

description

description

Human readable description for the object.

string

>= 21 characters <= 1200 characters

disable

disable

A value of true will administratively disable the object.

boolean format: boolean

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.

object

name

name

This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.

string

>= 6 characters <= 1024 characters

namespace

namespace

This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

string

>= 6 characters <= 1024 characters

spec

object

domain

Required: YES.

string format: hostname

>= 26 characters <= 2048 characters

external_sources

Internet facing monitor sources

Required: YES.

Array<object>

>= 1 items <= 8 items

Source

A location where a monitor runs.

object

aws

object

regions

AWS Regions

A specific source location within AWS Required: YES.

Array<string>

f5xc

object

regions

F5 Distributed Cloud Regions

A specific source location within F5 Distributed Cloud Required: YES.

Array<string>

health_policy

object

dynamic_threshold

object

eval_period

string

default: EVAL_PERIOD_3_MINS

Allowed values: EVAL_PERIOD_3_MINS EVAL_PERIOD_5_MINS EVAL_PERIOD_10_MINS EVAL_PERIOD_15_MINS

std_dev_val

string

default: STD_DEV_VAL_3

Allowed values: STD_DEV_VAL_3 STD_DEV_VAL_4 STD_DEV_VAL_5 STD_DEV_VAL_6

dynamic_threshold_disabled

object

static_max_threshold

object

eval_period

string

default: EVAL_PERIOD_3_MINS

Allowed values: EVAL_PERIOD_3_MINS EVAL_PERIOD_5_MINS EVAL_PERIOD_10_MINS EVAL_PERIOD_15_MINS

max_response_time

max_response_time

The maximum response time value that must be exceeded before the monitor turns critical. Required: YES.

integer format: int64

static_max_threshold_disabled

object

static_min_threshold

object

eval_period

string

default: EVAL_PERIOD_3_MINS

Allowed values: EVAL_PERIOD_3_MINS EVAL_PERIOD_5_MINS EVAL_PERIOD_10_MINS EVAL_PERIOD_15_MINS

min_response_time

min_response_time

The minimum value that response time must fall below before the monitor turns critical. Required: YES.

integer format: int64

static_min_threshold_disabled

object

interval_12_hours

object

interval_15_mins

object

interval_1_day

object

interval_1_hour

object

interval_1_min

object

interval_30_mins

object

interval_30_secs

object

interval_5_mins

object

interval_6_hours

object

lookup_timeout

The amount of time in milliseconds before the monitor considers a pending request to be a failure Required: YES.

integer format: int64

name_servers

Human-readable name for the resource

Array<object>

Custom Name Server

Custom nameserver to execute the monitor against.

object

name_server

Name Server

IP address of the nameserver to execute the monitor against Required: YES.

string

<= 1024 characters

port

Port

Port of the nameserver to execute the monitor against.

integer format: int64

>= 1 <= 65535

on_failure_count

The number of times a monitor must fail before the global monitor changes health Required: YES.

integer format: int64

on_failure_to_all

object

on_failure_to_any

object

protocol

Required: YES.

string

<= 1024 characters

receive

The regex pattern that the monitor looks for in the returned resource. If the text string is returned, the monitor is healthy.

string

<= 2048 characters

record_type

Required: YES.

string

<= 1024 characters

source_critical_threshold

The number of provider-regions a monitor must fail from before the global monitor changes health Required: YES.

integer format: int64

Responses

200

A successful response.

Media typeapplication/json

object

Example^generated

{}

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