Query security policy v2 sets of a tenant (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/ngfwsecuritypolicysets/query

Query security policy v2 sets of a tenant

Request

Path Parameters

tenant_id stringrequired

Tenant ID

application/json

Body

aggregate Aggregate

The aggregate number of security policies V2 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

Field

name stringrequired

The name of the query response.

operator string

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

Operator

statistic stringrequired

QoS application aggregate statistics.

unit stringrequired

The unit.

dest_page int32

The destination page.

getDeleted boolean

The number of security policies V2 deleted for a time frame.

group_by string[]

Group the security policies V2 for the query.

id string

Lists the security policies V2 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

200

Successful Operation

application/json

Schema

Schema

count int32

The count of the query list.

deleted_count int64

The deleted number of queries.

deleted_ids string[]

The deleted query IDs.

description

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 SecurityPolicyV2SetQueryFilter[]
Array [
clone_from string
Policy sets cloned from existing policy sets.
defaultrule_policyset boolean
The default rule of the policy set.
description
The description of the security policy set. Max size = 256.
id string
The security policy set ID.
name stringrequired
The name of the security policy set. Max size = 128.
policyrule_order string[]
The order for the execution of the policy rule.
tags string[]
A information field that can be added to identify the security policy set. Maximum 10 unique tags of length 1024 each are allowed.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "clone_from": "string",
      "defaultrule_policyset": true,
      "id": "string",
      "name": "string",
      "policyrule_order": [
        "string"
      ],
      "tags": [
        "string"
      ]
    }
  ]
}

Loading...