Get WAN Interface Label (v2.3)
GET/v2.3/api/tenants/:tenant_id/waninterfacelabels/:wantinterface_label_id
List a specific WAN interface label.
Request
Path Parameters
tenant_id stringrequired
The ID of the tenant.
wantinterface_label_id stringrequired
The ID of the WAN interface label.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
description
The description of the WAN interface label. Maz size = 256.
id string
The ID of the WAN interface label.
label string
The label of the WAN interface.
name string
The name of the WAN interface label. Max size = 128.
tags string[]
An information field that can be added to identify the WAN interface label. Maximum 10 unique tags of length 1024 each are allowed.
use_for_application_reachability_probes boolean
Indicates if the use for application reachability probe is selected.
use_for_controller_connections boolean
Indicates if the use for controller connections is selected.
vpnlink_configuration VPNLinkConfiguration
The configuration of the VPN link.
keep_alive_failure_count integerrequired
The VPN keep alive failure count (must be between 3 and 30).
keep_alive_interval integerrequired
The VPN keep alive timeout interval (must be between 100ms-1740,000ms).
{
"id": "string",
"label": "string",
"name": "string",
"tags": [
"string"
],
"use_for_application_reachability_probes": true,
"use_for_controller_connections": true,
"vpnlink_configuration": {
"keep_alive_failure_count": 0,
"keep_alive_interval": 0
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
code string
message string
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "WAN_INTERFACE_LABEL_NOT_FOUND"
}
]
}
}
Loading...