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.

    field string


    operator string

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


    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 actual count.

    deleted_count int64

    The deleted number.

    deleted_ids string[]

    The deleted 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.

    items SiteBasePrefixAssociationQueryFilter[]
  • Array [
  • filters Filter[]required

    The details of the prefix filter.

  • Array [
  • elements string[]required

    Elements of the filter.

    path string[]required

    Path of the filter.

    site objectrequired

    Site of the filter.

    type string

    Type of the filter.

  • ]
  • id string

    The ID.

    prefix_filter_id string

    The ID of the prefix filter.

    site_id string

    The ID of the site.

  • ]