1. REST API for Oracle Cloud Infrastructure Compute Classic
  2. Tasks
  3. VPNEndpointV2s

Retrieve Details of a VPN Endpoint V2

get

/vpnendpoint/v2/{name}

This endpoint is not available on Oracle Cloud Machine.

Retrieve Details of the specified VPN connection. You can retrieve details of a VPN connection to track the status of the tunnel. The tunnel can be in one of the following states:

* PENDING: indicates that your VPN connection is being set up.

* UP: indicates that your VPN connection is established.

* DOWN: indicates that your VPN connection is down.

* ERROR: indicates that your VPN connection is in the error state.

Required Role: To complete this task, you must have the Compute_Operations role. If this role isn't assigned to you or you're not sure, then ask your system administrator to ensure that the role is assigned to you in Oracle Cloud My Services. See Modifying User Roles in Managing and Monitoring Oracle Cloud.

Request

Supported Media Types
Path Parameters
  • The three-part name of the object (/Compute-identity_domain/user/object).
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

OK. See Status Codes for information about other possible HTTP status codes.
Headers
Body ()
Root Schema : VPNConnection-response
Type: object
Show Source
Nested Schema : phase1Settings
Type: object
Additional Properties Allowed
Show Source
Settings for Phase 1 of protocol (IKE).
Nested Schema : phase2Settings
Type: object
Additional Properties Allowed
Show Source
Settings for Phase 2 of protocol (IPSEC).
Nested Schema : reachable_routes
Type: array
List of subnets (CIDR prefixes) that are reachable through this VPN tunnel.
Show Source
Nested Schema : tags
Type: array
Tags associated with the object.
Show Source
Nested Schema : vnicSets
Type: array
Comma-separated list of vNIC sets. Traffic is allowed to and from these vNIC sets to the cloud gateway's vNIC set.
Show Source
Nested Schema : additionalProperties
Type: object
Nested Schema : additionalProperties
Type: object
Back to Top

Examples

cURL Command

The following example shows how to retrieve details of a VPN connection by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Enter the command on a single line. Line breaks are used in this example for readability.

curl -X GET 
     -H "Cookie: $COMPUTE_COOKIE"
     -H "Content-Type: application/oracle-compute-v3+json"
     -H "Accept: application/oracle-compute-v3+json"
        https://api-z999.compute.us0.oraclecloud.com/vpnendpoint/v2/Compute-acme/jack.jones@example.com/vpnconnection1

  • COMPUTE_COOKIE is the name of the variable in which you stored the authentication cookie earlier. For information about retrieving the authentication cookie and storing it in a variable, see Authentication.

  • api-z999.compute.us0.oraclecloud.com is an example REST endpoint URL. Change this value to the REST endpoint URL of your Compute Classic site. For information about finding out REST endpoint URL for your site, see Send Requests.

  • acme and jack.jones@example.com are example values. Replace acme with the identity domain ID of your Compute Classic account, and jack.jones@example.com with your user name.

Example of Response Body

The following example shows the response body in JSON format. The value of the tunnelStatus parameter provides the current status of the VPN connection. 

{
  "uri": "https://api-z999.compute.us0.oraclecloud.com:443/network/v1/vpnendpoint/Compute-acme/jack.jones@example.com/vpnconnection1",
  "tunnelStatus": "UP",
  "psk": "*****",
  "name": "/Compute-acme/jack.jones@example.com/vpnconnection1",
  "reachable_routes": [
    "10.2.3.0/24",
    "10.3.2.0/24"
  ],
  "pfsFlag": true,
  "localGatewayAddress": "10.252.155.208",
  "vnicSets": [
    "/Compute-acme/jack.jones@example.com/vnicset1"
  ],
  "phase1Settings": {
    "encryption": "aes128",
    "hash": "sha1",
    "dhGroup": "group2"
  },
  "phase2Settings": {
    "encryption": "aes256",
    "hash": "md5"
  },
  "customer_vpn_gateway": "172.16.254.1",
  "ikeIdentifier": "10.12.13.14",
  "ipNetwork": "/Compute-acme/jack.jones@example.com/ipnet1"
}
Back to Top