---
title: "List all alert policies"
method: GET
path: "/alert-policies"
tags: ["Alert"]
---

# List all alert policies

`GET /alert-policies`

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.

## Query parameters

- `keyword` string
- `policyType` 'GLOBAL' | 'SITE'

## Response `200`

OK

- XiqListAlertPolicies — The List Alert Policy Response Model
  - `global_policy` XiqAlertPolicy — The Alert Policy Model
    - `id` integer, required — The unique identifier
    - `owner_id` integer — The owner ID
    - `org_id` integer — The organization identifier, valid when enabling HIQ feature
    - `name` string — The name of the alert policy
    - `sites` XiqAlertSite[] — The message metadata type
      - `site_id` integer, required — The unique identifier of site
      - `site_name` string — The site name of the alert policy site
    - `event_rules_overview` XiqAlertEventRulesByCategory[] — A list of overviews of the event-based alert rules, grouped by category.
      - `category_id` integer, required — The unique identifier of category ID.
      - `category_name` string, required — The category name of category
      - `rules` XiqAlertRuleOverview[], required — A list of overviews of the event-based alert rules, grouped by event.
        - `id` integer, required — The unique identifier of rule.
        - `name` string, required — The human-readable name of this rule. Corresponds to the message_metadata_name from the get alert rule details API.
        - `enabled` boolean, required — Indicates whether this rule is in effect.
    - `metric_rules_overview` XiqAlertMetricRulesByMetricset[] — A list of overviews of the metric-based alert rules, grouped by metricset.
      - `metricset_id` integer, required — The unique identifier of the metricset.
      - `metricset_name` string, required — The human-readable name of the metricset.
      - `rules` XiqAlertRuleOverview[], required — A list of overviews of the metric-based alert rules, grouped by metricset.
        - `id` integer, required — The unique identifier of rule.
        - `name` string, required — The human-readable name of this rule. Corresponds to the message_metadata_name from the get alert rule details API.
        - `enabled` boolean, required — Indicates whether this rule is in effect.
  - `site_policies` XiqAlertPolicy[] — The site alert policy List
    - `id` integer, required — The unique identifier
    - `owner_id` integer — The owner ID
    - `org_id` integer — The organization identifier, valid when enabling HIQ feature
    - `name` string — The name of the alert policy
    - `sites` XiqAlertSite[] — The message metadata type
      - `site_id` integer, required — The unique identifier of site
      - `site_name` string — The site name of the alert policy site
    - `event_rules_overview` XiqAlertEventRulesByCategory[] — A list of overviews of the event-based alert rules, grouped by category.
      - `category_id` integer, required — The unique identifier of category ID.
      - `category_name` string, required — The category name of category
      - `rules` XiqAlertRuleOverview[], required — A list of overviews of the event-based alert rules, grouped by event.
        - `id` integer, required — The unique identifier of rule.
        - `name` string, required — The human-readable name of this rule. Corresponds to the message_metadata_name from the get alert rule details API.
        - `enabled` boolean, required — Indicates whether this rule is in effect.
    - `metric_rules_overview` XiqAlertMetricRulesByMetricset[] — A list of overviews of the metric-based alert rules, grouped by metricset.
      - `metricset_id` integer, required — The unique identifier of the metricset.
      - `metricset_name` string, required — The human-readable name of the metricset.
      - `rules` XiqAlertRuleOverview[], required — A list of overviews of the metric-based alert rules, grouped by metricset.
        - `id` integer, required — The unique identifier of rule.
        - `name` string, required — The human-readable name of this rule. Corresponds to the message_metadata_name from the get alert rule details API.
        - `enabled` boolean, required — Indicates whether this rule is in effect.

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)