Update WAN Interface Label (v2.5)

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

Update a specific WAN interface label.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

wantinterface_label_id stringrequired

The ID of the WAN interface label.

application/json

Body

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

Responses

200

Successful Operation

application/json

Schema

Schema

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

Example (from schema)

{
  "bwc_enabled": true,
  "id": "string",
  "l3_reachability": {
    "probe_config_ids": [
      "string"
    ],
    "use_element_default": true
  },
  "label": "string",
  "lqm_enabled": true,
  "name": "string",
  "probe_profile_id": "string",
  "tags": [
    "string"
  ],
  "use_for_application_reachability_probes": true,
  "use_for_controller_connections": true,
  "use_lqm_for_non_hub_paths": true,
  "vpnlink_configuration": {
    "keep_alive_failure_count": 0,
    "keep_alive_interval": 0
  }
}

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": "WAN_INTERFACE_LABEL_NOT_FOUND"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "INVALID_JSON_COMMON_ATTR_MISMATCH"
      },
      {
        "code": "VPNLINK_CONFIG_INVALID_KEEP_ALIVE_INTERVAL"
      },
      {
        "code": "VPNLINK_CONFIG_INVALID_KEEP_ALIVE_FAILURE_COUNT"
      },
      {
        "code": "VPNLINK_CONFIG_REQUIRED"
      },
      {
        "code": "WAN_INTERFACE_LABEL_MISMATCH"
      },
      {
        "code": "WANINTERFACE_LABEL_USE_FOR_NON_HUB_PATHS_INVALID"
      },
      {
        "code": "L3_REACHABILITY_MAX_PROBE_CONFIGS_LIMIT_EXCEEDED"
      },
      {
        "code": "INVALID_PROBE_PROFILE"
      },
      {
        "code": "WANINTERFACE_L3_REACHABILITY_OVERRIDING_PROBE_CONFIGS_FROM_LABEL_PROFILE"
      },
      {
        "code": "L3_REACHABILITY_PROBE_CONFIGS_CANONT_BE_SET_ELEMENT_DEFAULT_CONFIGURED"
      },
      {
        "code": "L3_REACHABILITY_PROBE_CONFIGS_REQUIRED_WHEN_ELEMENT_DEFAULT_NOT_USED"
      },
      {
        "code": "PROBE_CONFIGS_CANNOT_BE_SPECIFIED_WITHOUT_PROBE_PROFILE"
      },
      {
        "code": "WANINTERFACE_LABEL_PROBE_PROFILE_DOES_NOT_CONTAIN_PROBE_CONFIGS"
      },
      {
        "code": "PROBE_CONFIG_VALID_L3_REACHABILITY_PROTOCOL_MISSING"
      },
      {
        "code": "PROBE_CONFIG_VALID_L3_REACHABILITY_DIRECT_PATH_MISSING"
      },
      {
        "code": "L3_REACHABILITY_PROBE_CONFIGS_REQUIRED"
      },
      {
        "code": "L3_REACHABILITY_CAN_NOT_BE_UNSET_FROM_LABEL"
      }
    ]
  }
}

Loading...