​

ves-io-schema-dns_proxy-API-Get

Published April 5, 2023 | Last modified June 26, 2025

Examples of getting dns_proxy

Usecase:

Get "example.com" dns_proxy that was created in previous example

Request using vesctl:

vesctl configuration get dns_proxy example --namespace system

vesctl yaml response:

deletedReferredObjects: []
disabledReferredObjects: []
metadata:
  annotations: {}
  labels: {}
  name: example
  namespace: system
referringObjects: []
resourceVersion: "947"
spec:
  cacheProfile: {}
  ddosProfile: {}
  irules: []
  lbAlgorithm: {}
  originServers:
    healthChecks:
      healthCheck:
      - dnsHealthCheck:
          expectedResponse: 1.1.1.1
          queryName: www.exampleserver.com
      healthyThreshold: 2
      interval: 10
      jitterPercent: 20
      timeout: 4
      unhealthyThreshold: 3
    originServers:
    - publicIp:
        ip: 1.1.1.1
    - publicName:
        dnsName: www.server.example.com
  proxyAdvertisement: {}
  transportType: TCP
status: []
systemMetadata:
  creationTimestamp: "2025-06-26T23:55:02.788225Z"
  creatorClass: examplesvc
  creatorId: examplesvc
  finalizers: []
  labels: {}
  tenant: acmecorp
  uid: d621dc43-e833-4838-bb6b-aa9f10438ed5
Copied!

Request using curl:

curl -X 'GET' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build336959812_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/dns_proxys/example?response_format=0'
Copied!

curl response:

HTTP/1.1 200 OK
Content-Type: application/json
Date: Thu, 26 Jun 2025 23:55:02 GMT
Vary: Accept-Encoding

{
  "create_form": null,
  "replace_form": null,
  "resource_version": "947",
  "metadata": {
    "name": "example",
    "namespace": "system",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "d621dc43-e833-4838-bb6b-aa9f10438ed5",
    "creation_timestamp": "2025-06-26T23:55:02.788225Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null,
    "labels": {
    }
  },
  "spec": {
    "transport_type": "TCP",
    "origin_servers": {
      "origin_servers": [
        {
          "public_ip": {
            "ip": "1.1.1.1"
          }
        },
        {
          "public_name": {
            "dns_name": "www.server.example.com",
            "refresh_interval": 0
          }
        }
      ],
      "health_checks": {
        "health_check": [
          {
            "dns_health_check": {
              "reverse": false,
              "query_name": "www.exampleserver.com",
              "query_type": "DNS_QTYPE_A",
              "expected_record_type": "DNS_REQUESTED_QUERY_TYPE",
              "expected_rcode": "DNS_RES_RCODE_NOERROR",
              "expected_response": "1.1.1.1"
            }
          }
        ],
        "timeout": 4,
        "interval": 10,
        "jitter": 0,
        "unhealthy_threshold": 3,
        "healthy_threshold": 2,
        "jitter_percent": 20
      }
    },
    "lb_algorithm": {

    },
    "proxy_advertisement": {

    },
    "ddos_profile": {

    },
    "cache_profile": {

    },
    "protocol_inspection": null,
    "irules": [
    ]
  },
  "status": [
  ],
  "referring_objects": [
  ],
  "deleted_referred_objects": [
  ],
  "disabled_referred_objects": [
  ]
}
Copied!
On this page: