Get VPN Link Status (v2.1)

GET 
/v2.1/api/tenants/:tenant_id/vpnlinks/:vpn_link_id/status

List the status of the VPN link.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

vpn_link_id stringrequired

The ID of the VPN link.

Responses

200

Successful Operation

application/json

Schema

Schema

active boolean

Active

common_cipher string

Common Cipher

ep1_cipher string

Ep1 Cipher

ep1_element_id string

Ep1 Element Id

ep1_interface_id string

Ep1 Interface Id

ep1_keep_alive_failure_count integer

Ep1 Keep Alive Failure Count

ep1_keep_alive_interval integer

Ep1 Keep Alive Interval

ep1_site_id string

Ep1 Site Id

ep2_cipher string

Ep2 Cipher

ep2_element_id string

Ep2 Element Id

ep2_interface_id string

Ep2 Interface Id

ep2_keep_alive_failure_count integer

Ep2 Keep Alive Failure Count

ep2_keep_alive_interval integer

Ep2 Keep Alive Interval

ep2_site_id string

Ep2 Site Id

id string

Id

link_up boolean

Link Up

usable boolean

Usable

Example (from schema)

{
  "active": true,
  "common_cipher": "string",
  "ep1_cipher": "string",
  "ep1_element_id": "string",
  "ep1_interface_id": "string",
  "ep1_keep_alive_failure_count": 0,
  "ep1_keep_alive_interval": 0,
  "ep1_site_id": "string",
  "ep2_cipher": "string",
  "ep2_element_id": "string",
  "ep2_interface_id": "string",
  "ep2_keep_alive_failure_count": 0,
  "ep2_keep_alive_interval": 0,
  "ep2_site_id": "string",
  "id": "string",
  "link_up": true,
  "usable": true
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "VPL_NOT_FOUND"
      },
      {
        "code": "VPL_ACTION_INSUFFICIENT_VPE"
      }
    ]
  }
}

Loading...