Monitoring Get Vpn Site Status

Monitoring Get Vpn Site Status

Retrieves the VPN site statusfor a specified linkId, edgeId, segmentObjectId, and networkServiceIdOn success, this method returns an array ofVPN site statuses objects for all requested params

Privileges required:

READ ENTERPRISE_EVENT

READ NETWORK_SERVICE

Request
URI
POST
https://{api_host}/portal/rest/monitoring/getVPNSiteStatus
COPY
Request Body
{
    "segmentObjectId": 0,
    "edgeId": 0,
    "providerObjectId": 0,
    "linkInternalId": "string"
}
integer
segmentObjectId
Required

segmentObjectId

integer
edgeId
Required

edgeId

integer
providerObjectId
Required

providerObjectId

string
linkInternalId
Required

linkInternalId

Responses
200

Request was successfully processed

Returns monitoring_vpn_site_status_result of type(s) application/json 
{
    "data": [
        {
            "id": 0,
            "action": "string",
            "status": 0,
            "statusMsg": "string",
            "edgeId": 0,
            "providerId": 0
        }
    ],
    "metaData": {
        "limit": 0,
        "more": false
    }
}
array of object
data
Optional

data

object
metaData
Optional

metaData


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 '{"segmentObjectId:"integer","edgeId:"integer","providerObjectId:"integer","linkInternalId:"string"}' https://{api_host}/portal/rest/monitoring/getVPNSiteStatus
On This Page
All Operations
POST
Monitoring Get Aggregate Edge Link Metrics
POST
Monitoring Get Aggregate Enterprise Events
POST
Monitoring Get Aggregates
POST
Monitoring Get Enterprise Aggregate Edge Nvs Tunnel Status
POST
Monitoring Get Enterprise Bgp Peer Status
POST
Monitoring Get Enterprise Edge Bfd Peer Status
POST
Monitoring Get Enterprise Edge Bgp Peer Status
POST
Monitoring Get Enterprise Edge Cluster Status
POST
Monitoring Get Enterprise Edge Link Status
POST
Monitoring Get Enterprise Edge Nvs Tunnel Status
POST
Monitoring Get Enterprise Edge Status
POST
Monitoring Get Network Gateway Status
POST
Monitoring Get Vpn Edge Action Status
POST
Monitoring Get Vpn Site Status
POST
Monitoring Get Wss Location Creation Status