ves-io-schema-tunnel-API-Create
Examples of creating tunnel
Usecase:
Create tunnel-1
Request using vesctl:
vesctl configuration create tunnel -i tunnel.yaml
where file tunnel.yaml has following contents (tunnel.CreateRequest):
RequestJSON:
{ "metadata": { "name": "tunnel-1", "namespace": "system" }, "spec": { "local_ip": { "intf": { "local_intf": [ { "tenant": "acmecorp", "namespace": "system", "name": "network-interface-1" } ] } }, "remote_ip": { "endpoints": { "endpoints": { "master-0/node-1": { "ip": { "ipv4": { "addr": "1.1.1.1" } } }, "node-2": { "ip": { "ipv4": { "addr": "1.1.1.2" } } } } } }, "params": { "ipsec": { "ipsec_psk": { "clear_secret_info": { "url": "string://\u003cbase64\u003e" } } } } }}vesctl yaml response:
ResponseJSON:
{ "metadata": { "name": "tunnel-1", "namespace": "system", "labels": {}, "annotations": {}, "description": "", "disable": false }, "system_metadata": { "uid": "ce413270-39aa-4d7f-a395-c471b17623c7", "creation_timestamp": "2026-06-19T22:09:23.852912Z", "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": { "tunnel_type": "IPSEC_PSK", "local_ip": { "intf": { "local_intf": [ { "kind": "network_interface.Object", "uid": "ffffffff-ffff-ffff-ffff-ffffffffffff", "tenant": "acmecorp", "namespace": "system", "name": "network-interface-1" } ] } }, "remote_ip": { "endpoints": { "endpoints": { "master-0/node-1": { "ip": { "ipv4": { "addr": "1.1.1.1" } } }, "node-2": { "ip": { "ipv4": { "addr": "1.1.1.2" } } } } } }, "params": { "ipsec": { "ipsec_psk": { "clear_secret_info": { "provider": "", "url": "string://\u003cbase64\u003e" }, "blindfold_secret_info_internal": null, "secret_encoding_type": "EncodingNone" }, "tunnel_initiator": null, "ike_proposal": null, "esp_proposal": null, "local_ike_id": "", "remote_ike_id": "", "ike_phase1_key_lifetime": 0, "ike_reauth_timeout": 0, "ike_phase2_key_lifetime": 0, "dpd_keep_alive_timer": 0, "ike_phase1_profile": [], "ike_phase2_profile": [] } } }}Request using curl:
curl -X 'POST' -d '{"metadata":{"name":"tunnel-1","namespace":"system"},"spec":{"local_ip":{"intf":{"local_intf":[{"tenant":"acmecorp","namespace":"system","name":"network-interface-1"}]}},"remote_ip":{"endpoints":{"endpoints":{"master-0/node-1":{"ip":{"ipv4":{"addr":"1.1.1.1"}}},"node-2":{"ip":{"ipv4":{"addr":"1.1.1.2"}}}}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build1655461974_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'curl response:
HTTP/1.1 200 OKContent-Type: application/jsonDate: Fri, 19 Jun 2026 22:09:23 GMTVary: Accept-Encoding
{ "metadata": { "name": "tunnel-1", "namespace": "system", "labels": { }, "annotations": { }, "description": "", "disable": false }, "system_metadata": { "uid": "ce413270-39aa-4d7f-a395-c471b17623c7", "creation_timestamp": "2026-06-19T22:09:23.852912Z", "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": { "tunnel_type": "IPSEC_PSK", "local_ip": { "intf": { "local_intf": [ { "kind": "network_interface.Object", "uid": "ffffffff-ffff-ffff-ffff-ffffffffffff", "tenant": "acmecorp", "namespace": "system", "name": "network-interface-1" } ] } }, "remote_ip": { "endpoints": { "endpoints": { "master-0/node-1": { "ip": { "ipv4": { "addr": "1.1.1.1" } } }, "node-2": { "ip": { "ipv4": { "addr": "1.1.1.2" } } } } } }, "params": { "ipsec": { "ipsec_psk": { "clear_secret_info": { "provider": "", "url": "string://\u003cbase64\u003e" }, "blindfold_secret_info_internal": null, "secret_encoding_type": "EncodingNone" }, "tunnel_initiator": null, "ike_proposal": null, "esp_proposal": null, "local_ike_id": "", "remote_ike_id": "", "ike_phase1_key_lifetime": 0, "ike_reauth_timeout": 0, "ike_phase2_key_lifetime": 0, "dpd_keep_alive_timer": 0, "ike_phase1_profile": [ ], "ike_phase2_profile": [ ] } } }}Usecase:
Create tunnel-2
Request using vesctl:
vesctl configuration create tunnel -i tunnel.yaml
where file tunnel.yaml has following contents (tunnel.CreateRequest):
RequestJSON:
{ "metadata": { "name": "tunnel-2", "namespace": "system" }, "spec": { "local_ip": { "ip_address": { "ip_address": { "ipv4": { "addr": "192.168.0.10" } }, "virtual_network_type": { "site_local": {} } } }, "remote_ip": { "ip": { "ipv4": { "addr": "192.168.0.10" } } }, "params": { "ipsec": { "ipsec_psk": { "clear_secret_info": { "url": "string://\u003cbase64\u003e" } } } } }}vesctl yaml response:
ResponseJSON:
{ "metadata": { "name": "tunnel-2", "namespace": "system", "labels": {}, "annotations": {}, "description": "", "disable": false }, "system_metadata": { "uid": "2ce21866-1a77-48c3-b76e-e4acb40042d4", "creation_timestamp": "2026-06-19T22:09:23.880039Z", "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": { "tunnel_type": "IPSEC_PSK", "local_ip": { "ip_address": { "ip_address": { "ipv4": { "addr": "192.168.0.10" } }, "virtual_network_type": { "site_local": {} } } }, "remote_ip": { "ip": { "ipv4": { "addr": "192.168.0.10" } } }, "params": { "ipsec": { "ipsec_psk": { "clear_secret_info": { "provider": "", "url": "string://\u003cbase64\u003e" }, "blindfold_secret_info_internal": null, "secret_encoding_type": "EncodingNone" }, "tunnel_initiator": null, "ike_proposal": null, "esp_proposal": null, "local_ike_id": "", "remote_ike_id": "", "ike_phase1_key_lifetime": 0, "ike_reauth_timeout": 0, "ike_phase2_key_lifetime": 0, "dpd_keep_alive_timer": 0, "ike_phase1_profile": [], "ike_phase2_profile": [] } } }}Request using curl:
curl -X 'POST' -d '{"metadata":{"name":"tunnel-2","namespace":"system"},"spec":{"local_ip":{"ip_address":{"ip_address":{"ipv4":{"addr":"192.168.0.10"}},"virtual_network_type":{"site_local":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build1655461974_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'curl response:
HTTP/1.1 200 OKContent-Type: application/jsonDate: Fri, 19 Jun 2026 22:09:23 GMTVary: Accept-Encoding
{ "metadata": { "name": "tunnel-2", "namespace": "system", "labels": { }, "annotations": { }, "description": "", "disable": false }, "system_metadata": { "uid": "2ce21866-1a77-48c3-b76e-e4acb40042d4", "creation_timestamp": "2026-06-19T22:09:23.880039Z", "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": { "tunnel_type": "IPSEC_PSK", "local_ip": { "ip_address": { "ip_address": { "ipv4": { "addr": "192.168.0.10" } }, "virtual_network_type": { "site_local": {
} } } }, "remote_ip": { "ip": { "ipv4": { "addr": "192.168.0.10" } } }, "params": { "ipsec": { "ipsec_psk": { "clear_secret_info": { "provider": "", "url": "string://\u003cbase64\u003e" }, "blindfold_secret_info_internal": null, "secret_encoding_type": "EncodingNone" }, "tunnel_initiator": null, "ike_proposal": null, "esp_proposal": null, "local_ike_id": "", "remote_ike_id": "", "ike_phase1_key_lifetime": 0, "ike_reauth_timeout": 0, "ike_phase2_key_lifetime": 0, "dpd_keep_alive_timer": 0, "ike_phase1_profile": [ ], "ike_phase2_profile": [ ] } } }}Usecase:
Create tunnel-3
Request using vesctl:
vesctl configuration create tunnel -i tunnel.yaml
where file tunnel.yaml has following contents (tunnel.CreateRequest):
RequestJSON:
{ "metadata": { "name": "tunnel-3", "namespace": "system" }, "spec": { "local_ip": { "ip_address": { "ip_address": { "ipv4": { "addr": "192.168.0.10" } }, "virtual_network_type": { "site_local_inside": {} } } }, "remote_ip": { "ip": { "ipv4": { "addr": "192.168.0.10" } } }, "params": { "ipsec": { "ipsec_psk": { "clear_secret_info": { "url": "string://\u003cbase64\u003e" } } } } }}vesctl yaml response:
ResponseJSON:
{ "metadata": { "name": "tunnel-3", "namespace": "system", "labels": {}, "annotations": {}, "description": "", "disable": false }, "system_metadata": { "uid": "135a3925-6baa-4dcf-8556-96d303762c1b", "creation_timestamp": "2026-06-19T22:09:23.890442Z", "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": { "tunnel_type": "IPSEC_PSK", "local_ip": { "ip_address": { "ip_address": { "ipv4": { "addr": "192.168.0.10" } }, "virtual_network_type": { "site_local_inside": {} } } }, "remote_ip": { "ip": { "ipv4": { "addr": "192.168.0.10" } } }, "params": { "ipsec": { "ipsec_psk": { "clear_secret_info": { "provider": "", "url": "string://\u003cbase64\u003e" }, "blindfold_secret_info_internal": null, "secret_encoding_type": "EncodingNone" }, "tunnel_initiator": null, "ike_proposal": null, "esp_proposal": null, "local_ike_id": "", "remote_ike_id": "", "ike_phase1_key_lifetime": 0, "ike_reauth_timeout": 0, "ike_phase2_key_lifetime": 0, "dpd_keep_alive_timer": 0, "ike_phase1_profile": [], "ike_phase2_profile": [] } } }}Request using curl:
curl -X 'POST' -d '{"metadata":{"name":"tunnel-3","namespace":"system"},"spec":{"local_ip":{"ip_address":{"ip_address":{"ipv4":{"addr":"192.168.0.10"}},"virtual_network_type":{"site_local_inside":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build1655461974_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'curl response:
HTTP/1.1 200 OKContent-Type: application/jsonDate: Fri, 19 Jun 2026 22:09:23 GMTVary: Accept-Encoding
{ "metadata": { "name": "tunnel-3", "namespace": "system", "labels": { }, "annotations": { }, "description": "", "disable": false }, "system_metadata": { "uid": "135a3925-6baa-4dcf-8556-96d303762c1b", "creation_timestamp": "2026-06-19T22:09:23.890442Z", "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": { "tunnel_type": "IPSEC_PSK", "local_ip": { "ip_address": { "ip_address": { "ipv4": { "addr": "192.168.0.10" } }, "virtual_network_type": { "site_local_inside": {
} } } }, "remote_ip": { "ip": { "ipv4": { "addr": "192.168.0.10" } } }, "params": { "ipsec": { "ipsec_psk": { "clear_secret_info": { "provider": "", "url": "string://\u003cbase64\u003e" }, "blindfold_secret_info_internal": null, "secret_encoding_type": "EncodingNone" }, "tunnel_initiator": null, "ike_proposal": null, "esp_proposal": null, "local_ike_id": "", "remote_ike_id": "", "ike_phase1_key_lifetime": 0, "ike_reauth_timeout": 0, "ike_phase2_key_lifetime": 0, "dpd_keep_alive_timer": 0, "ike_phase1_profile": [ ], "ike_phase2_profile": [ ] } } }}Usecase:
Create tunnel-4
Request using vesctl:
vesctl configuration create tunnel -i tunnel.yaml
where file tunnel.yaml has following contents (tunnel.CreateRequest):
RequestJSON:
{ "metadata": { "name": "tunnel-4", "namespace": "system" }, "spec": { "local_ip": { "ip_address": { "ip_address": { "ipv4": { "addr": "192.168.0.10" } }, "virtual_network_type": { "public": {} } } }, "remote_ip": { "ip": { "ipv4": { "addr": "192.168.0.10" } } }, "params": { "ipsec": { "ipsec_psk": { "clear_secret_info": { "url": "string://\u003cbase64\u003e" } } } } }}vesctl yaml response:
ResponseJSON:
{ "metadata": { "name": "tunnel-4", "namespace": "system", "labels": {}, "annotations": {}, "description": "", "disable": false }, "system_metadata": { "uid": "12ddc99d-cb06-4d43-a9f4-3e4907574b12", "creation_timestamp": "2026-06-19T22:09:23.907099Z", "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": { "tunnel_type": "IPSEC_PSK", "local_ip": { "ip_address": { "ip_address": { "ipv4": { "addr": "192.168.0.10" } }, "virtual_network_type": { "public": {} } } }, "remote_ip": { "ip": { "ipv4": { "addr": "192.168.0.10" } } }, "params": { "ipsec": { "ipsec_psk": { "clear_secret_info": { "provider": "", "url": "string://\u003cbase64\u003e" }, "blindfold_secret_info_internal": null, "secret_encoding_type": "EncodingNone" }, "tunnel_initiator": null, "ike_proposal": null, "esp_proposal": null, "local_ike_id": "", "remote_ike_id": "", "ike_phase1_key_lifetime": 0, "ike_reauth_timeout": 0, "ike_phase2_key_lifetime": 0, "dpd_keep_alive_timer": 0, "ike_phase1_profile": [], "ike_phase2_profile": [] } } }}Request using curl:
curl -X 'POST' -d '{"metadata":{"name":"tunnel-4","namespace":"system"},"spec":{"local_ip":{"ip_address":{"ip_address":{"ipv4":{"addr":"192.168.0.10"}},"virtual_network_type":{"public":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build1655461974_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'curl response:
HTTP/1.1 200 OKContent-Type: application/jsonDate: Fri, 19 Jun 2026 22:09:23 GMTVary: Accept-Encoding
{ "metadata": { "name": "tunnel-4", "namespace": "system", "labels": { }, "annotations": { }, "description": "", "disable": false }, "system_metadata": { "uid": "12ddc99d-cb06-4d43-a9f4-3e4907574b12", "creation_timestamp": "2026-06-19T22:09:23.907099Z", "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": { "tunnel_type": "IPSEC_PSK", "local_ip": { "ip_address": { "ip_address": { "ipv4": { "addr": "192.168.0.10" } }, "virtual_network_type": { "public": {
} } } }, "remote_ip": { "ip": { "ipv4": { "addr": "192.168.0.10" } } }, "params": { "ipsec": { "ipsec_psk": { "clear_secret_info": { "provider": "", "url": "string://\u003cbase64\u003e" }, "blindfold_secret_info_internal": null, "secret_encoding_type": "EncodingNone" }, "tunnel_initiator": null, "ike_proposal": null, "esp_proposal": null, "local_ike_id": "", "remote_ike_id": "", "ike_phase1_key_lifetime": 0, "ike_reauth_timeout": 0, "ike_phase2_key_lifetime": 0, "dpd_keep_alive_timer": 0, "ike_phase1_profile": [ ], "ike_phase2_profile": [ ] } } }}Usecase:
Create tunnel-5
Request using vesctl:
vesctl configuration create tunnel -i tunnel.yaml
where file tunnel.yaml has following contents (tunnel.CreateRequest):
RequestJSON:
{ "metadata": { "name": "tunnel-5", "namespace": "system" }, "spec": { "local_ip": { "ip_address": { "auto": {}, "virtual_network_type": { "site_local": {} } } }, "remote_ip": { "ip": { "ipv4": { "addr": "192.168.0.10" } } }, "params": { "ipsec": { "ipsec_psk": { "clear_secret_info": { "url": "string://\u003cbase64\u003e" } } } } }}vesctl yaml response:
ResponseJSON:
{ "metadata": { "name": "tunnel-5", "namespace": "system", "labels": {}, "annotations": {}, "description": "", "disable": false }, "system_metadata": { "uid": "3814835d-e31c-45ff-8746-26de49b7a4c7", "creation_timestamp": "2026-06-19T22:09:23.918787Z", "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": { "tunnel_type": "IPSEC_PSK", "local_ip": { "ip_address": { "auto": {}, "virtual_network_type": { "site_local": {} } } }, "remote_ip": { "ip": { "ipv4": { "addr": "192.168.0.10" } } }, "params": { "ipsec": { "ipsec_psk": { "clear_secret_info": { "provider": "", "url": "string://\u003cbase64\u003e" }, "blindfold_secret_info_internal": null, "secret_encoding_type": "EncodingNone" }, "tunnel_initiator": null, "ike_proposal": null, "esp_proposal": null, "local_ike_id": "", "remote_ike_id": "", "ike_phase1_key_lifetime": 0, "ike_reauth_timeout": 0, "ike_phase2_key_lifetime": 0, "dpd_keep_alive_timer": 0, "ike_phase1_profile": [], "ike_phase2_profile": [] } } }}Request using curl:
curl -X 'POST' -d '{"metadata":{"name":"tunnel-5","namespace":"system"},"spec":{"local_ip":{"ip_address":{"auto":{},"virtual_network_type":{"site_local":{}}}},"remote_ip":{"ip":{"ipv4":{"addr":"192.168.0.10"}}},"params":{"ipsec":{"ipsec_psk":{"clear_secret_info":{"url":"string://\u003cbase64\u003e"}}}}}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build1655461974_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/system/tunnels'curl response:
HTTP/1.1 200 OKContent-Type: application/jsonDate: Fri, 19 Jun 2026 22:09:23 GMTVary: Accept-Encoding
{ "metadata": { "name": "tunnel-5", "namespace": "system", "labels": { }, "annotations": { }, "description": "", "disable": false }, "system_metadata": { "uid": "3814835d-e31c-45ff-8746-26de49b7a4c7", "creation_timestamp": "2026-06-19T22:09:23.918787Z", "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": { "tunnel_type": "IPSEC_PSK", "local_ip": { "ip_address": { "auto": {
}, "virtual_network_type": { "site_local": {
} } } }, "remote_ip": { "ip": { "ipv4": { "addr": "192.168.0.10" } } }, "params": { "ipsec": { "ipsec_psk": { "clear_secret_info": { "provider": "", "url": "string://\u003cbase64\u003e" }, "blindfold_secret_info_internal": null, "secret_encoding_type": "EncodingNone" }, "tunnel_initiator": null, "ike_proposal": null, "esp_proposal": null, "local_ike_id": "", "remote_ike_id": "", "ike_phase1_key_lifetime": 0, "ike_reauth_timeout": 0, "ike_phase2_key_lifetime": 0, "dpd_keep_alive_timer": 0, "ike_phase1_profile": [ ], "ike_phase2_profile": [ ] } } }}