Query DB for Policy Rules (v3.1)
Query the DB for policy rules that match the query parameters.
- application/json
Request Body
Query Details for Policy Rule
aggregate Aggregate
The aggregate number of policy rules that match the query parameters.
field stringThe field value.
operator stringPossible values: [
max
,count
,min
,avg
,sum
]The operator values.
- dest_page int32
The destination page.
- getDeleted boolean
The number of policy rules deleted for a time frame.
- group_by string[]
Group the policy rules for the query.
- id string
Lists the policy rules 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.
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from 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.
- total_count int64
Total number of queries.
items PolicyRuleQueryFilter[]
Array [app_def_id string requiredThe app definition IDs that have applied policy rules. The number of applications for a policy rule is limited to 256.
descriptionThe description of the policy rule. Max size = 256.
id stringThe policy rule ID.
name string requiredThe name of the policy rule. Max size = 128.
network_context_id stringThe network context applied to the policy rule. Network context segments network traffic for the purpose of applying different policy rules for the same application.
paths_allowed PathsAllowed required
The paths allowed for the application.
active_paths WANPath[] required
The configured active path for the rule.
Array [label stringThe label to identify the path.
path_type string requiredPossible values: [
vpn
,direct
,servicelink
]The path type.
]backup_paths WANPath[]
The configured backup path for the rule.
Array [label stringThe label to identify the path.
path_type string requiredPossible values: [
vpn
,direct
,servicelink
]The path type.
]l3_failure_paths WANPath[]
The configured l3 failure path for the rule.
Array [label stringThe label to identify the path.
path_type string requiredPossible values: [
vpn
,direct
,servicelink
]The path type.
]policy_set_id stringPolicy Set Id
priority_num integerThe priority number.
service_context ServiceContext[]
Information on the service context.
Array [active_service_label_id string requiredThe configured active service label ID.
active_service_label_type stringPossible values: [
CG_TRANSIT
,NON_CG_TRANSIT
,SASE
]The configured active service label type.
backup_service_label_id stringThe configured backup service label ID.
backup_service_label_type stringPossible values: [
CG_TRANSIT
,NON_CG_TRANSIT
,SASE
]The configured backup service label type.
type string requiredPossible values: [
ALLOWED_TRANSIT
,REQUIRED_TRANSIT
]The type of service context.
]]
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"total_count": 0,
"items": [
{
"app_def_id": "string",
"id": "string",
"name": "string",
"network_context_id": "string",
"paths_allowed": {
"active_paths": [
{
"label": "string",
"path_type": "vpn"
}
],
"backup_paths": [
{
"label": "string",
"path_type": "vpn"
}
],
"l3_failure_paths": [
{
"label": "string",
"path_type": "vpn"
}
]
},
"policy_set_id": "string",
"priority_num": 0,
"service_context": [
{
"active_service_label_id": "string",
"active_service_label_type": "CG_TRANSIT",
"backup_service_label_id": "string",
"backup_service_label_type": "CG_TRANSIT",
"type": "ALLOWED_TRANSIT"
}
]
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
_error ErrorResponse[]
Array [code stringmessage string]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "BAD_REQUEST"
}
]
}
}