Skip to main content

Get WAN Interface Labels (v2.3)

GET 

/v2.3/api/tenants/:tenant_id/waninterfacelabels

List all the WAN interface labels for a tenant.

Request

Path Parameters

    tenant_id stringrequired

    The ID of the tenant.

Responses

Successful Operation

Schema
    count int32

    The total number of responses.

    id string

    The ID of the response.

    type string

    The type of response.

    items WANInterfaceLabelV2N3[]
  • Array [
  • 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).

  • ]
Loading...