Skip to main content

Get WAN Interface Labels (v2.5)

GET 

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

List all the WAN interface labels for a tenant.

Request

Path Parameters

    tenant_id stringrequired

    The tenant ID.

Responses

Successful Operation

Schema
    count int32

    The total number.

    id string

    The ID.

    type string

    The type.

    items WANInterfaceLabelV2N5[]
  • Array [
  • bwc_enabled boolean

    The bwc parameters.

    description

    The description of the WAN interface label. Maz size = 256.

    id string

    The ID of the WAN interface label.

    l3_reachability WANL3Reachability

    The WAN L3 reachability information.

    probe_config_ids string[]

    The probe configuration IDs.

    use_element_default boolean

    The default element used.

    label string

    The label of the WAN interface.

    lqm_enabled boolean

    The link quality monitoring parameters.

    name string

    The name of the WAN interface label. Max size = 128.

    probe_profile_id string

    The probe profile ID.

    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.

    use_lqm_for_non_hub_paths boolean

    Indicates if the use for lqm for non hub paths is enabled.

    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...