Get Policy Rules (v3.1)
List all the policy rules of a tenant.
Path Parameters
- tenant_id string required
The tenant ID.
- policy_set_id string required
The policy set ID.
- 200
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- oneOf
- MOD1
- MOD2
count int32The count of the query list.
deleted_count int64The deleted number of queries.
deleted_ids string[]The deleted query IDs.
descriptionDescription of the query. Max size = 256.
id stringThe ID.
next_query objectDetails of the next query.
tenant_id stringtotal_count int64Total 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 int32The number of responses.
id stringThe ID of the response.
tenant_id stringitems PolicyRule[]
Array [app_def_id string requiredThe app definition ID that have applied policy rules. The number of applications for a policy rule is limited to 256.
app_def_name stringThe app definition name.
default_rule booleanThe default policy rule.
descriptionThe policy rule description. Max size = 256.
disabled booleanLists if the policy rule is disabled.
disabled_reason stringReason the policy rule is disabled.
id stringThe policy rule ID.
inactive booleanLists if the policy rule is inactive.
inactive_reason stringReason the policy rule is inactive.
lan_network_ids string[]The LAN network IDs.
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 int32The priority number.
region stringThe region of the site.
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.
]site_paths_allowed SiteWanPath[]
The paths allowed for a site.
Array [wn_name stringWn Name
wp_type stringPossible values: [
DIRECT_PUBLIC_WAN,DIRECT_PRIVATE_WAN,VPN_ON_PUBLIC_WAN,VPN_ON_PRIVATE_WAN]Wp Type
]tenant_id string requiredTenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
]
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"tenant_id": "string",
"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"
}
]
}
]
}