Skip to main content

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.

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


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.

  • ]
Loading...