VPN Gateway¶
This page describes operations you can perform on vpn_gateways. List, and get details for.
List Vpn Gateway¶
List all visible vpn_gateways.
Synchronous / Asynchronous¶
- Synchronous
Request¶
HTTP Request Method¶
- GET
HTTP Request Path¶
{endpoint}/v2.0/vpn_gateways
HTTP Request Parameters¶
Parameter | Style | Type | Format | Enumeration | Description | Required |
---|---|---|---|---|---|---|
description | query | string | - | - | Description of the VPN Gateway resource | no |
id | query | string | - | - | Unique ID of the VPN Gateway resource | no |
name | query | string | - | - | Name of the VPN Gateway resource | no |
qos_option_id | query | string | hyph-uuid-or-empty | - | Quality of Service options selected for this Gateway | no |
status | query | string | - | - | The VPN Gateway status. | no |
tenant_id | query | string | non-hyph-uuid | - | Tenant ID of the owner (UUID) | no |
vpn_service_id | query | string | hyph-uuid-or-empty | - | VPN Service instantiated by this Gateway | 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_gateways | array<object> | VPN Gateway | - |
description | string | - | Description of the VPN Gateway resource |
id | string | - | Unique ID of the VPN Gateway resource |
name | string | - | Name of the VPN Gateway resource |
qos_option_id | string | hyph-uuid-or-empty | Quality of Service options selected for this Gateway |
status | string | - | The VPN Gateway status. |
tenant_id | string | non-hyph-uuid | Tenant ID of the owner (UUID) |
vpn_service_id | string | hyph-uuid-or-empty | VPN Service instantiated by this Gateway |
Examples¶
Sample Request Body¶
This operation does not send a request body.
Sample Response Body¶
{
"vpn_gateways": [
{
"description": "vpn_gateway_inet_test, 10M-BE, member role",
"id": "07f97269-e616-4dff-a73f-ca80bc5682dc",
"name": "lab3-test-member-user-vpn-gateway",
"qos_option_id": "e41f6a2f-e197-41c8-9f71-ef19cfd2a85a",
"status": "ACTIVE",
"tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
"vpn_service_id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9"
},
{
"description": "",
"id": "4c842674-60e4-48eb-b5a3-b902f832d0af",
"name": "N000001996_V15000001",
"qos_option_id": "aa776ce4-08a8-4cc1-9a2c-bb95e547916b",
"status": "ACTIVE",
"tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
"vpn_service_id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9"
}
]
}
Show Vpn Gateway¶
Show details for vpn_gateway.
Synchronous / Asynchronous¶
- Synchronous
Request¶
HTTP Request Method¶
- GET
HTTP Request Path¶
{endpoint}/v2.0/vpn_gateways/{vpn_gateway_id}
HTTP Request Parameters¶
Parameter | Style | Type | Format | Enumeration | Description | Required |
---|---|---|---|---|---|---|
vpn_gateway_id | URI | string | hyph-uuid | - | Unique ID of the VPN Gateway resource | yes |
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_gateway | object | VPN Gateway | - |
description | string | - | Description of the VPN Gateway resource |
id | string | - | Unique ID of the VPN Gateway resource |
name | string | - | Name of the VPN Gateway resource |
qos_option_id | string | hyph-uuid-or-empty | Quality of Service options selected for this Gateway |
status | string | - | The VPN Gateway status. |
tenant_id | string | non-hyph-uuid | Tenant ID of the owner (UUID) |
vpn_service_id | string | hyph-uuid-or-empty | VPN Service instantiated by this Gateway |
Examples¶
Sample Request Body¶
This operation does not send a request body.
Sample Response Body¶
{
"vpn_gateway": {
"description": "vpn_gateway_inet_test, 10M-BE, member role",
"id": "07f97269-e616-4dff-a73f-ca80bc5682dc",
"name": "lab3-test-member-user-vpn-gateway",
"qos_option_id": "e41f6a2f-e197-41c8-9f71-ef19cfd2a85a",
"status": "ACTIVE",
"tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
"vpn_service_id": "d4006e79-9f60-4b72-9f86-5f6ef8b4e9e9"
}
}