VPN Service¶

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

List Vpn Service¶

List all visible vpn_services.

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/v2.0/vpn_services

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
description	query	string	-	-	Description of the VPN Service resource	no
id	query	string	hyph-uuid	-	Unique ID of the VPN Service resource	no
name	query	string	-	-	Name of the VPN Service resource	no
zone	query	string	-	-	Name of zone	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_services	array<object>	datatype_vpn_service	-
description	string	-	Description of the VPN Service resource
id	string	hyph-uuid	Unique ID of the VPN Service resource
name	string	-	Name of the VPN Service resource
zone	string	-	Name of zone

Examples¶

Sample Request Body¶

This operation does not send a request body.

Sample Response Body¶

{
  "vpn_services": [
    {
      "description": "lab3 vpn connectivity provider",
      "id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9",
      "name": "Lab3-VPN-Service-Provider-01",
      "zone": "Lab3"
    },
    {
      "description": "lab3 vpn connectivity provider",
      "id": "63094f0a-81ee-4d7f-9b05-05c6a95aa8f2",
      "name": "Lab3-VPN-Service-Provider-02",
      "zone": "Lab3"
    }
  ]
}

Show Vpn Service¶

Show details for vpn_service.