Query DB for sites (v4.10)
POSThttps://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.
- application/json
Body
Query Details for the site
aggregate Aggregate
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
- 200
Successful Operation
- application/json
- Schema
- Example (auto)
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[]
{
"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",
"branch_gateway": true,
"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",
"perfmgmt_policysetstack_id": "string",
"policy_set_id": "string",
"prefer_lan_default_over_wan_default_route": true,
"priority_policysetstack_id": "string",
"security_policyset_id": "string",
"security_policysetstack_id": "string",
"service_binding": "string",
"tags": [
"string"
],
"vrf_context_profile_id": "string"
}
]
}
- curl
- python
- go
- nodejs
- csharp
- php
- CURL
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
}'
ResponseClear