Skip to main content

Query DB for Security Policy Sets (v2.0)

POST 

/sdwan/v2.0/api/securitypolicysets/query

Query the DB for limit number of security policy sets that match query parameters.

Request

Body

Query details for SecurityPolicySet

    aggregate Aggregate

    The aggregate number of security policy sets that match the query parameters.

    data AggregateData[]

    The details of the aggregate data.

  • Array [
  • value number

    Value of the aggregate data.

    view object

    View the aggregate date.

  • ]
  • field string

    The field value.

    name string

    The name of the query response.

    operator string

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

    The operator values.

    statistic string

    The aggregate statistics.

    unit string

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number of security policy sets deleted for a time frame.

    group_by string[]

    Group the security policy sets for the query.

    id string

    Lists the security policy sets 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.

Responses

Successful Operation

Schema
    count int32

    The actual count.

    deleted_count int64

    The deleted number.

    deleted_ids string[]

    The deleted IDs.

    description

    Description of the query. Max size = 256.

    id string

    The ID.

    next_query object

    Details of the next query.

    total_count int64

    Total number.

    items SecurityPolicySetQueryFilter[]
  • Array [
  • description

    Description of the security policy set.

    id string

    ID of the security policy set.

    name stringrequired

    Name of the security policy set. Max 25 characters.

    policyrule_order string[]

    The order for the execution of the policy rule.

  • ]
Loading...