Get Ip Sec Vpn Tunnels

Get Ip Sec Vpn Tunnels

Retrieves all IPSec VPN tunnels that are configured for an edge gateway. Pagination is supported, use response header to get the next page. Results can be sorted by only a single parameter. Sorting by combination of parameters (sortAsc=foo&sortDesc=bar) is not allowed.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/ipsec/tunnels
COPY
Path Parameters
string
externalNetworkId
Required

externalNetworkId

string
externalNetworkId
Required

externalNetworkId

Query Parameters
string
cursor
Optional

Field used for getting next page of records. The value is supplied by the current result page. If not set, the first page is retrieved. If cursor is set, then all other pagination query parameters such as pageSize, sortDesc, sortAsc, queryFilter are ignored.

integer
pageSize
Required

Results per page to fetch.

string
sortAsc
Optional

Field to use for ascending sort

string
sortDesc
Optional

Field to use for descending sort

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns GatewayIpSecVpnTunnels of type(s) application/json;version=39.0
This response body class contains all of the following: NetworkingEntityStatus , InlineGatewayIpSecVpnTunnels1 
{
    "status": "string",
    "values": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "active": false,
            "localEndpoint": {
                "localId": "string",
                "localAddress": "string",
                "localNetworks": [
                    "string"
                ]
            },
            "remoteEndpoint": {
                "remoteId": "string",
                "remoteAddress": "string",
                "remoteNetworks": [
                    "string"
                ]
            },
            "authenticationMode": "string",
            "preSharedKey": "string",
            "certificateRef": {
                "name": "string",
                "id": "string"
            },
            "caCertificateRef": {
                "name": "string",
                "id": "string"
            },
            "connectorInitiationMode": "string",
            "securityType": "string",
            "logging": false,
            "version": {
                "version": 0
            },
            "tunnelInterfaces": [
                "string"
            ],
            "tunnelType": "string",
            "connectivityStatus": "string"
        }
    ]
}

404

The specified resource was not found

Returns Error of type(s) application/json;version=39.0 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 33.0
On This Page
Edge Gateway Ip Sec Vpn Tunnels Operations
POST
Create Ip Sec Vpn Tunnel
GET
Get Ip Sec Vpn Tunnels