Skip to main content
Index

VPN

Get VPN Configurations

GET /ne/v1/vpn

 Method  GET
 URL or End Point  /ne/v1/vpn
 Headers  Authorization, Content-Type
 Query Parameters  statusList [], virtualDeviceUuid, offset, limit
 Body  Not applicable

 

This API returns all VPNs. 

 

To obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

A sample curl request to get VPNs. 

 

curl -X

GET "https://api.equinix.com/ne/v1/vpn"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

Description of the query parameters:

 

Query Parameter Name Mandatory Type Example Applicable Values Description
statusList No array[string] PROVISIONED

"PROVISIONED"

"PROVISIONING"

"FAILED"

"DEPROVISIONED"

"DEPROVISIONING"

A list of VPN status.
virtualDeviceUuid No string 116b4f6a-bb12-45dc-b573-05dba39c6cb1   Unique Id of a virtual device.
offset No integer 0   Specifies where to start a page. It is the starting point of the collection returned from the server. 
limit No integer 100   Specifies the page size. 

 

Sample response:

 

{
    "pagination": {
        "offset": 0,
        "limit": 20,
       "total": 9
     },

    "data": [
        {
            "configName": "rr1-apr22-nonha-vpn1",
            "peerIp": "10.10.10.2",
            "peerSharedKey": "cnIxLWFwcjIyLW5vbmhhLXZwbjE=",
            "remoteAsn": 234568,
            "remoteIpAddress": "10.10.10.30",
            "password": "welcome1",
            "localAsn": 234565,
            "tunnelIp": "212.14.101.1/24",
            "virtualDeviceUuid": "7815a65d-214d-412b-9c50-17237426177a",
            "siteName": "NoNHAvpn",
            "uuid": "b884d9c0-8771-49b2-800b-34701246aba1",
            "status": "DEPROVISIONED",
            "bgpState": "Idle",
            "tunnelStatus": "DOWN",

            "useNetworkServiceConnection": false,
            "createdDate": "2019-04-23T02:48:45.097Z",
            "createdByFullName": "nfv-sit4 nfv-sit4",
            "createdByEmail": "test@equinix.com",
            "createdBy": "nfv-sit4",
            "lastUpdatedDate": "2019-04-24T01:50:23.376Z",
            "lastUpdatedByFullName": "nfv-sit4 nfv-sit4",
            "lastUpdatedByEmail": "test@equinix.com",
            "lastUpdatedBy": "nfv-sit4"
        }
]
}

 

The description of the response payload is as follows:

 

Field Type Example Values Description
pagination object   An object that has pagination information.
offset integer 0 It is the starting point of the collection returned from the server. 
limit integer 20 The page size. 
total integer 100 The total number of results. 
next string   The next set of records.
previous string   The previous set of records.
data array data[] An array containing VPN objects.
configName string test2 Description of the VPN. This is between 3 and 50 characters.
peerIp string 1.1.1.1 IP Address of the remote site to which you connect (this is on the customer side). 
peerSharedKey string 213 Pre-shared key for VPN
remoteAsn string 21345 Remote ASN (autonomous system number). 
remoteIpAddress string 1.1.1.1 Remote IP address to establish BGP peering (this is on the customer side)
password string abc123 Password for BGP peering.
localAsn string 12345 Local ASN (autonomous system number) of Equinix site. 
tunnelIp string 2.2.2.2/25 Local tunnel IP in CIDR format
virtualDeviceUuid string 7d12f7c6-c9ee-4a14-9b00-5873eadf7708 Unique Id of the virtual device.
siteName string testVPN Your remote siteName. 
uuid string d93fad3f-dbe6-440d-ba94-8312e831d57a Unique Id of the VPN
status string PROVISIONED VPN status. One of Provisioning, Provisioned, Failed, Deprovisioning, or Deprovisioned.
bgpState string Idle BGP state. One of Idle, Connect, Active, Established, OpenSent, or OpenConfirm.
tunnelStatus string DOWN Tunnel status. Either Up or Down.
useNetworkServiceConnection boolean false Whether this VPN tunnel uses a network service connection.
createdDate string 2019-04-24T01:50:23.376Z Creation date.
createdByFullName string nfv-sit4 nfv-sit4 Created by (full name).
createdByEmail string test@equinix.com Created by (email).
createdBy string nfv-sit4 Created by (username).
lastUpdatedDate string 2019-04-24T01:50:23.376Z Last update date.
lastUpdatedByFullName string nfv-sit4 nfv-sit4 Last updated by (full name).
lastUpdatedByEmail string test@equinix.com Last updated by (email).
lastUpdatedBy string nfv-sit4 Last updated by (username).

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Network Edge Portal access.

Get VPN Configuration {uuid}

GET /ne/v1/vpn/{uuid}

 Method  GET
 URL or End Point  /ne/v1/vpn/{uuid}
 Headers  Authorization, Content-Type
 Path Parameter  uuid
 Body  Not applicable

 

This API returns the details of a VPN configuration. 

 

To obtain an authorization token, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

Sample curl request to get a VPN configuration. 

 

curl -X

GET "https://api.equinix.com/ne/v1/vpn/920a6218-7e77-4105-ae95-cf3ea2993696"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

Description of the query parameters:

 

Path Parameter Name Mandatory Type Example Applicable Values Description
uuid Yes string 920a6218-7e77-4105-ae95-cf3ea2993696

 

Unique Id of a VPN configuration.

 

Sample response:

 


        {
            "configName": "rr1-apr22-nonha-vpn1",
            "peerIp": "10.10.10.2",
            "peerSharedKey": "cnIxLWFwcjIyLW5vbmhhLXZwbjE=",
            "remoteAsn": 234568,
            "remoteIpAddress": "10.10.10.30",
            "password": "welcome1",
            "localAsn": 234565,
            "tunnelIp": "212.14.101.1/24",
            "virtualDeviceUuid": "7815a65d-214d-412b-9c50-17237426177a",
            "siteName": "NoNHAvpn",
            "uuid": "b884d9c0-8771-49b2-800b-34701246aba1",
            "status": "DEPROVISIONED",
            "bgpState": "Idle",
            "tunnelStatus": "DOWN",

            "useNetworkServiceConnection": false,
            "createdDate": "2019-04-23T02:48:45.097Z",
            "createdByFullName": "nfv-sit4 nfv-sit4",
            "createdByEmail": "test@equinix.com",
            "createdBy": "nfv-sit4",
            "lastUpdatedDate": "2019-04-24T01:50:23.376Z",
            "lastUpdatedByFullName": "nfv-sit4 nfv-sit4",
            "lastUpdatedByEmail": "test@equinix.com",
            "lastUpdatedBy": "nfv-sit4"
        }
 

 

The description of the response payload is as follows:

 

Field Type Example Values Description
configName string test2 Description of the VPN. This is between 3 and 50 characters.
peerIp string 1.1.1.1 IP Address of the remote site to which you connect (this is on the customer side). 
peerSharedKey string 213 Pre-shared key for VPN
remoteAsn string 21345 Remote ASN (autonomous system number). 
remoteIpAddress string 1.1.1.1 Remote IP address to establish BGP peering (this is on the customer side)
password string abc123 Password for BGP peering.
localAsn string 12345 Local ASN (autonomous system number) of Equinix site. 
tunnelIp string 2.2.2.2/25 Local tunnel IP in CIDR format
virtualDeviceUuid string 7d12f7c6-c9ee-4a14-9b00-5873eadf7708 Unique Id of the virtual device.
siteName string testVPN Your remote siteName. 
uuid string d93fad3f-dbe6-440d-ba94-8312e831d57a Unique Id of the VPN
status string PROVISIONED VPN status. One of Provisioning, Provisioned, Failed, Deprovisioning, or Deprovisioned.
bgpState string Idle BGP state. One of Idle, Connect, Active, Established, OpenSent, or OpenConfirm.
tunnelStatus string DOWN Tunnel status. Either Up or Down.
useNetworkServiceConnection boolean false Whether this VPN uses a network service connection.
createdDate string   2019-04-23T02:48:45.097Z
createdByFullName string nfv-sit4 nfv-sit4 Created by (full name).
createdByEmail string test@equinix.com Created by (email).
createdBy string nfv-sit4 Created by (username).
lastUpdatedDate string 2019-04-24T01:50:23.376Z Last update date.
lastUpdatedByFullName string nfv-sit4 nfv-sit4 Last updated by (full name).
lastUpdatedByEmail string test@equinix.com Last updated by (email).
lastUpdatedBy string nfv-sit4 Last updated by (username).

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Equinix Network Edge Portal access.

Delete VPN Configuration

DELETE /ne/v1/vpn/{uuid}

 Method  DELETE
 URL or End Point  /ne/v1/vpn/{uuid}
 Headers  Authorization, Content-Type
 Query Parameter  NA
 Path Parameter  Unique Id of a VPN configuration
 Body   NA

 

Deletes a VPN configuration by its unique Id. 

 

To obtain an authorization key, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

The following screenshot shows a sample curl request. 

 

curl -X

DELETE "https://api.equinix.com/ne/v1/vpn/5f888d91-d2c5-45bb-9b51-fed99f57f0ac"

-H "content-type: application/json"

-H "authorization: Bearer qwErtY8zyW1abcdefGHI"

 

Path Parameter Name Mandatory Type Example Applicable Values Description
uuid Yes string 5f888d91-d2c5-45bb-9b51-fed99f57f0ac   Unique Id of a VPN configuration.

 

Sample response: 

 

202: Deletion request accepted.

 

The description of the response is as follows:

 

HTTP status Description
202 Deletion request accepted.

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Portal access.

Update VPN Configuration

PUT /ne/v1/vpn{uuid} 

 Method  PUT
 URL or End Point  /ne/v1/vpn/{uuid}
 Headers  Authorization, Content-Type
 Query Parameters  Not applicable
 Path Parameter  uuid
 Body Parameters

 configName, peerIp, peerSharedKey, 

remoteAsn, remoteIpAddress, password, localAsn, tunnelIp, useNetworkServiceConnection, secondary   {configName, peerIp, peerSharedKey, remoteAsn, remoteIpAddress,

 password, localAsn, tunnelIp}

 

To obtain an authorization key, refer to Requesting Access and Refresh tokens under the Getting Started section.

 

Sample curl request. 

 

curl -X

PUT "https://api.equinix.com/ne/v1/vpn/ae03260c-e5db-4ff0-8b16-d50a81d0eef5"

-H "Authorization: Bearer 4P8uH5ZWsgH4qlovBrFZG4Hzpp2V"
-H "Content-Type: application/json"
-d '{
  "configName": "Traffic from AWS cloud",
  "peerIp": "110.11.12.222",
  "peerSharedKey": "5bb2424e888bd",
  "remoteAsn": 65413,
  "remoteIpAddress": "100.210.1.31",
  "password": "pass123SROY",
  "localAsn": 65414,
  "tunnelIp": "192.168.7.2/30",

  "useNetworkServiceConnection": false
}'

 

Sample curl request for a redundant device. 

 

curl -X

PUT "https://api.equinix.com/ne/v1/vpn/ae03260c-e5db-4ff0-8b16-d50a81d0eef5"

-H "Authorization: Bearer 4P8uH5ZWsgH4qlovBrFZG4Hzpp2V"
-H "Content-Type: application/json"
-d '{
  "configName": "Traffic from AWS cloud",
  "peerIp": "110.11.12.222",
  "peerSharedKey": "5bb2424e888bd",
  "remoteAsn": 65413,
  "remoteIpAddress": "100.210.1.31",
  "password": "pass123SROY",
  "localAsn": 65414,
  "tunnelIp": "192.168.7.2/30",

  "useNetworkServiceConnection": false,
  "secondary": {
    "configName": "Traffic from AWS cloud-SROY",
    "peerIp": "110.11.12.222",
    "peerSharedKey": "5bb2424e888bd",
    "remoteAsn": 65413,
    "remoteIpAddress": "100.210.1.31",
    "password": "pass123SROY",
    "localAsn": 65414,
    "tunnelIp": "192.168.7.2/30"
  }
}'

 

Path parameter:

Path Parameter Name Mandatory Type Example Applicable Values Description
uuid Yes string 9a47a75e-164b-4c1c-8678-7b3605d4dd32

 

The unique Id of a VPN configuration.
 

 

 

Description of request body parameters:

 

Body Parameter Name Mandatory Type Example Applicable Values Description
configName Yes string Traffic from AWS cloud   Description of the VPN. This must be between 3 and 50 characters. If you have a redundant device, you must provide a secondary config name.
peerIp Yes string 100.210.1.221  

IP Address of the remote site to which you are connecting (this is on the customer side). You must provide a unique peer IP address for every VPN between a virtual device and the remote site. 

peerSharedKey Yes string 10013   Pre-shared key for VPN.
remoteAsn Yes string 10023   Remote ASN (autonomous system number). Remote ASN and local ASN cannot be the same. You cannot use the following reserved ASN numbers: 0, 23456, 64496-64511, 65535, 65552-131071, 4294967295. 
remoteIpAddress Yes string 100.210.1.31   Remote IP address to establish BGP peering (this is on the customer side).
password No string pass123SROY   Password for BGP peering. This must not start with a number, must be between 4 and 25 characters long, and contain only alphanumeric characters.
localAsn Yes integer 65414   Local ASN (autonomous system number) of Equinix site. Remote and local ASN cannot be the same. You cannot use the following reserved ASN numbers: 0, 23456, 64496-64511, 65535, 65552-131071, 4294967295. 
tunnelIp Yes string 192.168.7.2/30   Local tunnel IP in CIDR format.
useNetworkServiceConnection Yes boolean false   Whether this VPN should use the existing network service connection. You should set this value to True only if you have an existing network service connection on your device.

 

Sample response.

202 Accepted

 

Description of the response payload:

 

HTTP Status Description
202 Accepted Your request has been accepted.

 

You can check the status of your VPN by calling Get VPN.

 

Possible VPN status Description
PROVISIONING VPN is provisioning.
PROVISIONED VPN is provisioned.
FAILED VPN provisioning failed.
DEPROVISIONING VPN is de-provisioning.
DEPROVISIONED VPN is de-provisioned

 

VPN tunnel status is either UP or DOWN.

 

 

If you get “Access Denied” error, contact your local Equinix Service Desk for Portal access.