Update Anynet Link (v3.3)

PUT 
/v3.3/api/tenants/:tenant_id/anynetlinks/:anynet_id

Update the anynet link.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

anynet_id stringrequired

The anynet ID.

application/json

Body

admin_up boolean

The interface admin state.

description

The anynet link description. Max size = 256.

ep1_site_id string

Ep1 Site Id

ep1_wan_if_id string

Ep1 Wan If Id

ep2_site_id string

Ep2 Site Id

ep2_wan_if_id string

Ep2 Wan If Id

forced boolean

Forced

id string

The anynet link ID.

name string

The anynet link name. Max size = 128.

tags string[]

A information field that can be added to identify the anynet link. Maximum 10 unique tags of length 1024 each are allowed.

tenant_id string

The active user tenant ID.

type string

Possible values: [AUTO, MANUAL, AUTO_PRIVATE, MANUAL_PRIVATE, AUTO_SASE]

Anynet link type.

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

admin_up boolean

The interface admin state.

description

The anynet link description. Max size = 256.

disabled boolean

Disabled

disabled_reason string

Disabled Reason: Size(max = 5000, DISABLED_REASON_INVALID_0001, min = 0)

ep1_branch_gateway boolean

Ep1 Branch Gateway

ep1_site_id string

Ep1 Site Id

ep1_site_role string

Possible values: [NONE, HUB, SPOKE, PA_WE_BR, PA_WE_DC, PA_CONN]

Ep1 Site Role

ep1_wan_interface_id string

Ep1 Wan Interface Id

ep2_branch_gateway boolean

Ep2 Branch Gateway

ep2_site_id string

Ep2 Site Id

ep2_site_role string

Possible values: [NONE, HUB, SPOKE, PA_WE_BR, PA_WE_DC, PA_CONN]

Ep2 Site Role

ep2_wan_interface_id string

Ep2 Wan Interface Id

id string

The anynet link ID.

inactive boolean

Inactive

inactive_reason string

Inactive Reason: Size(max = 5000, INACTIVE_REASON_INVALID_0001, min = 0)

name string

The anynet link name. Max size = 128.

region string

Region

site_id stringrequired

Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) NotNull

tags string[]

A information field that can be added to identify the anynet link. Maximum 10 unique tags of length 1024 each are allowed.

target_serviceendpoint_id string

Target Serviceendpoint Id

tenant_id stringrequired

The active user tenant ID.

type string

Possible values: [AUTO, MANUAL, AUTO_PRIVATE, MANUAL_PRIVATE, AUTO_SASE]

Anynet link type.

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)

{
  "admin_up": true,
  "disabled": true,
  "disabled_reason": "string",
  "ep1_branch_gateway": true,
  "ep1_site_id": "string",
  "ep1_site_role": "NONE",
  "ep1_wan_interface_id": "string",
  "ep2_branch_gateway": true,
  "ep2_site_id": "string",
  "ep2_site_role": "NONE",
  "ep2_wan_interface_id": "string",
  "id": "string",
  "inactive": true,
  "inactive_reason": "string",
  "name": "string",
  "region": "string",
  "site_id": "string",
  "tags": [
    "string"
  ],
  "target_serviceendpoint_id": "string",
  "tenant_id": "string",
  "type": "AUTO",
  "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": "INVALID_JSON_INPUT"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "TOPOLOGY_REBUILD_IN_PROGRESS"
      }
    ]
  }
}

Loading...