Query DB for Site WAN Interfaces (v2.9)
POST/sdwan/v2.9/api/waninterfaces/query
Query the DB for site WAN interfaces that match query parameters.
Request
- application/json
Body
- Array [
- ]
aggregate Aggregate
The aggregate number of app defs that match the query parameters.
data AggregateData[]
The details of the aggregate data.
Value of the aggregate data.
View the aggregate date.
The field value.
The name of the query response.
Possible values: [max
, count
, min
, avg
, sum
]
The operator values.
The aggregate statistics.
The unit.
The destination page.
The number app definitions deleted for a time frame.
Group By
List the app definitions by ID.
Return the ID of a specified query in the current session.
The query limit.
The limit.
Retrieve information from a field.
List the fields to query.
The total number of query parameters.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
The actual count.
The deleted number.
The deleted IDs.
Description of the query. Max size = 256.
The ID.
Details of the next query.
Total number.
items WANInterfaceQueryFilterV2N9[]
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.
Possible values: [auto
, manual
, manual_bwm_disabled
]
The bandwidth config mode.
Bwc Enabled
Cost value for the site WAN interface should be within range 0-1024.
The description of the WAN interface config (size max = 256).
The ID.
l3_reachability WANL3Reachability
The WAN L3 reachability information.
The probe configuration IDs.
The default element used.
The WAN interface label or Circuit label ID. This can be retrieved using the waninterfacelabels API.
The circuit downstream capacity in MB.
The circuit upstream capacity in MB.
lqm_config LQMConfig
The link quality monitoring parameters.
List of DC Site IDs.
Allowed values: 50-300 milliseconds.
Possible values: [min
, max
, avg
]
WAN interface LQM config statistics.
The link quality monitoring parameters.
The name of the WAN interface config (size max = 128).
The network ID.
The probe profile ID.
Site Id: Digits(fraction = 0, integer = 50, SITEID_INVALID) NotNull
An information field that can be added to identify the application. Maximum 10 Unique tags of length 1024 each are allowed.
Possible values: [PUBLIC_WAN
, PRIVATE_WAN
]
Type of WAN.
Indicates if the use for application reachability probe is selected.
Indicates if the use for controller connections is selected.
Indicates if the use for lqm for non hub paths is enabled.
vpnlink_configuration VPNLinkConfiguration
The configuration of the VPN link.
The VPN keep alive failure count (must be between 3 and 30).
The VPN keep alive timeout interval (must be between 100ms-1740,000ms).
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"total_count": 0,
"items": [
{
"bfd_mode": "aggressive",
"bw_config_mode": "auto",
"bwc_enabled": true,
"cost": 0,
"id": "string",
"l3_reachability": {
"probe_config_ids": [
"string"
],
"use_element_default": true
},
"label_id": "string",
"link_bw_down": 0,
"link_bw_up": 0,
"lqm_config": {
"hub_site_ids": [
"string"
],
"inter_packet_gap": 0,
"statistic": "min"
},
"lqm_enabled": true,
"name": "string",
"network_id": "string",
"probe_profile_id": "string",
"site_id": "string",
"tags": [
"string"
],
"type": "PUBLIC_WAN",
"use_for_application_reachability_probes": true,
"use_for_controller_connections": true,
"use_lqm_for_non_hub_paths": true,
"vpnlink_configuration": {
"keep_alive_failure_count": 0,
"keep_alive_interval": 0
}
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
The error code.
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "BAD_REQUEST"
}
]
}
}