Query Security Prefix Filter (v2.0)
POST/sdwan/v2.0/api/prefixfilters/query
Query the security prefix filter for NB API.
Request
- application/json
Body
Query details for security prefix filter
- Array [
- ]
aggregate Aggregate
The aggregate number of prefix associations 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 prefix associations deleted for a time frame.
Group the prefix associations for the query.
Lists the prefix associations 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 [
- 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 SiteBasePrefixAssociationQueryFilter[]
filters Filter[]required
The details of the prefix filter.
Elements of the filter.
Path of the filter.
Site of the filter.
Type of the filter.
The ID.
The ID of the prefix filter.
The ID of the site.
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"total_count": 0,
"items": [
{
"filters": [
{
"elements": [
"string"
],
"path": [
"string"
],
"site": {},
"type": "string"
}
],
"id": "string",
"prefix_filter_id": "string",
"site_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": "SECURITYZONE_INVALID_QUERY"
}
]
}
}