Skip to main content

Query DB for Policy Rules (v3.1)

POST 

/v3.1/api/tenants/:tenant_id/policyrules/query

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

Request

Path Parameters

    tenant_id stringrequired

    The tenant ID.

Body

Query Details for Policy Rule

    aggregate Aggregate

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

    field string

    Field

    operator string

    Possible values: [max, count, min, avg, sum]

    Operator

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

  • ]
  • ]
Loading...