Query Security Zone (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/sites/:site_id/sitesecurityzones/query

Query the security zones for NB API.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

site_id stringrequired

The ID of the site.

application/json

Body

Query details for Priority Policy set stacks

id string

The ID of the security zone.

query_params QueryParam

Query Params: Valid

zone_id stringrequired

The element security zone ID.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The count of the query list.

deleted_count int64

The deleted number of queries.

deleted_ids string[]

The deleted query IDs.

description

Description of the query. Max size = 256.

id string

The ID.

next_query object

Details of the next query.

tenant_id string

The tenant ID.

total_count int64

Total number of queries.

items SecurityZoneNetworkAssociation[]
Array [
id string
The ID of the security zone.
networks SiteContext[]required
The details of the network and network type.
Array [
network_id string
The ID of the network.
network_type stringrequired
Possible values: [wan_network, lan_network, wan_overlay]
The network type.
]
zone_id stringrequired
The ID of the security zone.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "id": "string",
      "networks": [
        {
          "network_id": "string",
          "network_type": "wan_network"
        }
      ],
      "zone_id": "string"
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
message string
]

Example (from schema)

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

Example

{
  "value": {
    "_error": [
      {
        "code": "SECURITYZONE_INVALID_QUERY"
      }
    ]
  }
}

Loading...