Get Enterprise Alerts
Fetch past triggered alerts for the specified enterprise
Request
URI
GET
https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/alerts
COPY
Path Parameters
string
enterpriseLogicalId
Required
The logicalId GUID for the target enterprise
Query Parameters
integer
start
Optional
Query interval start time represented as a 13-digit, millisecond-precision epoch timestamp.
integer
end
Optional
Query interval end time represented as a 13-digit, millisecond-precision epoch timestamp.
integer,null
limit
Optional
Limits the maximum size of the result set.
string
nextPageLink
Optional
A nextPageLink value, as fetched via a past call to a list API method. When a nextPageLink value is specified, any other query parameters that may ordinarily be used to sort or filter the result set are ignored.
string
prevPageLink
Optional
A prevPageLink value, as fetched via a past call to a list API method. When a prevPageLink value is specified, any other query parameters that may ordinarily be used to sort or filter the result set are ignored.
string
include
Optional
A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.
string
edgeName[contains]
Optional
Filter by edgeName[contains]
string
edgeName[notContains]
Optional
Filter by edgeName[notContains]
string
linkName[contains]
Optional
Filter by linkName[contains]
string
linkName[notContains]
Optional
Filter by linkName[notContains]
string
type[is]
Optional
Filter by type[is]
Possible values are : EDGE_DOWN, EDGE_UP, LINK_DOWN, LINK_UP, VPN_TUNNEL_DOWN, EDGE_HA_FAILOVER, EDGE_SERVICE_DOWN, GATEWAY_SERVICE_DOWN, VNF_VM_EVENT, VNF_VM_DEPLOYED, VNF_VM_POWERED_ON, VNF_VM_POWERED_OFF, VNF_VM_DEPLOYED_AND_POWERED_OFF, VNF_VM_DELETED, VNF_VM_ERROR, VNF_INSERTION_EVENT, VNF_INSERTION_ENABLED, VNF_INSERTION_DISABLED, TEST_ALERT, EDGE_CSS_TUNNEL_DOWN, EDGE_CSS_TUNNEL_UP, NVS_FROM_EDGE_TUNNEL_DOWN, NVS_FROM_EDGE_TUNNEL_UP, VNF_IMAGE_DOWNLOAD_EVENT, VNF_IMAGE_DOWNLOAD_IN_PROGRESS, VNF_IMAGE_DOWNLOAD_COMPLETED, VNF_IMAGE_DOWNLOAD_FAILED, PGW_NNI_INTERFACE_UP, PGW_NNI_INTERFACE_DOWN, PGW_NNI_BGP_ENABLED, PGW_NNI_BGP_DISABLED, EDGE_HA_FAILED,
string
type[isNot]
Optional
Filter by type[isNot]
Possible values are : EDGE_DOWN, EDGE_UP, LINK_DOWN, LINK_UP, VPN_TUNNEL_DOWN, EDGE_HA_FAILOVER, EDGE_SERVICE_DOWN, GATEWAY_SERVICE_DOWN, VNF_VM_EVENT, VNF_VM_DEPLOYED, VNF_VM_POWERED_ON, VNF_VM_POWERED_OFF, VNF_VM_DEPLOYED_AND_POWERED_OFF, VNF_VM_DELETED, VNF_VM_ERROR, VNF_INSERTION_EVENT, VNF_INSERTION_ENABLED, VNF_INSERTION_DISABLED, TEST_ALERT, EDGE_CSS_TUNNEL_DOWN, EDGE_CSS_TUNNEL_UP, NVS_FROM_EDGE_TUNNEL_DOWN, NVS_FROM_EDGE_TUNNEL_UP, VNF_IMAGE_DOWNLOAD_EVENT, VNF_IMAGE_DOWNLOAD_IN_PROGRESS, VNF_IMAGE_DOWNLOAD_COMPLETED, VNF_IMAGE_DOWNLOAD_FAILED, PGW_NNI_INTERFACE_UP, PGW_NNI_INTERFACE_DOWN, PGW_NNI_BGP_ENABLED, PGW_NNI_BGP_DISABLED, EDGE_HA_FAILED,
string
type[in]
Optional
Filter by type[in]
Possible values are : EDGE_DOWN, EDGE_UP, LINK_DOWN, LINK_UP, VPN_TUNNEL_DOWN, EDGE_HA_FAILOVER, EDGE_SERVICE_DOWN, GATEWAY_SERVICE_DOWN, VNF_VM_EVENT, VNF_VM_DEPLOYED, VNF_VM_POWERED_ON, VNF_VM_POWERED_OFF, VNF_VM_DEPLOYED_AND_POWERED_OFF, VNF_VM_DELETED, VNF_VM_ERROR, VNF_INSERTION_EVENT, VNF_INSERTION_ENABLED, VNF_INSERTION_DISABLED, TEST_ALERT, EDGE_CSS_TUNNEL_DOWN, EDGE_CSS_TUNNEL_UP, NVS_FROM_EDGE_TUNNEL_DOWN, NVS_FROM_EDGE_TUNNEL_UP, VNF_IMAGE_DOWNLOAD_EVENT, VNF_IMAGE_DOWNLOAD_IN_PROGRESS, VNF_IMAGE_DOWNLOAD_COMPLETED, VNF_IMAGE_DOWNLOAD_FAILED, PGW_NNI_INTERFACE_UP, PGW_NNI_INTERFACE_DOWN, PGW_NNI_BGP_ENABLED, PGW_NNI_BGP_DISABLED, EDGE_HA_FAILED,
string
type[notIn]
Optional
Filter by type[notIn]
Possible values are : EDGE_DOWN, EDGE_UP, LINK_DOWN, LINK_UP, VPN_TUNNEL_DOWN, EDGE_HA_FAILOVER, EDGE_SERVICE_DOWN, GATEWAY_SERVICE_DOWN, VNF_VM_EVENT, VNF_VM_DEPLOYED, VNF_VM_POWERED_ON, VNF_VM_POWERED_OFF, VNF_VM_DEPLOYED_AND_POWERED_OFF, VNF_VM_DELETED, VNF_VM_ERROR, VNF_INSERTION_EVENT, VNF_INSERTION_ENABLED, VNF_INSERTION_DISABLED, TEST_ALERT, EDGE_CSS_TUNNEL_DOWN, EDGE_CSS_TUNNEL_UP, NVS_FROM_EDGE_TUNNEL_DOWN, NVS_FROM_EDGE_TUNNEL_UP, VNF_IMAGE_DOWNLOAD_EVENT, VNF_IMAGE_DOWNLOAD_IN_PROGRESS, VNF_IMAGE_DOWNLOAD_COMPLETED, VNF_IMAGE_DOWNLOAD_FAILED, PGW_NNI_INTERFACE_UP, PGW_NNI_INTERFACE_DOWN, PGW_NNI_BGP_ENABLED, PGW_NNI_BGP_DISABLED, EDGE_HA_FAILED,
string
state[is]
Optional
Filter by state[is]
Possible values are : PENDING, ACTIVE, CLOSED,
string
state[isNot]
Optional
Filter by state[isNot]
Possible values are : PENDING, ACTIVE, CLOSED,
string
state[in]
Optional
Filter by state[in]
Possible values are : PENDING, ACTIVE, CLOSED,
string
state[notIn]
Optional
Filter by state[notIn]
Possible values are : PENDING, ACTIVE, CLOSED,
number
enterpriseAlertConfigurationId[isNull]
Optional
Filter by enterpriseAlertConfigurationId[isNull]
number
enterpriseAlertConfigurationId[isNotNull]
Optional
Filter by enterpriseAlertConfigurationId[isNotNull]
Responses
200
Request successfully processed
Returns EnterpriseAlertsSchema of type(s) application/json
{
"_href": "string",
"data": [
{
"_href": "string",
"created": "string",
"triggerTime": "string",
"edge": {
"_href": "string",
"activationKey": "string",
"activationKeyExpires": "string",
"activationState": "string",
"activationTime": "string",
"alertsEnabled": false,
"bastionState": "string",
"buildNumber": "string",
"created": "string",
"customInfo": "string",
"description": "string",
"deviceFamily": "string",
"deviceId": "string",
"dnsName": "string",
"edgeState": "string",
"edgeStateTime": "string",
"endpointPkiMode": "string",
"factoryBuildNumber": "string",
"factorySoftwareVersion": "string",
"platformBuildNumber": "string",
"platformFirmwareVersion": "string",
"modemBuildNumber": "string",
"modemFirmwareVersion": "string",
"lteRegion": "string",
"haLastContact": "string",
"haPreviousState": "string",
"haSerialNumber": "string",
"haState": "string",
"isLive": false,
"lastContact": "string",
"logicalId": "string",
"modelNumber": "string",
"modified": "string",
"name": "string",
"operatorAlertsEnabled": false,
"selfMacAddress": "string",
"serialNumber": "string",
"serviceState": "string",
"serviceUpSince": "string",
"softwareUpdated": "string",
"softwareVersion": "string",
"systemUpSince": "string",
"links": [
{
"_href": "string",
"created": "string",
"logicalId": "string",
"internalId": "string",
"interface": "string",
"macAddress": "string",
"ipAddress": "string",
"ipV6Address": "string",
"netmask": "string",
"networkSide": "string",
"networkType": "string",
"displayName": "string",
"userOverride": false,
"isp": "string",
"org": "string",
"lat": "number",
"lon": "number",
"lastActive": "string",
"state": "string",
"backupState": "string",
"linkMode": "string",
"lastEvent": "string",
"lastEventState": "string",
"alertsEnabled": false,
"operatorAlertsEnabled": false,
"serviceState": "string",
"modified": "string"
}
],
"site": {
"_href": "string",
"created": "string",
"name": "string",
"contactName": "string",
"contactPhone": "string",
"contactMobile": "string",
"contactEmail": "string",
"streetAddress": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"lat": "number",
"lon": "number",
"timezone": "string",
"locale": "string",
"shippingSameAsLocation": false,
"shippingContactName": "string",
"shippingAddress": "string",
"shippingAddress2": "string",
"shippingCity": "string",
"shippingState": "string",
"shippingCountry": "string",
"shippingPostalCode": "string",
"modified": "string"
},
"enterprise": {
"_href": "string",
"created": "string",
"alertsEnabled": false,
"operatorAlertsEnabled": false,
"endpointPkiMode": "string",
"name": "string",
"domain": "string",
"prefix": "string",
"logicalId": "string",
"accountNumber": "string",
"description": "string",
"contactName": "string",
"contactPhone": "string",
"contactMobile": "string",
"contactEmail": "string",
"streetAddress": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"lat": "number",
"lon": "number",
"timezone": "string",
"locale": "string",
"modified": "string",
"gatewayPool": {
"_href": "string"
},
"bastionState": "string"
},
"haMode": "string",
"standbySystemUpSince": "string",
"standbyServiceUpSince": "string",
"standbySoftwareVersion": "string",
"standbyFactorySoftwareVersion": "string",
"standbyFactoryBuildNumber": "string",
"standbyBuildNumber": "string",
"standbyModelNumber": "string",
"standbyDeviceId": "string"
},
"link": {
"_href": "string",
"created": "string",
"logicalId": "string",
"internalId": "string",
"interface": "string",
"macAddress": "string",
"ipAddress": "string",
"ipV6Address": "string",
"netmask": "string",
"networkSide": "string",
"networkType": "string",
"displayName": "string",
"userOverride": false,
"isp": "string",
"org": "string",
"lat": "number",
"lon": "number",
"lastActive": "string",
"state": "string",
"backupState": "string",
"linkMode": "string",
"lastEvent": "string",
"lastEventState": "string",
"alertsEnabled": false,
"operatorAlertsEnabled": false,
"serviceState": "string",
"modified": "string",
"edge": {
"_href": "string",
"activationKey": "string",
"activationKeyExpires": "string",
"activationState": "string",
"activationTime": "string",
"alertsEnabled": false,
"bastionState": "string",
"buildNumber": "string",
"created": "string",
"customInfo": "string",
"description": "string",
"deviceFamily": "string",
"deviceId": "string",
"dnsName": "string",
"edgeState": "string",
"edgeStateTime": "string",
"endpointPkiMode": "string",
"factoryBuildNumber": "string",
"factorySoftwareVersion": "string",
"platformBuildNumber": "string",
"platformFirmwareVersion": "string",
"modemBuildNumber": "string",
"modemFirmwareVersion": "string",
"lteRegion": "string",
"haLastContact": "string",
"haPreviousState": "string",
"haSerialNumber": "string",
"haState": "string",
"isLive": false,
"lastContact": "string",
"logicalId": "string",
"modelNumber": "string",
"modified": "string",
"name": "string",
"operatorAlertsEnabled": false,
"selfMacAddress": "string",
"serialNumber": "string",
"serviceState": "string",
"serviceUpSince": "string",
"softwareUpdated": "string",
"softwareVersion": "string",
"systemUpSince": "string",
"links": [
{
"_href": "string",
"created": "string",
"logicalId": "string",
"internalId": "string",
"interface": "string",
"macAddress": "string",
"ipAddress": "string",
"ipV6Address": "string",
"netmask": "string",
"networkSide": "string",
"networkType": "string",
"displayName": "string",
"userOverride": false,
"isp": "string",
"org": "string",
"lat": "number",
"lon": "number",
"lastActive": "string",
"state": "string",
"backupState": "string",
"linkMode": "string",
"lastEvent": "string",
"lastEventState": "string",
"alertsEnabled": false,
"operatorAlertsEnabled": false,
"serviceState": "string",
"modified": "string"
}
],
"site": {
"_href": "string",
"created": "string",
"name": "string",
"contactName": "string",
"contactPhone": "string",
"contactMobile": "string",
"contactEmail": "string",
"streetAddress": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"country": "string",
"postalCode": "string",
"lat": "number",
"lon": "number",
"timezone": "string",
"locale": "string",
"shippingSameAsLocation": false,
"shippingContactName": "string",
"shippingAddress": "string",
"shippingAddress2": "string",
"shippingCity": "string",
"shippingState": "string",
"shippingCountry": "string",
"shippingPostalCode": "string",
"modified": "string"
},
"enterprise": {
"_href": "string",
"created": "string",
"alertsEnabled": false,
"operatorAlertsEnabled": false,
"endpointPkiMode": "string",
"name": "string",
"domain": "string",
"prefix": "string",
"logicalId": "string",
"accountNumber": "string",
"description": "string",
"contactName": "string",
"contactPhone": "string",
"contactMobile": "string",
"contactEmail": "string",
"streetAddress": "string",
"streetAddress2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string",
"lat": "number",
"lon": "number",
"timezone": "string",
"locale": "string",
"modified": "string",
"gatewayPool": {
"_href": "string"
},
"bastionState": "string"
},
"haMode": "string",
"standbySystemUpSince": "string",
"standbyServiceUpSince": "string",
"standbySoftwareVersion": "string",
"standbyFactorySoftwareVersion": "string",
"standbyFactoryBuildNumber": "string",
"standbyBuildNumber": "string",
"standbyModelNumber": "string",
"standbyDeviceId": "string"
}
},
"name": "string",
"type": "string",
"state": "string",
"stateSetTime": "string",
"lastContact": "string",
"firstNotificationSeconds": 0,
"maxNotifications": 0,
"notificationIntervalSeconds": 0,
"resetIntervalSeconds": 0,
"comment": "string",
"nextNotificationTime": "string",
"remainingNotifications": 0,
"timezone": "string",
"locale": "string",
"modified": "string",
"notifications": [
{
"created": "string",
"enterpriseUserList": [
{
"email": "string",
"emailEnabled": 0,
"enabled": 0,
"mobileEnabled": 0,
"mobilePhone": "string",
"smsEnabled": 0,
"username": "string"
}
],
"smsEnabled": "number",
"smsList": "string",
"smsText": "string",
"emailEnabled": "number",
"emailList": "string",
"emailText": "string",
"mobileEnabled": "number",
"mobileList": "string",
"mobileText": "string",
"snmpEnabled": "number",
"snmpList": "string",
"modified": "string"
}
]
}
],
"metaData": {
"prevPageLink": "string",
"nextPageLink": "string",
"limit": 0,
"more": false
}
}string
_href
Optional
_href
array of object
data
Optional
data
object
metaData
Optional
metaData
400
ValidationError
Returns ValidationError of type(s) application/json
"ValidationError Object"string
code
Optional
A unique error code
string
property
Optional
The name of the property to which the error applies, if applicable
string
message
Optional
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
string
displayMessage
Optional
A non-technical description of the error condition
string
documentation
Optional
A link to applicable external documentation
array of object
errors
Optional
A list of property-specific errors
401
Unauthorized
Returns UnAuthorized of type(s) application/json
"UnAuthorized Object"string
code
Optional
A unique error code
string
property
Optional
The name of the property to which the error applies, if applicable
string
message
Optional
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
string
displayMessage
Optional
A non-technical description of the error condition
string
documentation
Optional
A link to applicable external documentation
404
Resource not found
Returns ResourceNotFoundError of type(s) application/json
"ResourceNotFoundError Object"string
code
Optional
A unique error code
string
property
Optional
The name of the property to which the error applies, if applicable
string
message
Optional
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
string
displayMessage
Optional
A non-technical description of the error condition
string
documentation
Optional
A link to applicable external documentation
429
Rate Limit Exceeded
Returns RateLimitExceededError of type(s) application/json
"RateLimitExceededError Object"string
code
Optional
A unique error code
string
property
Optional
The name of the property to which the error applies, if applicable
string
message
Optional
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
string
displayMessage
Optional
A non-technical description of the error condition
string
documentation
Optional
A link to applicable external documentation
500
Internal server error
Returns InternalServerError of type(s) application/json
"InternalServerError Object"string
code
Optional
A unique error code
string
property
Optional
The name of the property to which the error applies, if applicable
string
message
Optional
A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution
string
displayMessage
Optional
A non-technical description of the error condition
string
documentation
Optional
A link to applicable external documentation
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/alerts
Monitor Operations
GET
Get Enterprise Alerts