VPN Interface¶

This page describes operations you can perform on vpn_interfaces. List, and get details for.

List Vpn Interface¶

List all visible vpn_interfaces.

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/v2.0/vpn_interfaces

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
description	query	string	-	-	Description of the VPN Interface resource	no
id	query	string	-	-	Unique ID of the VPN Interface resource	no
name	query	string	-	-	Name of the VPN Interface resource	no
status	query	string	-	-	The VPN Interface status.	no
tenant_id	query	string	non-hyph-uuid	-	Tenant ID of the owner (UUID)	no
vpn_gw_id	query	string	hyph-uuid-or-empty	-	VPN Gateway to which this interface is connected	no

Response¶

HTTP Response Code List¶

Response Code	Description
200	OK
400	Bad Request
401	UnAuthorized
404	Not Found
500	Internal Server Error

HTTP Response Parameters¶

Parameter	Type	Format	Description
vpn_interfaces	array<object>	datatype_vpn_interface	-
description	string	-	Description of the VPN Interface resource
id	string	-	Unique ID of the VPN Interface resource
name	string	-	Name of the VPN Interface resource
primary	object	-	Primary router uplink ip configuration
bgp_peer_ip	string	ipv4	Address of the eBGP peer
bgp_router_id	string	ipv4	Router id used in virtual-router config (defaults to ip_address)
ip_address	string	cidr	Address of the uplink interface
secondary	object	-	Secondary router uplink ip configuration
bgp_peer_ip	string	ipv4	Address of the eBGP peer
bgp_router_id	string	ipv4	Router id used in virtual-router config (defaults to ip_address)
ip_address	string	cidr	Address of the uplink interface
status	string	-	The VPN Interface status.
tenant_id	string	non-hyph-uuid	Tenant ID of the owner (UUID)
vpn_gw_id	string	hyph-uuid-or-empty	VPN Gateway to which this interface is connected

Examples¶

Sample Request Body¶

This operation does not send a request body.

Sample Response Body¶

{
  "vpn_interfaces": [
    {
      "description": "lab3-vpn-interface_for_tenant-sdpgui01",
      "id": "278dfbe4-f8cc-4ce4-aa17-561401c01661",
      "name": "vpn_interface_for_tenant-sdpgui01",
      "primary": {
        "bgp_peer_ip": "10.2.121.1",
        "bgp_router_id": "10.2.121.10",
        "ip_address": "10.2.121.10/25"
      },
      "secondary": {
        "bgp_peer_ip": "10.2.121.129",
        "bgp_router_id": "10.2.121.130",
        "ip_address": "10.2.121.130/25"
      },
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "vpn_gw_id": "b6d96194-f74a-4beb-97cd-727f02b0e070"
    },
    {
      "description": "lab3-vpn-interface-for-esi_tenant",
      "id": "82098893-b394-4d52-9d24-3df57e63d750",
      "name": "lab3-test-user-vpn-interface",
      "primary": {
        "bgp_peer_ip": "10.2.121.1",
        "bgp_router_id": "10.2.121.10",
        "ip_address": "10.2.121.10/25"
      },
      "secondary": {
        "bgp_peer_ip": "10.2.121.129",
        "bgp_router_id": "10.2.121.130",
        "ip_address": "10.2.121.130/25"
      },
      "status": "ACTIVE",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "vpn_gw_id": "07f97269-e616-4dff-a73f-ca80bc5682dc"
    }
  ]
}

Show Vpn Interface¶

Show details for vpn_interface.