Modoboa · Schema

Alarm

Serializer for Alarm related endpoints.

EmailMail ServerOpen SourceWebmailManagementCompany

Properties

Name Type Description
id integer
domain object
mailbox object
created string
closed stringnull
status object
title string
internal_name string
View JSON Schema on GitHub

JSON Schema

modoboa-alarm-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/modoboa/json-schema/modoboa-alarm-schema.json",
  "title": "Alarm",
  "description": "Serializer for Alarm related endpoints.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/modoboa-alarms-api-openapi.yml#/components/schemas/Alarm",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "domain": {
      "allOf": [
        {
          "$ref": "#/$defs/AlarmDomain"
        }
      ],
      "readOnly": true
    },
    "mailbox": {
      "allOf": [
        {
          "$ref": "#/$defs/AlarmMailbox"
        }
      ],
      "readOnly": true
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "closed": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/$defs/AlarmStatusEnum"
        }
      ],
      "minimum": -9223372036854775808,
      "maximum": 9223372036854775807
    },
    "title": {
      "type": "string"
    },
    "internal_name": {
      "type": "string",
      "maxLength": 120
    }
  },
  "required": [
    "domain",
    "id",
    "internal_name",
    "mailbox",
    "title"
  ],
  "$defs": {
    "AlarmDomain": {
      "type": "object",
      "description": "Minimal domain representation exposed through alarms.",
      "properties": {
        "pk": {
          "type": "integer",
          "readOnly": true,
          "title": "ID"
        },
        "name": {
          "type": "string",
          "description": "The domain name",
          "maxLength": 253
        }
      },
      "required": [
        "name",
        "pk"
      ]
    },
    "AlarmMailbox": {
      "type": "object",
      "description": "Minimal mailbox representation exposed through alarms.",
      "properties": {
        "pk": {
          "type": "integer",
          "readOnly": true,
          "title": "ID"
        },
        "address": {
          "type": "string",
          "description": "Mailbox address (without the @domain.tld part)",
          "maxLength": 252
        }
      },
      "required": [
        "address",
        "pk"
      ]
    },
    "AlarmStatusEnum": {
      "enum": [
        1,
        2
      ],
      "type": "integer",
      "description": "* `1` - Opened\n* `2` - Closed"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/modoboa-alarm"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.