Get Policy Rules (v3.1)

GET 
/v3.1/api/tenants/:tenant_id/policysets/:policy_set_id/policyrules

List all the policy rules of a tenant.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

policy_set_id stringrequired

The policy set ID.

Responses

200

Successful Operation

application/json

Schema

Schema

oneOf
MOD1
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 PolicyRuleQueryFilter[]
Array [
app_def_id stringrequired
The app definition IDs that have applied policy rules. The number of applications for a policy rule is limited to 256.
description
The description of the policy rule. Max size = 256.
id string
The policy rule ID.
name stringrequired
The name of the policy rule. Max size = 128.
network_context_id string
The 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 PathsAllowedrequired
The paths allowed for the application.
active_paths WANPath[]required
The configured active path for the rule.
Array [
label string
The label to identify the path.
path_type stringrequired
Possible values: [vpn, direct, servicelink]
The path type.
]
backup_paths WANPath[]
The configured backup path for the rule.
Array [
label string
The label to identify the path.
path_type stringrequired
Possible values: [vpn, direct, servicelink]
The path type.
]
l3_failure_paths WANPath[]
The configured l3 failure path for the rule.
Array [
label string
The label to identify the path.
path_type stringrequired
Possible values: [vpn, direct, servicelink]
The path type.
]
policy_set_id string
Policy Set Id
priority_num integer
The priority number.
service_context ServiceContext[]
Information on the service context.
Array [
active_service_label_id stringrequired
The configured active service label ID.
active_service_label_type string
Possible values: [CG_TRANSIT, NON_CG_TRANSIT, SASE]
The configured active service label type.
backup_service_label_id string
The configured backup service label ID.
backup_service_label_type string
Possible values: [CG_TRANSIT, NON_CG_TRANSIT, SASE]
The configured backup service label type.
type stringrequired
Possible values: [ALLOWED_TRANSIT, REQUIRED_TRANSIT]
The type of service context.
]
]
MOD2
count int32
The number of responses.
id string
The ID of the response.
tenant_id string
The ID of the tenant.
items PolicyRule[]
Array [
app_def_id stringrequired
The app definition ID that have applied policy rules. The number of applications for a policy rule is limited to 256.
app_def_name string
The app definition name.
default_rule boolean
The default policy rule.
description
The policy rule description. Max size = 256.
disabled boolean
Lists if the policy rule is disabled.
disabled_reason string
Reason the policy rule is disabled.
id string
The policy rule ID.
inactive boolean
Lists if the policy rule is inactive.
inactive_reason string
Reason the policy rule is inactive.
lan_network_ids string[]
The LAN network IDs.
name stringrequired
The name of the policy rule. Max size = 128.
network_context_id string
The 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 PathsAllowedrequired
The paths allowed for the application.
active_paths WANPath[]required
The configured active path for the rule.
Array [
label string
The label to identify the path.
path_type stringrequired
Possible values: [vpn, direct, servicelink]
The path type.
]
backup_paths WANPath[]
The configured backup path for the rule.
Array [
label string
The label to identify the path.
path_type stringrequired
Possible values: [vpn, direct, servicelink]
The path type.
]
l3_failure_paths WANPath[]
The configured l3 failure path for the rule.
Array [
label string
The label to identify the path.
path_type stringrequired
Possible values: [vpn, direct, servicelink]
The path type.
]
policy_set_id string
Policy Set Id
priority_num int32
The priority number.
region string
The region of the site.
service_context ServiceContext[]
Information on the service context.
Array [
active_service_label_id stringrequired
The configured active service label ID.
active_service_label_type string
Possible values: [CG_TRANSIT, NON_CG_TRANSIT, SASE]
The configured active service label type.
backup_service_label_id string
The configured backup service label ID.
backup_service_label_type string
Possible values: [CG_TRANSIT, NON_CG_TRANSIT, SASE]
The configured backup service label type.
type stringrequired
Possible values: [ALLOWED_TRANSIT, REQUIRED_TRANSIT]
The type of service context.
]
site_paths_allowed SiteWanPath[]
The paths allowed for a site.
Array [
wn_name string
Wn Name
wp_type string
Possible values: [DIRECT_PUBLIC_WAN, DIRECT_PRIVATE_WAN, VPN_ON_PUBLIC_WAN, VPN_ON_PRIVATE_WAN]
Wp Type
]
tenant_id stringrequired
Tenant Id: NotNull Digits(fraction = 0, integer = 20, TENANT_ID_INVALID_0001)
]

Loading...