Extreme Networks Alert API
ExtremeCloud IQ generated alerts and events
Extreme Networks Alert API is one of 52 APIs that Extreme Networks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Alert. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 35 operations across 21 paths, and defines 43 schemas. It is described by OpenAPI 3.0.3, at version 25.9.0-36.
Requests are made against a single base URL, https://api.extremecloudiq.com.
35 operations
21 paths
43 schemas
4 DELETE13 GET1 PATCH12 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Extreme Networks Alert API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (BearerAuth).
BearerAuth— JSON Web Token (JWT) based authentication
Paths & Operations 35
Across 21 paths, the API surfaces 35 operations — 4 DELETE, 13 GET, 1 PATCH, 12 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
Alert 35
ExtremeCloud IQ generated alerts and events
GET
/alerts
List the alerts
POST
/alerts/:acknowledge
Acknowledge the alerts
GET
/alerts/count-by-{group}
Count the alerts by different grouping
POST
/alerts/reports
[LRO] Create alert event report
GET
/alerts/reports/{id}
Download an alert event report
GET
/alert-subscriptions/emails
List email subscriptions
POST
/alert-subscriptions/emails
Create email subscription
POST
/alert-subscriptions/emails/:delete
[LRO] Delete alert subscription email in bulk
GET
/alert-subscriptions/emails/{id}
Get email subscription info for a specific email
PUT
/alert-subscriptions/emails/{id}
Update email subscription
DELETE
/alert-subscriptions/emails/{id}
Delete email subscription
POST
/alert-subscriptions/emails/{id}/:verify
External email address verification
GET
/alert-subscriptions/webhooks
List webhook subscriptions
POST
/alert-subscriptions/webhooks
Create webhook subscription
POST
/alert-subscriptions/webhooks/:delete
[LRO] Delete alert subscription webhook in bulk
GET
/alert-subscriptions/webhooks/{id}
Get webhook subscription info for a specific url
PUT
/alert-subscriptions/webhooks/{id}
Update webhook subscription
DELETE
/alert-subscriptions/webhooks/{id}
Delete webhook subscription
GET
/alert-subscriptions/servicenow
List ServiceNow subscriptions
POST
/alert-subscriptions/servicenow
Create ServiceNow subscription
POST
/alert-subscriptions/servicenow/:delete
Delete alert ServiceNow subscription in bulk
GET
/alert-subscriptions/servicenow/{id}
Get a specific ServiceNow subscription
PUT
/alert-subscriptions/servicenow/{id}
Update ServiceNow subscription
PATCH
/alert-subscriptions/servicenow/{id}
Partial or full update ServiceNow subscription
DELETE
/alert-subscriptions/servicenow/{id}
Delete ServiceNow subscription
GET
/alert-policies
List all alert policies
POST
/alert-policies
Create a site based alert policy
GET
/alert-policies/{policyId}
Get details of an alert policy
PUT
/alert-policies/{policyId}
Update a site-based alert policy
DELETE
/alert-policies/{policyId}
Delete a site-based alert policy
GET
/alert-policies/available-sites
The list of current owner's available sites
GET
/alert-policies/{policyId}/rules/{ruleId}
Get details of an alert rule
PUT
/alert-policies/{policyId}/rules/{ruleId}
Update an alert rule
POST
/alert-policies/{policyId}/rules/{ruleId}/:enable
Enable a rule from an alert policy
POST
/alert-policies/{policyId}/rules/{ruleId}/:disable
Disable a rule from an alert policy
Schemas 43
The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are XiqAlert (20 properties), XiqAlertRule (15 properties), XiqUpdateAlertRuleRequest (8 properties), XiqAlertPolicy (7 properties). Each schema is shown below with its type and property counts.
XiqDeleteBulkAlertSubscriptionEmailResponse
object
The result of a bulk delete for alert email subscriptions.
3 properties
1 required
XiqAlertSortField
string
All available device sort fields TIMESTAMP = Last Detected, SOURCE = Source Name.
XiqAlertReport
object
ExtremeCloud IQ alert report
1 property
XiqSortOrder
string
XiqBulkDeleteWebhookSubscriptionResult
object
The result of bulk delete webhook susbscriptions.
1 property
XiqAlertWebhookSubscription
XiqAlertRuleThresholdOperator
string
Has value when messagemetadatatype is "METRIC". The operator for comparing with the threshold.
PagedXiqAlert
XiqAlertTag
object
The tag for the alert
4 properties
4 required
XiqAlertEmailSubscription
XiqAlert
object
The Alert Model
20 properties
18 required
XiqAlertRuleOverview
object
The overview for an alert rule. Detailed information is available from the get alert rule API.
3 properties
3 required
XiqCreateAlertPolicyRequest
object
The body of a create alert policy request.
2 properties
2 required
XiqBulkDeleteEmailSubscriptionResult
object
The result of bulk detele email susbscriptions.
1 property
XiqErrorParams
object
Error parameters
2 properties
XiqUpdateAlertWebhookSubscriptionRequest
object
The payload to create webhook subscription
5 properties
1 required
XiqCreateAlertEmailSubscriptionRequest
object
The payload to create email subscription
4 properties
3 required
XiqBaseEntity
object
3 properties
3 required
XiqAlertPolicyType
string
All available policy type GLOBAL and SITE.
XiqCreateAlertWebhookSubscriptionRequest
object
The payload to create webhook subscription
5 properties
3 required
XiqAlertServiceNowSubscription
XiqCreateAlertServiceNowSubscriptionRequest
object
The payload to create ServiceNow subscription
4 properties
3 required
XiqError
object
6 properties
3 required
XiqUpdateAlertRuleRequest
object
8 properties
XiqBulkDeleteServiceNowSubscriptionResult
object
The result of bulk delete ServiceNow susbscriptions.
1 property
XiqBulkOperationResult
string
XiqPage
object
4 properties
4 required
XiqAlertSource
object
The alert source info
4 properties
4 required
XiqAlertGroupCount
object
The alert group count information. When the group is SEVERITY, the groupid will be severity ID When the group is CATEGORY, the groupid will be category ID When…
3 properties
3 required
subscriptionIds
object
The filter to get alert subscriptions
1 property
XiqAlertMetricRulesByMetricset
object
A metricset and overviews of the associated metric-based alert rules.
3 properties
3 required
XiqAlertRule
object
The state for a configured alert rule.
15 properties
9 required
XiqDeleteBulkAlertSubscriptionWebhookResponse
object
The result of a bulk delete for alert webhook subscriptions.
3 properties
1 required
XiqAlertSite
object
The site information.
2 properties
2 required
alertIds
object
The request object to acknowledge.
1 property
XiqAlertGroupQuery
string
XiqUpdateAlertEmailSubscriptionRequest
object
The payload to create email subscription
4 properties
1 required
XiqPatchAlertServiceNowSubscriptionRequest
object
The payload to update ServiceNow subscription
4 properties
XiqUpdateAlertServiceNowSubscriptionRequest
object
The payload to update ServiceNow subscription
4 properties
1 required
XiqAlertPolicy
object
The alert policy model. Includes the alert policy and the associated rules.
7 properties
6 required
XiqDeleteBulkAlertSubscriptionServiceNowResponse
object
The result of a bulk delete for alert ServiceNow subscriptions.
3 properties
1 required
XiqUpdateAlertPolicyRequest
object
The request body for updating an alert policy.
2 properties
1 required
XiqAlertEventRulesByCategory
object
A category and overviews of the associated event-based alert rules.
3 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Extreme Networks 12
Other APIs Extreme Networks publishes across the network.
ExtremeCloud IQ Controller REST API Gateway
ExtremeCloud IQ Controller Application Manager API
Ansible Network Collection for Extreme EXOS
Ansible Network Collection for Extreme VOSS
Ansible Network Collection for Extreme SLX-OS
Ansible Network Collection for Extreme NOS
Ansible Network Collection for Extreme Fabric Engine
Extreme Networks Account API
Extreme Networks Administration API
Extreme Networks AFC API
Extreme Networks Application API
Extreme Networks Authentication API
#Alert