Skip to main content

Query Security Prefix Filter (v2.0)



Query the security prefix filter for NB API.


Path Parameters

    tenant_id stringrequired

    The tenant ID.


Query details for security prefix filter

    aggregate Aggregate

    The aggregate number of prefix associations that match the query parameters.

    data AggregateData[]required

    The details of the aggregate data.

  • Array [
  • value numberrequired

    Value of the aggregate data.

    view objectrequired

    View the aggregate date.

  • ]
  • field string


    name stringrequired

    The name of the query response.

    operator string

    Possible values: [max, count, min, avg, sum]


    statistic stringrequired

    QoS application aggregate statistics.

    unit stringrequired

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number of prefix associations deleted for a time frame.

    group_by string[]

    Group the prefix associations for the query.

    id string

    Lists the prefix associations by ID.

    last_query_ts int64

    Return the ID of a specified query in the current session.

    limit int32

    The query limit.

    next_query object

    The limit.

    query_params object
    retrieved_fields string[]

    Retrieve information from a field.

    retrieved_fields_mask boolean

    List the fields to query.

    sort_params object
    total_count int64

    The total number of query parameters.


Successful Operation

    count int32

    The count of the query list.

    deleted_count int64

    The deleted number of queries.

    deleted_ids string[]

    The deleted query IDs.


    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 SiteBasePrefixAssociationQueryFilter[]
  • Array [
  • filters Filter[]required

    The details of the prefix filter.

  • Array [
  • elements string[]required

    Filter by element.

    path string[]required

    Filter by path.

    site objectrequired

    Filter by site.

    type string

    Filter by type.

  • ]
  • id string

    The ID.

    prefix_filter_id string

    The ID of the prefix filter.

    site_id string

    The ID of the site.

  • ]