Query DB for Number of Sites that Match Query Params (v4.8)

POST 
/v4.8/api/tenants/:tenant_id/sites/query

Queries the DB for limit number of sites that match the query parameters.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Query Details for the site

aggregate Aggregate

The aggregate number of sites that match the query parameters.

data AggregateData[]

The details of the aggregate data.

Array [

value number

Value of the aggregate data.

view object

View the aggregate date.

]

field string

Field

name string

The name of the query response.

operator string

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

Operator

statistic string

QoS application aggregate statistics.

unit string

The unit.

dest_page int32

The destination page.

getDeleted boolean

The number sites deleted for a time frame.

group_by string[]

Group By

id string

List the sites 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

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 SiteQueryFilterV4N8[]
Array [
address Address
The address of the site.
city string
The name of the city. Max size = 100.
country string
The name of the country. Max size = 100.
post_code string
The postal code. Max size = 100.
state string
The name of the state. Max size = 100.
street string
The name of the street. Max size = 100.
street2 string
The name of the street. Max size = 100.
admin_state stringrequired
The site mode of operation, can be in one of three states: Active - the site is in Control mode and network policy is applied. Monitor - the site is in Analytics mode, no network policy is applied. Disabled: the site is disabled.
description
Description for the site (Max size = 1024).
element_cluster_role stringrequired
This attribute describes the type i.e. SPOKE or HUB.
extended_tags ExtendedTag[]
Extended tags allow operators to add more information into the site object. Current extended tags allow for additional configuration related to Prisma Access and ZScaler to be added.
Array [
key string
Key
value string
Value
value_type string
Value Type
]
id string
The ID.
location Location
The geographical cordinates for the site address.
description
The decsription of the location.
latitude float
The latitude of the location. Max range = 90.
longitude float
The longitude of the location. Max range = 180.
multicast_peer_group_id string
The multicast peer group ID.
name stringrequired
The site name (Max size = 128).
nat_policysetstack_id string
ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack API.
network_policysetstack_id string
ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack API.
policy_set_id string
The ID for the Original Network Policy Set. Can be retrieved using policysets API.
priority_policysetstack_id string
ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack API.
security_policyset_id string
Security Policyset Id
security_policysetstack_id string
ID for the Security Policyset Stack. Can be retrieved using ngfwpolicysetstack API.
service_binding string
Bind a site to a set of domains. Can be retrieved using sericebindingmaps API.
tags string[]
A information field that can be added to identify the site.
vrf_context_profile_id string
The VRF (Virtual Routing and Forwarding) profile ID.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "address": {
        "city": "string",
        "country": "string",
        "post_code": "string",
        "state": "string",
        "street": "string",
        "street2": "string"
      },
      "admin_state": "string",
      "element_cluster_role": "string",
      "extended_tags": [
        {
          "key": "string",
          "value": "string",
          "value_type": "string"
        }
      ],
      "id": "string",
      "location": {
        "latitude": 0,
        "longitude": 0
      },
      "multicast_peer_group_id": "string",
      "name": "string",
      "nat_policysetstack_id": "string",
      "network_policysetstack_id": "string",
      "policy_set_id": "string",
      "priority_policysetstack_id": "string",
      "security_policyset_id": "string",
      "security_policysetstack_id": "string",
      "service_binding": "string",
      "tags": [
        "string"
      ],
      "vrf_context_profile_id": "string"
    }
  ]
}

Loading...