Skip to main content

Query DB for Site WAN Interfaces (v2.9)

POST 

/v2.9/api/tenants/:tenant_id/waninterfaces/query

Query the DB for site WAN interfaces that match query parameters.

Request

Path Parameters

    tenant_id stringrequired

    The tenant ID.

Body

    aggregate Aggregate

    The aggregate number of app defs that match the query parameters.

    data AggregateData[]

    The details of the aggregate data.

  • Array [
  • value number

    Value of the aggregate data.

    view object

    View the aggregate date.

  • ]
  • field string

    Field

    name string

    The name of the query response.

    operator string

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

    Operator

    statistic string

    QoS application aggregate statistics.

    unit string

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number app definitions deleted for a time frame.

    group_by string[]

    Group By

    id string

    List the app definitions 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 actual count.

    deleted_count int64

    The deleted number.

    deleted_ids string[]

    The deleted IDs.

    description

    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 WANInterfaceQueryFilterV2N9[]
  • Array [
  • bfd_mode stringrequired

    Possible values: [aggressive, non_aggressive]

    Allowed values: aggressive - For fast failure detection of links. This mode is the default mode and is recommended by Prisma SD-WAN. non_aggressive - when you want to reduce the amount of probe traffic, or for links that are subjected to high loss or poor quality.

    bw_config_mode stringrequired

    Possible values: [auto, manual, manual_bwm_disabled]

    The bandwidth config mode.

    bwc_enabled boolean

    Bwc Enabled

    cost integer

    Cost value for the site WAN interface should be within range 0-1024.

    description

    The description of the WAN interface config (size max = 256).

    id string

    The ID.

    l3_reachability WANL3Reachability

    The WAN L3 reachability information.

    probe_config_ids string[]

    The probe configuration IDs.

    use_element_default boolean

    The default element used.

    label_id stringrequired

    The WAN interface label or Circuit label ID. This can be retrieved using the waninterfacelabels API.

    link_bw_down double

    The circuit downstream capacity in MB.

    link_bw_up double

    The circuit upstream capacity in MB.

    lqm_config LQMConfig

    The link quality monitoring parameters.

    hub_site_ids string[]

    List of DC Site IDs.

    inter_packet_gap int32

    Allowed values: 50-300 milliseconds.

    statistic string

    Possible values: [min, max, avg]

    WAN interface LQM config statistics.

    lqm_enabled boolean

    The link quality monitoring parameters.

    name string

    The name of the WAN interface config (size max = 128).

    network_id stringrequired

    The network ID.

    probe_profile_id string

    The probe profile ID.

    site_id stringrequired

    Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) NotNull

    tags string[]

    An information field that can be added to identify the application. Maximum 10 Unique tags of length 1024 each are allowed.

    type string

    Possible values: [PUBLIC_WAN, PRIVATE_WAN]

    Type of WAN.

    use_for_application_reachability_probes boolean

    Indicates if the use for application reachability probe is selected.

    use_for_controller_connections boolean

    Indicates if the use for controller connections is selected.

    use_lqm_for_non_hub_paths boolean

    Indicates if the use for lqm for non hub paths is enabled.

    vpnlink_configuration VPNLinkConfiguration

    The configuration of the VPN link.

    keep_alive_failure_count integerrequired

    The VPN keep alive failure count (must be between 3 and 30).

    keep_alive_interval integerrequired

    The VPN keep alive timeout interval (must be between 100ms-1740,000ms).

  • ]
Loading...