---
title: "GET /api/v2/alarms/"
method: GET
path: "/api/v2/alarms/"
tags: ["alarms"]
---

# GET /api/v2/alarms/

`GET /api/v2/alarms/`

Viewset for Alarm.

## Query parameters

- `created` string, date-time
- `min_date` string, date-time
- `ordering` string
- `page` integer
- `page_size` integer
- `search` string

## Response `200`

- PaginatedAlarmList
  - `count` integer, required
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` Alarm[], required
    - `id` integer, required
    - `created` string, date-time
    - `closed` string, date-time, nullable
    - `status` 1 | 2 — * `1` - Opened * `2` - Closed
    - `title` string, required
    - `internal_name` string, required
    - `domain` Nested, required
      - `id` integer, required
      - `creation` string, date-time
      - `last_modification` string, date-time, required
      - `name` string, required — The domain name
      - `quota` integer
      - `default_mailbox_quota` integer
      - `message_limit` integer, nullable — Number of messages this domain can send per day
      - `enabled` boolean — Check to activate this domain
      - `type` string
      - `enable_dns_checks` boolean — Check to enable DNS checks for this domain
      - `last_dns_check_execution` string, date-time, nullable
      - `enable_dkim` boolean — If you activate this feature, a DKIM key will be generated for this domain.
      - `dkim_key_selector` string
      - `dkim_key_length` union
        - 1024 | 2048 | 4096 — * `1024` - 1024 * `2048` - 2048 * `4096` - 4096
        - unknown
      - `dkim_public_key` string
      - `dkim_private_key_path` string
      - `transport` integer, nullable
    - `mailbox` Nested, required
      - `id` integer, required
      - `creation` string, date-time
      - `last_modification` string, date-time, required
      - `name` string, required — The domain name
      - `quota` integer
      - `default_mailbox_quota` integer
      - `message_limit` integer, nullable — Number of messages this domain can send per day
      - `enabled` boolean — Check to activate this domain
      - `type` string
      - `enable_dns_checks` boolean — Check to enable DNS checks for this domain
      - `last_dns_check_execution` string, date-time, nullable
      - `enable_dkim` boolean — If you activate this feature, a DKIM key will be generated for this domain.
      - `dkim_key_selector` string
      - `dkim_key_length` union
        - 1024 | 2048 | 4096 — * `1024` - 1024 * `2048` - 2048 * `4096` - 4096
        - unknown
      - `dkim_public_key` string
      - `dkim_private_key_path` string
      - `transport` integer, nullable

---

[API](https://skmtc.dev/modoboa/apis/modoboa-api.md) · [All operations](https://skmtc.dev/modoboa/apis/modoboa-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/modoboa/modoboa-api/revisions/01f8eaf44cc7/schema)