Skip to main content

Query DB for Policy Rules (v3.1)​

Query the DB for policy rules that match the query parameters.

Request Body

Query Details for Policy Rule

  • aggregate Aggregate

    The aggregate number of policy rules that match the query parameters.

  • field string

    The field value.

  • operator string

    Possible 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.

Responses

Successful Operation

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 required

    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 string required

    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 PathsAllowed required

    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 string required

    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 string required

    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 string required

    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 string required

    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 string required

    Possible values: [ALLOWED_TRANSIT, REQUIRED_TRANSIT]

    The type of service context.

  • ]
  • ]
Loading...