---
title: "Get a page of alarms"
method: GET
path: "/alarms"
tags: ["Alarms"]
---

# Get a page of alarms

`GET /alarms`

Retrieves a paginated list of alarms. Can be filtered by various parameters.

## Query parameters

- `page` integer
- `size` integer
- `sort` string
- `status` string[]
- `suppressed` boolean
- `rule_intent` string
- `rule_method` string
- `rule_strategy` string
- `priority_label` string[]
- `alarm_sensor_sources` string, uuid
- `timestamp_occured_gte` integer
- `timestamp_occured_lte` integer

## Response `200`

A paginated list of alarms.

- AlarmPage
  - `_links` PageLinks, required
    - `self` HalLink
      - `href` string, uri, required
      - `templated` boolean
    - `first` HalLink
      - `href` string, uri, required
      - `templated` boolean
    - `last` HalLink
      - `href` string, uri, required
      - `templated` boolean
    - `next` HalLink
      - `href` string, uri, required
      - `templated` boolean
    - `prev` HalLink
      - `href` string, uri, required
      - `templated` boolean
  - `_embedded` EmbeddedAlarms, required
    - `alarms` Alarm[], required
      - `uuid` string, uuid, required
      - `alarm_labels` string[]
      - `has_alarm` boolean, required
      - `needs_enrichment` boolean, required
      - `packet_data` string[]
      - `priority` integer
      - `suppressed` boolean
      - `destinations` AlarmDestination[]
        - `address` string
        - `hostname` string
        - `fqdn` string
        - `asset_id` string
        - `organisation` string
        - `country` string
        - `canonical` string
        - `name` string
        - `event_count` integer, required
        - `_links` AlarmDestinationLinks
          - `self` HalLink
            - `href` string, uri, required
            - `templated` boolean
      - `sources` AlarmSource[]
        - `address` string
        - `hostname` string
        - `fqdn` string
        - `asset_id` string
        - `organisation` string
        - `country` string
        - `canonical` string
        - `name` string
        - `event_count` integer, required
        - `_links` AlarmSouceLinks
          - `self` HalLink
            - `href` string, uri, required
            - `templated` boolean
      - `events` AlarmEvent[]
        - `uuid` string, uuid, required
        - `has_alarm` boolean, required
        - `needs_enrichment` boolean, required
        - `priority` integer
        - `suppressed` boolean
        - `source_address` string
        - `source_asset_id` string
        - `source_canonical` string
        - `source_country` string
        - `source_fqdn` string
        - `source_hostname` string
        - `source_name` string
        - `source_organisation` string
        - `destination_address` string
        - `destination_asset_id` string
        - `destination_canonical` string
        - `destination_country` string
        - `destination_fqdn` string
        - `destination_hostname` string
        - `destination_name` string
        - `destination_organisation` string
        - `_links` EventLinks
          - `self` HalLink
            - `href` string, uri, required
            - `templated` boolean
      - `_links` AlarmLinks
        - `self` HalLink
          - `href` string, uri, required
          - `templated` boolean
  - `page` PageDetail, required
    - `size` integer, required
    - `totalElements` integer, required
    - `totalPages` integer, required
    - `number` integer, required

---

[API](https://skmtc.net/levelblue/apis/usm-anywhere-api-reference.md) · [All operations](https://skmtc.net/levelblue/apis/usm-anywhere-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/levelblue/usm-anywhere-api-reference/versions/723df8da04b8/schema)
