How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, 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.

Specification
OpenAPI 3.2.0
API Version
25.9.0-36
Base URL
https://api.extremecloudiq.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

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
listAlerts 12 params → 200default
POST
/alerts/:acknowledge
Acknowledge the alerts
acknowledgeAlerts body → 200default
GET
/alerts/count-by-{group}
Count the alerts by different grouping
countAlertsByGroup 5 params → 200default
POST
/alerts/reports
[LRO] Create alert event report
createAlertReport 12 params → 200default
GET
/alerts/reports/{id}
Download an alert event report
downloadAlertReport 1 param → 200default
GET
/alert-subscriptions/emails
List email subscriptions
listEmailSubscriptions → 200default
POST
/alert-subscriptions/emails
Create email subscription
createEmailSubscription body → 200default
POST
/alert-subscriptions/emails/:delete
[LRO] Delete alert subscription email in bulk
deleteBulkAertSubscriptionEmail body → 200default
GET
/alert-subscriptions/emails/{id}
Get email subscription info for a specific email
getEmailSubscription 1 param → 200default
PUT
/alert-subscriptions/emails/{id}
Update email subscription
updateEmailSubscription 1 param body → 200default
DELETE
/alert-subscriptions/emails/{id}
Delete email subscription
deleteEmailSubscription 1 param → 200default
POST
/alert-subscriptions/emails/{id}/:verify
External email address verification
verifySubscriptionEmail 1 param → 200default
GET
/alert-subscriptions/webhooks
List webhook subscriptions
listWebhookSubscriptions → 200default
POST
/alert-subscriptions/webhooks
Create webhook subscription
createWebhookSubscription body → 200default
POST
/alert-subscriptions/webhooks/:delete
[LRO] Delete alert subscription webhook in bulk
deleteBulkAertSubscriptionWebhook body → 200default
GET
/alert-subscriptions/webhooks/{id}
Get webhook subscription info for a specific url
getWebhookSubscription 1 param → 200default
PUT
/alert-subscriptions/webhooks/{id}
Update webhook subscription
updateWebhookSubscription 1 param body → 200default
DELETE
/alert-subscriptions/webhooks/{id}
Delete webhook subscription
deleteWebhookSubscription 1 param → 200default
GET
/alert-subscriptions/servicenow
List ServiceNow subscriptions
listServiceNowSubscriptions → 200default
POST
/alert-subscriptions/servicenow
Create ServiceNow subscription
createServiceNowSubscription body → 200default
POST
/alert-subscriptions/servicenow/:delete
Delete alert ServiceNow subscription in bulk
deleteBulkAlertSubscriptionServiceNow body → 200default
GET
/alert-subscriptions/servicenow/{id}
Get a specific ServiceNow subscription
getServiceNowSubscription 1 param → 200default
PUT
/alert-subscriptions/servicenow/{id}
Update ServiceNow subscription
updateServiceNowSubscription 1 param body → 200default
PATCH
/alert-subscriptions/servicenow/{id}
Partial or full update ServiceNow subscription
patchServiceNowSubscription 1 param body → 200default
DELETE
/alert-subscriptions/servicenow/{id}
Delete ServiceNow subscription
deleteServiceNowSubscription 1 param → 200default
GET
/alert-policies
List all alert policies
listAlertPolicies 2 params → 200default
POST
/alert-policies
Create a site based alert policy
createAlertPolicy body → 200default
GET
/alert-policies/{policyId}
Get details of an alert policy
getAlertPolicy 1 param → 200default
PUT
/alert-policies/{policyId}
Update a site-based alert policy
updateAlertPolicy 1 param body → 200default
DELETE
/alert-policies/{policyId}
Delete a site-based alert policy
deleteAlertPolicy 1 param → 200default
GET
/alert-policies/available-sites
The list of current owner's available sites
listAvailableSites → 200default
GET
/alert-policies/{policyId}/rules/{ruleId}
Get details of an alert rule
getAlertRule 2 params → 200default
PUT
/alert-policies/{policyId}/rules/{ruleId}
Update an alert rule
updateAlertRule 2 params body → 200default
POST
/alert-policies/{policyId}/rules/{ruleId}/:enable
Enable a rule from an alert policy
enableAlertRule 2 params → 200default
POST
/alert-policies/{policyId}/rules/{ruleId}/:disable
Disable a rule from an alert policy
disableAlertRule 2 params → 200default

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.

XiqAlertSortField
string
All available device sort fields TIMESTAMP = Last Detected, SOURCE = Source Name.
XiqBulkDeleteServiceNowSubscriptionResult
object
The result of bulk delete ServiceNow susbscriptions.
1 property
XiqUpdateAlertServiceNowSubscriptionRequest
object
The payload to update ServiceNow subscription
4 properties 1 required
XiqUpdateAlertEmailSubscriptionRequest
object
The payload to create email subscription
4 properties 1 required
XiqAlertRuleThresholdOperator
string
Has value when messagemetadatatype is "METRIC". The operator for comparing with the threshold.
XiqAlert
object
The Alert Model
20 properties 18 required
alertIds
object
The request object to acknowledge.
1 property
XiqUpdateAlertPolicyRequest
object
The request body for updating an alert policy.
2 properties 1 required
XiqDeleteBulkAlertSubscriptionEmailResponse
object
The result of a bulk delete for alert email subscriptions.
3 properties 1 required
XiqAlertMetricRulesByMetricset
object
A metricset and overviews of the associated metric-based alert rules.
3 properties 3 required
XiqPage
object
4 properties 4 required
XiqAlertSource
object
The alert source info
4 properties 4 required
XiqBulkDeleteWebhookSubscriptionResult
object
The result of bulk delete webhook susbscriptions.
1 property
XiqAlertWebhookSubscription
XiqAlertGroupQuery
string
XiqAlertRuleOverview
object
The overview for an alert rule. Detailed information is available from the get alert rule API.
3 properties 3 required
XiqBulkOperationResult
string
XiqSortOrder
string
XiqUpdateAlertWebhookSubscriptionRequest
object
The payload to create webhook subscription
5 properties 1 required
XiqPatchAlertServiceNowSubscriptionRequest
object
The payload to update ServiceNow subscription
4 properties
XiqAlertEmailSubscription
XiqAlertServiceNowSubscription
PagedXiqAlert
XiqAlertReport
object
ExtremeCloud IQ alert report
1 property
XiqAlertPolicyType
string
All available policy type GLOBAL and SITE.
XiqAlertEventRulesByCategory
object
A category and overviews of the associated event-based alert rules.
3 properties 3 required
XiqError
object
6 properties 3 required
XiqBulkDeleteEmailSubscriptionResult
object
The result of bulk detele email susbscriptions.
1 property
XiqCreateAlertWebhookSubscriptionRequest
object
The payload to create webhook subscription
5 properties 3 required
XiqCreateAlertEmailSubscriptionRequest
object
The payload to create email subscription
4 properties 3 required
XiqDeleteBulkAlertSubscriptionWebhookResponse
object
The result of a bulk delete for alert webhook subscriptions.
3 properties 1 required
XiqUpdateAlertRuleRequest
object
8 properties
XiqAlertRule
object
The state for a configured alert rule.
15 properties 9 required
XiqBaseEntity
object
3 properties 3 required
XiqAlertTag
object
The tag for the alert
4 properties 4 required
XiqErrorParams
object
Error parameters
2 properties
subscriptionIds
object
The filter to get alert subscriptions
1 property
XiqAlertSite
object
The site information.
2 properties 2 required
XiqDeleteBulkAlertSubscriptionServiceNowResponse
object
The result of a bulk delete for alert ServiceNow subscriptions.
3 properties 1 required
XiqCreateAlertServiceNowSubscriptionRequest
object
The payload to create ServiceNow subscription
4 properties 3 required
XiqCreateAlertPolicyRequest
object
The body of a create alert policy request.
2 properties 2 required
XiqAlertPolicy
object
The alert policy model. Includes the alert policy and the associated rules.
7 properties 6 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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

extreme-networks-alert-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of Extreme Networks Alert API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.