Retrieve Details of all VPN Endpoints in a Container
/vpnendpoint/{container}/
Retrieves details of all the VPN endpoints that are available in the specified container.
Required Role: To complete this task, you must have the Compute_Monitor
or 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
- application/oracle-compute-v3+json
-
container: string
Specify parent path of the object name, such as
/Compute-acme
.
-
Cookie: string
The Cookie: header must be included with every request to the service. It must be set to the value of the set-cookie header in the response received to the POST /authenticate/ call.
Response
- application/oracle-compute-v3+json
200 Response
-
set-cookie: string
The cookie value is returned if the session is extended
object
-
customer_vpn_gateway(optional):
string
IP address of the VPN gateway in your data center through which you want to connect to the Oracle Cloud VPN gateway.
-
enabled(optional):
boolean
true
indicates that the VPN endpoint is enabled and a connection is established immediately, if possible. -
name(optional):
string
Two-part name of the object (
/Compute-acme/object
) -
psk(optional):
string
Pre-shared VPN key.
-
reachable_routes(optional):
array reachable_routes
List of subnets (CIDR prefixes) that are reachable through this VPN tunnel.
-
status(optional):
string
Current status of the VPN tunnel.
-
status_desc(optional):
string
Describes the current status of the VPN tunnel.
-
uri(optional):
string
Uniform Resource Identifier
-
vpn_statistics(optional):
object vpn_statistics
Additional Properties Allowed: additionalPropertiesStatistics of VPN tunnels
array
object
object
Examples
cURL Command
The following example shows how to retrieve details about all VPN endpoints in the /Compute-acme/jack.jones@example.com
container 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 "Accept: application/oracle-compute-v3+json" https://api-z999.compute.us0.oraclecloud.com/vpnendpoint/Compute-acme/jack.jones@example.com/
-
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
is an example value. Replace this value with the name of the identity domain name of your Compute Classic.
Example of Response Body
The following example shows the response body in JSON format.
{ "result": [ { "status": "UP", "psk": "********", "name": "/Compute-acme/vpn-to-LA", "reachable_routes": [ "192.168.155.2/24", "192.168.135.0/24" ], "enabled": true, "uri": "http://api.oc.example.com/vpnendpoint/Compute-acme/vpn-to-LA", "status_desc": "", "customer_vpn_gateway": "192.168.111.2" } ] }