Update WAN Interface Label (v2.3)

Update a specific WAN interface label.

Path Parameters

• tenant_id string required

  The ID of the tenant.

• wantinterface_label_id string required

  The ID of the WAN interface label.

application/json

Request Body

• 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 integer required

  The VPN keep alive failure count (must be between 3 and 30).

  keep_alive_interval integer required

  The VPN keep alive timeout interval (must be between 100ms-1740,000ms).

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 integer required

  The VPN keep alive failure count (must be between 3 and 30).

  keep_alive_interval integer required

  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

• _error ErrorResponse[]

  Array [

  code string

  message string

  ]

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

{
  "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"
      }
    ]
  }
}

Loading...