Get L2 Vpn Tunnel Status

Get L2 Vpn Tunnel Status

Retrieves status of a given L2 VPN Tunnel.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/l2vpn/tunnels/{tunnelId}/status
COPY
Path Parameters
string
gatewayId
Required

gatewayId

string
tunnelId
Required

tunnelId

string
gatewayId
Required

gatewayId

string
tunnelId
Required

tunnelId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns EdgeL2VpnTunnelStatus of type(s) application/json;version=38.0 
{
    "runtimeStatus": "string",
    "failureReason": "string"
}
string
runtimeStatus
Optional

Gives the overall L2 VPN Runtime Status (one of either UP or DOWN).

  • UP - Indicating that the tunnel connection has been successfully established.
  • DOWN - Indicating that the tunnel connection has not yet been successfully established.
string
failureReason
Optional

The error message which led to this tunnel's failure (if applicable).


404

The specified resource was not found

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

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 35.0
On This Page
Edge Gateway L2vpn Tunnel Operations
DELETE
Delete L2 Vpn Tunnel
GET
Get L2 Vpn Tunnel
GET
Get L2 Vpn Tunnel Statistics
GET
Get L2 Vpn Tunnel Status
PUT
Update L2 Vpn Tunnel