Skip to main content

Query DB for sites (v4.10)

POST 

https://api.us.cloudgenix.com/v4.10/api/tenants/:tenant_id/sites/query

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

Request

Path Parameters

    tenant_id stringrequired

    ID of the tenant.

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 [
  • valuenumber

    Value of the aggregate data.

    viewobject

    View the aggregate date.

  • ]
  • fieldstring

    Field

    namestring

    The name of the query response.

    operatorstring

    Operator

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

    statisticstring

    QoS application aggregate statistics.

    unitstring

    The unit.

    dest_pageint32

    The destination page.

    getDeletedboolean

    The number sites deleted for a time frame.

    group_bystring[]

    Group By

    idstring

    List the sites by ID.

    last_query_tsint64

    Return the ID of a specified query in the current session.

    limitint32

    The query limit.

    next_queryobject

    The limit.

    query_paramsobject
    retrieved_fieldsstring[]

    Retrieve information from a field.

    retrieved_fields_maskboolean

    List the fields to query.

    sort_paramsobject
    total_countint64

    The total number of query parameters.

Responses

Successful Operation

Schema
    countint32

    The actual count.

    deleted_countint64

    The deleted number.

    deleted_idsstring[]

    The deleted IDs.

    description

    Description of the query. Max size = 256.

    idstring

    The ID.

    next_queryobject

    Details of the next query.

    tenant_idstring

    The tenant ID.

    total_countint64

    Total number.

    items SiteQueryFilterV4N10[]
  • Array [
  • address Address

    The address of the site.

    citystring

    The name of the city. Max size = 100.

    countrystring

    The name of the country. Max size = 100.

    post_codestring

    The postal code. Max size = 100.

    statestring

    The name of the state. Max size = 100.

    streetstring

    The name of the street. Max size = 100.

    street2string

    The name of the street. Max size = 100.

    admin_statestringrequired

    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.

    branch_gatewayboolean

    Branch gateway enabled or not.

    description

    Description for the site (Max size = 1024).

    element_cluster_rolestringrequired

    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 [
  • keystring

    Key

    valuestring

    Value

    value_typestring

    Value Type

  • ]
  • idstring

    The ID.

    location Location

    The geographical cordinates for the site address.

    description

    The decsription of the location.

    latitudefloat

    The latitude of the location. Max range = 90.

    longitudefloat

    The longitude of the location. Max range = 180.

    multicast_peer_group_idstring

    The multicast peer group ID.

    namestringrequired

    The site name (Max size = 128).

    nat_policysetstack_idstring

    ID for the NAT Policyset Stack. Can be retrieved using natpolicysetstack API.

    network_policysetstack_idstring

    ID for the Path Policyset Stack. Can be retrieved using networkpolicysetstack API.

    perfmgmt_policysetstack_idstring

    ID for the Performance Policyset Stack.

    policy_set_idstring

    The ID for the Original Network Policy Set. Can be retrieved using policysets API.

    prefer_lan_default_over_wan_default_routeboolean

    Prefer Lan Default Over Wan Default Route

    priority_policysetstack_idstring

    ID for the QoS Policyset Stack. Can be retrieved using prioritypolicysetstack API.

    security_policyset_idstring

    The ID for the Original Security Policy Set. Can be retrieved using securitypolicysets API.

    security_policysetstack_idstring

    ID for the Security Policyset Stack. Can be retrieved using ngfwpolicysetstack API.

    service_bindingstring

    Bind a site to a set of domains. Can be retrieved using sericebindingmaps API.

    tagsstring[]

    A information field that can be added to identify the site.

    vrf_context_profile_idstring

    The VRF (Virtual Routing and Forwarding) profile ID.

  • ]
curl -L 'https://api.us.cloudgenix.com/v4.10/api/tenants/:tenant_id/sites/query' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"aggregate": {
"data": [
{
"value": 0,
"view": {}
}
],
"field": "string",
"name": "string",
"operator": "max",
"statistic": "string",
"unit": "string"
},
"dest_page": 0,
"getDeleted": true,
"group_by": [
"string"
],
"id": "string",
"last_query_ts": 0,
"limit": 0,
"next_query": {},
"query_params": {},
"retrieved_fields": [
"string"
],
"retrieved_fields_mask": true,
"sort_params": {},
"total_count": 0
}'
Request Collapse all
Base URL
https://api.us.cloudgenix.com
Parameters
— pathrequired
Body
{
  "aggregate": {
    "data": [
      {
        "value": 0,
        "view": {}
      }
    ],
    "field": "string",
    "name": "string",
    "operator": "max",
    "statistic": "string",
    "unit": "string"
  },
  "dest_page": 0,
  "getDeleted": true,
  "group_by": [
    "string"
  ],
  "id": "string",
  "last_query_ts": 0,
  "limit": 0,
  "next_query": {},
  "query_params": {},
  "retrieved_fields": [
    "string"
  ],
  "retrieved_fields_mask": true,
  "sort_params": {},
  "total_count": 0
}
ResponseClear

Click the Send API Request button above and see the response here!