Get VPN Link Status (v2.1)

GET 
https://api.us.cloudgenix.com/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

activeboolean

Active

common_cipherstring

Common Cipher

ep1_cipherstring

Ep1 Cipher

ep1_element_idstring

Ep1 Element Id

ep1_interface_idstring

Ep1 Interface Id

ep1_keep_alive_failure_countinteger

Ep1 Keep Alive Failure Count

ep1_keep_alive_intervalinteger

Ep1 Keep Alive Interval

ep1_site_idstring

Ep1 Site Id

ep2_cipherstring

Ep2 Cipher

ep2_element_idstring

Ep2 Element Id

ep2_interface_idstring

Ep2 Interface Id

ep2_keep_alive_failure_countinteger

Ep2 Keep Alive Failure Count

ep2_keep_alive_intervalinteger

Ep2 Keep Alive Interval

ep2_site_idstring

Ep2 Site Id

idstring

Id

link_upboolean

Link Up

usableboolean

Usable

Example (auto)

{
  "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 [
codestring
The error code.
messagestring
The error message.
]

Example (auto)

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

Example

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

• curl
• python
• go
• nodejs
• csharp
• php

• CURL

curl -L 'https://api.us.cloudgenix.com/v2.1/api/tenants/:tenant_id/vpnlinks/:vpn_link_id/status' \
-H 'Accept: application/json'

Request Collapse all

Base URL

https://api.us.cloudgenix.com

Parameters

tenant_id — pathrequired

vpn_link_id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!