Extreme Networks Alert API

openapi: 3.0.3
info:
  title: ExtremeCloud IQ Account Alert API
  description: 'ExtremeCloud IQ™ API allows customers and partners to create solutions for the management, monitoring, and provisioning

    of any ExtremeCloud IQ™ environment.


    All related resources and documentation are available at [ExtremeCloud IQ Developer Portal](https://developer.extremecloudiq.com/).

    Please check [Get Started and Tutorial](https://developer.extremecloudiq.com/documentation/) to understand how to use the APIs.


    Get the [latest OpenAPI definition](https://github.com/extremenetworks/ExtremeCloudIQ-OpenAPI/blob/main/xcloudiq-openapi.yaml)

    from [ExtremeCloud IQ OpenAPI GitHub repository](https://github.com/extremenetworks/ExtremeCloudIQ-OpenAPI).


    Please have a valid [ExtremeCloud IQ](https://extremecloudiq.com/) account before getting started.

    If you don''t have one, please [register a new account](https://www.extremenetworks.com/cloud-networking/).'
  termsOfService: https://www.extremenetworks.com/company/legal/terms-of-use/
  contact:
    name: Extreme Networks Support
    url: https://www.extremenetworks.com/support
    email: support@extremenetworks.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 25.9.0-36
servers:
- url: https://api.extremecloudiq.com
  description: ExtremeCloud IQ REST API Server
tags:
- name: Alert
  description: ExtremeCloud IQ generated alerts and events
paths:
  /alerts:
    get:
      tags:
      - Alert
      summary: List the alerts
      description: List a page of alerts by filter.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_alerts
      operationId: listAlerts
      parameters:
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/startTime'
      - $ref: '#/components/parameters/endTime'
      - $ref: '#/components/parameters/acknowledged'
      - $ref: '#/components/parameters/categoryIds'
      - $ref: '#/components/parameters/severityIds'
      - $ref: '#/components/parameters/messageMetadataIds'
      - $ref: '#/components/parameters/siteId'
      - name: sortField
        in: query
        description: The sort field
        required: false
        schema:
          $ref: '#/components/schemas/XiqAlertSortField'
      - $ref: '#/components/parameters/order'
      - name: keyword
        in: query
        description: The keyword to filter, such as summery, severity, source and etc.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedXiqAlert'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /alerts/:acknowledge:
    post:
      tags:
      - Alert
      summary: Acknowledge the alerts
      description: Acknowledge the alerts by ID list.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_acknowledge_the_alerts
      operationId: acknowledgeAlerts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/alertIds'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                description: The data in the current page
                items:
                  $ref: '#/components/schemas/XiqAlert'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /alerts/count-by-{group}:
    get:
      tags:
      - Alert
      summary: Count the alerts by different grouping
      description: Count the number of alerts and events based on Severity, Category, and Alert Type.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_count_the_alerts_by_group
      operationId: countAlertsByGroup
      parameters:
      - $ref: '#/components/parameters/startTime'
      - $ref: '#/components/parameters/endTime'
      - $ref: '#/components/parameters/group'
      - $ref: '#/components/parameters/acknowledged'
      - $ref: '#/components/parameters/siteId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/XiqAlertGroupCount'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /alerts/reports:
    post:
      tags:
      - Alert
      summary: '[LRO] Create alert event report'
      description: Creates a report page of alert event. This API can be run at async mode, please follow the Long-Running Operation (LRO) guide to track the progress and the result.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_create_an_alert_report
      operationId: createAlertReport
      parameters:
      - $ref: '#/components/parameters/startTime'
      - $ref: '#/components/parameters/endTime'
      - $ref: '#/components/parameters/acknowledged'
      - $ref: '#/components/parameters/categoryIds'
      - $ref: '#/components/parameters/severityIds'
      - $ref: '#/components/parameters/messageMetadataIds'
      - name: siteId
        in: query
        description: The site to filter, return global data if not specified
        required: false
        schema:
          type: integer
          format: int64
      - name: timeZoneOffset
        in: query
        description: The time zone off set
        required: false
        schema:
          type: integer
          format: int32
      - name: sortField
        in: query
        description: The sort field
        required: false
        schema:
          $ref: '#/components/schemas/XiqAlertSortField'
      - $ref: '#/components/parameters/order'
      - name: keyword
        in: query
        description: The keyword to filter, such as summery, severity, source and etc.
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/async'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqAlertReport'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /alerts/reports/{id}:
    get:
      tags:
      - Alert
      summary: Download an alert event report
      description: Download report of alert event .
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_download_an_alert_report
      operationId: downloadAlertReport
      parameters:
      - name: id
        in: path
        description: The report ID
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                type: string
                format: byte
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /alert-subscriptions/emails:
    get:
      tags:
      - Alert
      summary: List email subscriptions
      description: List all email subscriptions.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_list_alert_email_subscriptions
      operationId: listEmailSubscriptions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/XiqAlertEmailSubscription'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
    post:
      tags:
      - Alert
      summary: Create email subscription
      description: Create email subscription.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_create_subscription_email
      operationId: createEmailSubscription
      requestBody:
        description: The payload of create email subscription.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XiqCreateAlertEmailSubscriptionRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqAlertEmailSubscription'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /alert-subscriptions/emails/:delete:
    post:
      tags:
      - Alert
      summary: '[LRO] Delete alert subscription email in bulk'
      description: Delete alert subscription email by a list of IDs.This API can be run at async mode, please follow the Long-Running Operation (LRO) guide to track the progress and the result.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_bulk_delete_alert_email_subscriptions
      operationId: deleteBulkAertSubscriptionEmail
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/subscriptionIds'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqDeleteBulkAlertSubscriptionEmailResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /alert-subscriptions/emails/{id}:
    get:
      tags:
      - Alert
      summary: Get email subscription info for a specific email
      description: Get email subscription info for a specific email.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_an_alert_email_subscription
      operationId: getEmailSubscription
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqAlertEmailSubscription'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
    put:
      tags:
      - Alert
      summary: Update email subscription
      description: Update email subscription.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_update_an_alert_email_subscription
      operationId: updateEmailSubscription
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        description: The payload of update email subscription.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XiqUpdateAlertEmailSubscriptionRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqAlertEmailSubscription'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
    delete:
      tags:
      - Alert
      summary: Delete email subscription
      description: Delete an exist email subscription.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_an_alert_email_subscription
      operationId: deleteEmailSubscription
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /alert-subscriptions/emails/{id}/:verify:
    post:
      tags:
      - Alert
      summary: External email address verification
      description: User sends a verification email to the specified email address to verify, by clicking the verify link/button in the email.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_verify_an_alert_email_subscription
      operationId: verifySubscriptionEmail
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /alert-subscriptions/webhooks:
    get:
      tags:
      - Alert
      summary: List webhook subscriptions
      description: List webhook subscriptions.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_list_alert_webhook_subscriptions
      operationId: listWebhookSubscriptions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/XiqAlertWebhookSubscription'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
    post:
      tags:
      - Alert
      summary: Create webhook subscription
      description: Create webhook subscription.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_create_an_alert_webhook_subscription
      operationId: createWebhookSubscription
      requestBody:
        description: The payload of create webhook subscription.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XiqCreateAlertWebhookSubscriptionRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqAlertWebhookSubscription'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /alert-subscriptions/webhooks/:delete:
    post:
      tags:
      - Alert
      summary: '[LRO] Delete alert subscription webhook in bulk'
      description: Delete alert subscription webhook by a list of IDs.This API can be run at async mode, please follow the Long-Running Operation (LRO) guide to track the progress and the result.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_bulk_delete_alert_webhook_subscriptions
      operationId: deleteBulkAertSubscriptionWebhook
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/subscriptionIds'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqDeleteBulkAlertSubscriptionWebhookResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /alert-subscriptions/webhooks/{id}:
    get:
      tags:
      - Alert
      summary: Get webhook subscription info for a specific url
      description: Get webhook subscription info for a specific url.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_an_alert_webhook_subscription
      operationId: getWebhookSubscription
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqAlertWebhookSubscription'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
    put:
      tags:
      - Alert
      summary: Update webhook subscription
      description: Update webhook subscription.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_update_an_alert_webhook_subscription
      operationId: updateWebhookSubscription
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        description: The payload of update webhook subscription.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XiqUpdateAlertWebhookSubscriptionRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqAlertWebhookSubscription'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
    delete:
      tags:
      - Alert
      summary: Delete webhook subscription
      description: Delete an exist webhook subscription.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_an_alert_webhook_subscription
      operationId: deleteWebhookSubscription
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /alert-subscriptions/servicenow:
    get:
      tags:
      - Alert
      summary: List ServiceNow subscriptions
      description: List all ServiceNow subscriptions.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_list_alert_servicenow_subscription
      operationId: listServiceNowSubscriptions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/XiqAlertServiceNowSubscription'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
    post:
      tags:
      - Alert
      summary: Create ServiceNow subscription
      description: Create ServiceNow subscription.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_create_an_alert_servicenow_subscription
      operationId: createServiceNowSubscription
      requestBody:
        description: The payload of create ServiceNow subscription.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XiqCreateAlertServiceNowSubscriptionRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqAlertServiceNowSubscription'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /alert-subscriptions/servicenow/:delete:
    post:
      tags:
      - Alert
      summary: Delete alert ServiceNow subscription in bulk
      description: Delete alert ServiceNow subscription by a list of provided IDs.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_bulk_delete_an_alert_servicenow_subscription
      operationId: deleteBulkAlertSubscriptionServiceNow
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/subscriptionIds'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqDeleteBulkAlertSubscriptionServiceNowResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /alert-subscriptions/servicenow/{id}:
    get:
      tags:
      - Alert
      summary: Get a specific ServiceNow subscription
      description: Get ServiceNow subscription info for a specific ServiceNow account.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_an_alert_servicenow_subscription
      operationId: getServiceNowSubscription
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqAlertServiceNowSubscription'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
    put:
      tags:
      - Alert
      summary: Update ServiceNow subscription
      description: Update ServiceNow subscription.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_update_an_alert_servicenow_subscription
      operationId: updateServiceNowSubscription
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        description: The payload of update ServiceNow subscription.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XiqUpdateAlertServiceNowSubscriptionRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqAlertServiceNowSubscription'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
    patch:
      tags:
      - Alert
      summary: Partial or full update ServiceNow subscription
      description: Partial or full update ServiceNow subscription.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_patch_alert_serviceNow_subscription
      operationId: patchServiceNowSubscription
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        description: The payload of ServiceNow subscription.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XiqPatchAlertServiceNowSubscriptionRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqAlertServiceNowSubscription'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
    delete:
      tags:
      - Alert
      summary: Delete ServiceNow subscription
      description: Delete an exist ServiceNow subscription.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_an_alert_ServiceNow_subscription
      operationId: deleteServiceNowSubscription
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /alert-policies:
    get:
      tags:
      - Alert
      summary: List all alert policies
      description: Get a list of all alert policies belonging to the current user and an overview  of their associated alert rules.  The details for the rules is available from the alert policy rules API.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_alert_policies
      operationId: listAlertPolicies
      security:
      - BearerAuth: []
      parameters:
      - name: keyword
        in: query
        description: The keyword to filter, such as policy name or site name
        required: false
        schema:
          type: string
      - name: policyType
        in: query
        description: The policy type to filter, such as SITE or GLOBAL
        required: false
        schema:
          $ref: '#/components/schemas/XiqAlertPolicyType'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                description: The alert policies belonging to this user.
                properties:
                  global_policy:
                    description: The global policy. Empty when includeGlobal is false.
                    $ref: '#/components/schemas/XiqAlertPolicy'
                  site_policies:
                    type: array
                    description: A list of site policies.
                    items:
                      $ref: '#/components/schemas/XiqAlertPolicy'
        default:
          $ref: '#/components/responses/ErrorResponse'
    post:
      tags:
      - Alert
      summary: Create a site based alert policy
      description: Create a new site-based alert policy. The global policy for each account is created automatically.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_create_an_alert_policy
      operationId: createAlertPolicy
      security:
      - BearerAuth: []
      requestBody:
        description: The body of create site policy API
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XiqCreateAlertPolicyRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqAlertPolicy'
                description: The newly created alert policy.
        default:
          $ref: '#/components/responses/ErrorResponse'
  /alert-policies/{policyId}:
    get:
      tags:
      - Alert
      summary: Get details of an alert policy
      description: Get the details related to a specific alert policy, given the policy's identifier.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_an_alert_policy
      operationId: getAlertPolicy
      security:
      - BearerAuth: []
      parameters:
      - $ref: '#/components/parameters/policyId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqAlertPolicy'
        default:
          $ref: '#/components/responses/ErrorResponse'
    put:
      tags:
      - Alert
      summary: Update a site-based alert policy
      description: Modify a site-based alert policy's details, including the policy name and sites. The global policy cannot be updated. The sites can be obtained from the alerts/sites API.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_update_an_alert_policy
      operationId: updateAlertPolicy
      security:
      - BearerAuth: []
      parameters:
      - $ref: '#/components/parameters/policyId'
      requestBody:
        description: The body of update alert site policy API
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XiqUpdateAlertPolicyRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqAlertPolicy'
                description: The newly created alert policy.
        default:
          $ref: '#/components/responses/ErrorResponse'
    delete:
      tags:
      - Alert
      summary: Delete a site-based alert policy
      description: Delete an alert policy. All the associated alert rules will be deleted as well. The global policy cannot be deleted.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_delete_an_alert_policy
      operationId: deleteAlertPolicy
      security:
      - BearerAuth: []
      parameters:
      - $ref: '#/components/parameters/policyId'
      responses:
        '200':
          description: OK
        default:
          $ref: '#/components/responses/ErrorResponse'
  /alert-policies/available-sites:
    get:
      tags:
      - Alert
      summary: The list of current owner's available sites
      description: List all sites belonging to the current owner. If the site has been configured an alert policy, then the site will not be available.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_list_the_available_sites
      operationId: listAvailableSites
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/XiqAlertSite'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
      - BearerAuth: []
  /alert-policies/{policyId}/rules/{ruleId}:
    get:
      tags:
      - Alert
      summary: Get details of an alert rule
      description: Get the full details of an alert rule's state.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_get_an_alert_rule
      operationId: getAlertRule
      security:
      - BearerAuth: []
      parameters:
      - $ref: '#/components/parameters/policyId'
      - $ref: '#/components/parameters/ruleId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqAlertRule'
        default:
          $ref: '#/components/responses/ErrorResponse'
    put:
      tags:
      - Alert
      summary: Update an alert rule
      description: Update the state of an alert rule. The rule's identifier may change as a result of this operation.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_update_an_alert_rule
      operationId: updateAlertRule
      security:
      - BearerAuth: []
      parameters:
      - $ref: '#/components/parameters/policyId'
      - $ref: '#/components/parameters/ruleId'
      requestBody:
        description: The body of update alert rule API
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/XiqUpdateAlertRuleRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqAlertRule'
        default:
          $ref: '#/components/responses/ErrorResponse'
  /alert-policies/{policyId}/rules/{ruleId}/:enable:
    post:
      tags:
      - Alert
      summary: Enable a rule from an alert policy
      description: Set the status of a rule to enabled. The rule's identifier may change as a result of this operation.
      externalDocs:
        description: API Reference
        url: https://extremecloudiq.com/api-docs/api-reference.html#_enable_an_alert_rule
      operationId: enableAlertRule
      security:
      - BearerAuth: []
      parameters:
      - $ref: '#/components/parameters/policyId'
      - $ref: '#/components/parameters/ruleId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/XiqAlertRule'
                description: The updated alert rule status.
        default:
          $ref: '#/components/responses/ErrorResponse'
 

# --- truncated at 32 KB (65 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/extreme-networks/refs/heads/main/openapi/extreme-networks-alert-api-openapi.yml