Update Element Security Zone (v2.0)

PUT 
/v2.0/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/securityzones/:security_zone_id

Update an existing security zone.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

site_id stringrequired

The ID of the site.

element_id stringrequired

The ID of the element.

security_zone_id stringrequired

The ID of the security zone.

application/json

Body

Details of the element security zone to be updated

id string

The ID of the security zone.

interface_ids string[]

The element security zones interface IDs.

lannetwork_ids string[]

The element security zones LAN network IDs.

site_id stringrequired

The site ID configured for the element security zone.

tenant_id stringrequired

Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)

waninterface_ids string[]

The element security zones WAN interface IDs.

wanoverlay_ids string[]

The element security zones WAN overlay IDs.

zone_id stringrequired

The element security zone ID.

Responses

200

Successful Operation

application/json

Schema

Schema

id string

The ID of the security zone.

interface_ids string[]

The element security zones interface IDs.

lannetwork_ids string[]

The element security zones LAN network IDs.

site_id stringrequired

The site ID configured for the element security zone.

tenant_id stringrequired

Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)

waninterface_ids string[]

The element security zones WAN interface IDs.

wanoverlay_ids string[]

The element security zones WAN overlay IDs.

zone_id stringrequired

The element security zone ID.

Example (from schema)

{
  "id": "string",
  "interface_ids": [
    "string"
  ],
  "lannetwork_ids": [
    "string"
  ],
  "site_id": "string",
  "tenant_id": "string",
  "waninterface_ids": [
    "string"
  ],
  "wanoverlay_ids": [
    "string"
  ],
  "zone_id": "string"
}

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": "ELEMENT_SECURITYZONE_ELEMENT_NOT_FOUND"
      },
      {
        "code": "ELEMENT_SECURITYZONE_ZONE_NOT_FOUND"
      },
      {
        "code": "ELEMENT_SECURITYZONE_INVALID_ELEMENT_ROLE"
      },
      {
        "code": "ELEMENT_SECURITYZONE_DUPLICATE_INTERFACE_IDS"
      },
      {
        "code": "ELEMENT_SECURITYZONE_INTERFACE_ID_NOT_FOUND"
      },
      {
        "code": "ELEMENT_SECURITYZONE_DUPLICATE_LANNETWORK_IDS"
      },
      {
        "code": "ELEMENT_SECURITYZONE_LANNETWORK_ID_NOT_FOUND"
      },
      {
        "code": "ELEMENT_SECURITYZONE_DUPLICATE_WANOVERLAY_IDS"
      },
      {
        "code": "ELEMENT_SECURITYZONE_WANOVERLAY_ID_NOT_FOUND"
      },
      {
        "code": "ELEMENT_SECURITYZONE_INVALID_INTERFACE_IDS"
      },
      {
        "code": "ELEMENT_SECURITYZONE_ZONEID_REQUIRED"
      },
      {
        "code": "ELEMENT_SECURITYZONE_INVALID_LANNETWORK_IDS"
      },
      {
        "code": "ELEMENT_SECURITYZONE_INVALID_WANINTERFACE_IDS"
      },
      {
        "code": "ELEMENT_SECURITYZONE_INVALID_WANOVERLAY_IDS"
      }
    ]
  }
}

Loading...