Query DB for Site WAN Interfaces (v2.6)

Queries the DB for Site WAN Interfaces that match the query parameters.

Path Parameters

tenant_id string required
The tenant ID.

application/json

Request Body

aggregate Aggregate
The aggregate number of WAN interfaces 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 WAN interfaces deleted for a time frame.
group_by string[]
Group By
id string
List the WAN interfaces 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

application/json

Schema
Example (from schema)

Schema

count int32
The number of responses.
id string
The ID of the response.
tenant_id string
items WANInterfaceQuery[]
Array [
aggregate Aggregate
The aggregate number of WAN interfaces 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 WAN interfaces deleted for a time frame.
group_by string[]
Group By
id string
List the WAN interfaces 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.
]

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "aggregate": {
        "field": "string",
        "operator": "max"
      },
      "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
    }
  ]
}

Query DB for Site WAN Interfaces (v2.6)​

Query DB for Site WAN Interfaces (v2.6)