Query Element Security Zones (v2.0)
POST/sdwan/v2.0/api/elementsecurityzones/query
Query the element security zones.
Request
- application/json
Body
Details for Element Security Zone Query
- Array [
- ]
aggregate Aggregate
The aggregate number of element security zones that match the query parameters.
data AggregateData[]
The details of the aggregate data.
Value of the aggregate data.
View the aggregate date.
The field value.
The name of the query response.
Possible values: [max
, count
, min
, avg
, sum
]
The operator values.
The aggregate statistics.
The unit.
The destination page.
The number of element security zones deleted for a time frame.
Group the element security zones for the query.
Lists the element security zones by ID.
Return the ID of a specified query in the current session.
The query limit.
The limit.
Retrieve information from a field.
List the fields to query.
The total number of query parameters.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
The actual count.
The deleted number.
The deleted IDs.
Description of the query. Max size = 256.
The ID.
Details of the next query.
Total number.
items ElementSecurityZoneQueryFilter[]
The ID of the element configured for the security zone.
The ID of the security zone.
The element security zones interface IDs.
The element security zones LAN network IDs.
The site ID configured for the element security zone.
The element security zones WAN interface IDs.
The element security zones WAN overlay IDs.
The element security zone ID.
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"total_count": 0,
"items": [
{
"element_id": "string",
"id": "string",
"interface_ids": [
"string"
],
"lannetwork_ids": [
"string"
],
"site_id": "string",
"waninterface_ids": [
"string"
],
"wanoverlay_ids": [
"string"
],
"zone_id": "string"
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "BAD_REQUEST"
}
]
}
}