Edge Get Edge Sdwan Peers

Edge Get Edge Sdwan Peers

Gets an edge's SD-WAN peers that have established paths. Optionally, use a filter object to limit the number of SD-WAN peers returned. Additionally, specify a time interval with an interval object. If no end date is specified, then the default is the current date. The enterpriseId property is required when this method is invoked in the operator context.

Privileges required:

READ EDGE

Request
URI
POST
https://{api_host}/portal/rest/edge/getEdgeSDWANPeers
COPY
Request Body

Show optional properties

{
    "edgeId": 0
}
{
    "edgeId": 0,
    "enterpriseId": 0,
    "interval": {
        "end": "string",
        "start": "string"
    },
    "quickSearch": "quick_search Object",
    "filters": "get_edge_sdwan_peers_filters Object",
    "limit": 0,
    "sortBy": "api_sorting Object",
    "_count": false,
    "_filterSpec": false
}
integer
edgeId
Required

edgeId

integer
enterpriseId
Optional

enterpriseId

interval
interval
Optional

interval

quick_search
quickSearch
Optional

quickSearch

get_edge_sdwan_peers_filters
filters
Optional

filters

integer
limit
Optional
Constraints: default: 2048

limit

api_sorting
sortBy
Optional

sortBy

boolean
_count
Optional

_count

boolean
_filterSpec
Optional

_filterSpec

Responses
200

Request was successfully processed

[
    "edge_get_edge_sdwan_peers_result_item Object"
]
array of edge_get_edge_sdwan_peers_result_item
Optional

400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"edgeId:"integer"}' https://{api_host}/portal/rest/edge/getEdgeSDWANPeers
On This Page
Edge Operations
POST
Edge Edge Cancel Reactivation
POST
Edge Edge Provision
POST
Edge Edge Request Reactivation
POST
Edge Get Client Visibility Mode
POST
Edge Get Edge
POST
Edge Get Edge Configuration Modules
POST
Edge Get Edge Configuration Stack
POST
Edge Get Edge Sdwan Peers
POST
Edge Update Edge Admin Password
POST
Edge Update Edge Attributes
POST
Edge Update Edge Credentials By Configuration