​

ves-io-schema-endpoint-API-Create

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

Examples of creating endpoint

Usecase:

Create productpage endpoint

Request using vesctl:

vesctl configuration create endpoint -i endpoint.yaml

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

RequestJSON:

{
    "metadata": {
        "name": "productpage-endpoint",
        "namespace": "documentation"
    },
    "spec": {
        "where": {
            "virtual_site": {
                "ref": [
                    {
                        "kind": "virtual_site",
                        "tenant": "acmecorp",
                        "namespace": "documentation",
                        "name": "acmecorp-vsite"
                    }
                ]
            }
        },
        "protocol": "TCP",
        "port": 9080,
        "service_info": {
            "discovery_type": "K8S",
            "service_name": "productpage"
        }
    }
}
Copied!

vesctl yaml response:

ResponseJSON:

{
    "metadata": {
        "name": "productpage-endpoint",
        "namespace": "documentation",
        "labels": {},
        "annotations": {},
        "description": "",
        "disable": false
    },
    "system_metadata": {
        "uid": "3973b48e-e511-429b-b036-0d94ca08e9bc",
        "creation_timestamp": "2025-03-11T00:55:51.941015Z",
        "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": {
        "where": {
            "virtual_site": {
                "ref": [
                    {
                        "kind": "virtual_site",
                        "uid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
                        "tenant": "acmecorp",
                        "namespace": "documentation",
                        "name": "acmecorp-vsite"
                    }
                ],
                "network_type": "VIRTUAL_NETWORK_SITE_LOCAL",
                "disable_internet_vip": {},
                "refs": []
            }
        },
        "protocol": "TCP",
        "port": 9080,
        "health_check_port": 0,
        "service_info": {
            "discovery_type": "K8S",
            "service_name": "productpage"
        },
        "snat_pool": null
    }
}
Copied!

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"productpage-endpoint","namespace":"documentation"},"spec":{"where":{"virtual_site":{"ref":[{"kind":"virtual_site","tenant":"acmecorp","namespace":"documentation","name":"acmecorp-vsite"}]}},"protocol":"TCP","port":9080,"service_info":{"discovery_type":"K8S","service_name":"productpage"}}}' -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/endpoints'
Copied!

curl response:

HTTP/1.1 200 OK
Content-Length: 1253
Content-Type: application/json
Date: Tue, 11 Mar 2025 00:55:51 GMT
Vary: Accept-Encoding

{
  "metadata": {
    "name": "productpage-endpoint",
    "namespace": "documentation",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "3973b48e-e511-429b-b036-0d94ca08e9bc",
    "creation_timestamp": "2025-03-11T00:55:51.941015Z",
    "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": {
    "where": {
      "virtual_site": {
        "ref": [
          {
            "kind": "virtual_site",
            "uid": "ffffffff-ffff-ffff-ffff-ffffffffffff",
            "tenant": "acmecorp",
            "namespace": "documentation",
            "name": "acmecorp-vsite"
          }
        ],
        "network_type": "VIRTUAL_NETWORK_SITE_LOCAL",
        "disable_internet_vip": {

        },
        "refs": [
        ]
      }
    },
    "protocol": "TCP",
    "port": 9080,
    "health_check_port": 0,
    "service_info": {
      "discovery_type": "K8S",
      "service_name": "productpage"
    },
    "snat_pool": null
  }
}
Copied!
On this page: