Skip to main content

Query DB for Number of Network Contexts (v2.1)



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


Path Parameters

    tenant_id stringrequired

    ID of the tenant.


Query Details for Path Group

    aggregate Aggregate

    The aggregate number of queries.

    data AggregateData[]

    The details of the aggregate data.

  • Array [
  • value number

    Value of the aggregate data.

    view object

    View the aggregate date.

  • ]
  • field string


    name string

    The name of the query response.

    operator string

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


    statistic string

    QoS application aggregate statistics.

    unit string

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number of queries deleted for a time frame.

    group_by string[]

    Group By

    id string

    The multicast 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.


Successful Operation

    count int32

    The actual count.

    deleted_count int64

    The deleted number.

    deleted_ids string[]

    The deleted IDs.


    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 PathGroupQueryFilter[]
  • Array [
  • description

    The description of the path group. Max length 256.

    id string

    The ID of the path group.

    name string

    The name of the path group. Max length 128.

    paths WANPath[]required

    List of paths in the group.

  • Array [
  • label string

    The label to identify the path.

    path_type stringrequired

    Possible values: [vpn, direct, servicelink]

    The path type.

  • ]
  • ]