​

ves-io-schema-views-proxy-API-Create

Published April 5, 2023 | Last modified March 20, 2025

Examples of creating proxy

Usecase:

Create "http-connect" Proxy

Request using vesctl:

vesctl configuration create proxy -i proxy.yaml

where file proxy.yaml has following contents (proxy.CreateRequest):

RequestJSON:

{
    "metadata": {
        "name": "http-connect",
        "namespace": "documentation"
    },
    "spec": {
        "http_proxy": {
            "enable_http": {}
        },
        "site_virtual_sites": {
            "advertise_where": [
                {
                    "site": {
                        "site": {
                            "namespace": "documentation",
                            "name": "acmecorp-site"
                        }
                    },
                    "use_default_port": {}
                }
            ]
        },
        "site_local_network": {},
        "no_forward_proxy_policy": {},
        "no_interception": {}
    }
}
Copied!

vesctl yaml response:

ResponseJSON:

{
    "metadata": {
        "name": "http-connect",
        "namespace": "documentation",
        "labels": {},
        "annotations": {},
        "description": "",
        "disable": false
    },
    "system_metadata": {
        "uid": "fdcc9a9d-0130-4ea3-95dc-ba82e0ca1fd2",
        "creation_timestamp": "2025-03-11T00:57:47.705552Z",
        "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": {
        "http_proxy": {
            "enable_http": {},
            "more_option": null
        },
        "site_virtual_sites": {
            "advertise_where": [
                {
                    "site": {
                        "network": "SITE_NETWORK_INSIDE_AND_OUTSIDE",
                        "site": {
                            "tenant": "acmecorp",
                            "namespace": "documentation",
                            "name": "acmecorp-site"
                        },
                        "ip": "",
                        "ipv6": ""
                    },
                    "use_default_port": {}
                }
            ]
        },
        "site_local_network": {},
        "no_forward_proxy_policy": {},
        "no_interception": {},
        "connection_timeout": 0
    }
}
Copied!

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"http-connect","namespace":"documentation"},"spec":{"http_proxy":{"enable_http":{}},"site_virtual_sites":{"advertise_where":[{"site":{"site":{"namespace":"documentation","name":"acmecorp-site"}},"use_default_port":{}}]},"site_local_network":{},"no_forward_proxy_policy":{},"no_interception":{}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build436303540_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/documentation/proxys'
Copied!

curl response:

HTTP/1.1 200 OK
Content-Length: 1266
Content-Type: application/json
Date: Tue, 11 Mar 2025 00:57:47 GMT
Vary: Accept-Encoding

{
  "metadata": {
    "name": "http-connect",
    "namespace": "documentation",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "fdcc9a9d-0130-4ea3-95dc-ba82e0ca1fd2",
    "creation_timestamp": "2025-03-11T00:57:47.705552Z",
    "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": {
    "http_proxy": {
      "enable_http": {

      },
      "more_option": null
    },
    "site_virtual_sites": {
      "advertise_where": [
        {
          "site": {
            "network": "SITE_NETWORK_INSIDE_AND_OUTSIDE",
            "site": {
              "tenant": "acmecorp",
              "namespace": "documentation",
              "name": "acmecorp-site"
            },
            "ip": "",
            "ipv6": ""
          },
          "use_default_port": {

          }
        }
      ]
    },
    "site_local_network": {

    },
    "no_forward_proxy_policy": {

    },
    "no_interception": {

    },
    "connection_timeout": 0
  }
}
Copied!
On this page: