Query Network policy rules. (v2.3)

POST 
/v2.3/api/tenants/:tenant_id/networkpolicyrules/query

Query Network policy rules.

Request

Path Parameters

tenant_id stringrequired

Tenant Id

application/json

Body

Details to query the Network policy rules.

app_def_ids string[]

The app definition IDs that have applied network policy rules. The number of applications for a policy rule is limited to 256.

best_path_config ProbeMetricInfo

Information on the best path configuration values.

metric string

Possible values: [LATENCY, JITTER, PACKET_LOSS, INIT_FAILURE_PCT, DNS_TXN_FAILURE_PCT]

The metric values.

metric_type string

Possible values: [PROBE, LQM]

The metric type.

probe_config_id string

The probe configuration ID.

description

The description of the network policy rule. Max size = 256.

destination_prefixes_id string

The destination prefix ID.

enabled boolean

The network policy rule based on rules that are enabled.

id string

The network policy rule ID.

name stringrequired

The name of the network policy rule. Max size = 128.

network_context_id string

The network context applied to the network policy rule. Network context segments network traffic for the purpose of applying different network policy rules for the same application.

order_number integer

The network policy rule order number. The default order number for a policy rule is 1024.

paths_allowed PathsAllowedV2N1required
The paths allowed for the application.
active_paths WANPath[]
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.
]
service_context ServiceContext

Information on the service context.

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.

source_prefixes_id string

The ID of the source prefixes.

tags string[]

A information field that can be added to identify the network policy rule. Maximum 10 unique tags of length 1024 each are allowed.

user_or_group UserGroup

The details of the user or group.

user_group_ids string[]

The user group IDs.

user_ids string[]

The user IDs.

Responses

200

Successful Operation

application/json

Schema

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.

tenant_id string

The tenant ID.

total_count int64

Total number.

items NetworkPolicyRuleQueryFilterV2N3[]
Array [
app_def_ids string[]
The app definition IDs that have applied network policy rules. The number of applications for a policy rule is limited to 256.
best_path_config ProbeMetricInfo
Information on the best path configuration values.
metric string
Possible values: [LATENCY, JITTER, PACKET_LOSS, INIT_FAILURE_PCT, DNS_TXN_FAILURE_PCT]
The metric values.
metric_type string
Possible values: [PROBE, LQM]
The metric type.
probe_config_id string
The probe configuration ID.
description
The description of the network policy rule. Max size = 256.
destination_prefixes_id string
The destination prefix ID.
enabled boolean
The network policy rule based on rules that are enabled.
id string
The network policy rule ID.
name stringrequired
The name of the network policy rule. Max size = 128.
network_context_id string
The network context applied to the network policy rule. Network context segments network traffic for the purpose of applying different network policy rules for the same application.
order_number integer
The network policy rule order number. The default order number for a policy rule is 1024.
paths_allowed PathsAllowedV2N1required
The paths allowed for the application.
active_paths WANPath[]
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.
]
service_context ServiceContext
Information on the service context.
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.
source_prefixes_id string
The ID of the source prefixes.
tags string[]
A information field that can be added to identify the network policy rule. Maximum 10 unique tags of length 1024 each are allowed.
user_or_group UserGroup
The details of the user or group.
user_group_ids string[]
The user group IDs.
user_ids string[]
The user IDs.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "app_def_ids": [
        "string"
      ],
      "best_path_config": {
        "metric": "LATENCY",
        "metric_type": "PROBE",
        "probe_config_id": "string"
      },
      "destination_prefixes_id": "string",
      "enabled": true,
      "id": "string",
      "name": "string",
      "network_context_id": "string",
      "order_number": 0,
      "paths_allowed": {
        "active_paths": [
          {
            "label": "string",
            "path_type": "vpn"
          }
        ],
        "backup_paths": [
          {
            "label": "string",
            "path_type": "vpn"
          }
        ],
        "l3_failure_paths": [
          {
            "label": "string",
            "path_type": "vpn"
          }
        ]
      },
      "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"
      },
      "source_prefixes_id": "string",
      "tags": [
        "string"
      ],
      "user_or_group": {
        "user_group_ids": [
          "string"
        ],
        "user_ids": [
          "string"
        ]
      }
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "BAD_REQUEST"
      }
    ]
  }
}

Loading...