Modoboa · Schema

Migration

Serializer class for Migration.

EmailMail ServerOpen SourceWebmailManagementCompany

Properties

Name Type Description
id integer
provider object
mailbox object
username string
View JSON Schema on GitHub

JSON Schema

modoboa-migration-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/modoboa/json-schema/modoboa-migration-schema.json",
  "title": "Migration",
  "description": "Serializer class for Migration.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/modoboa-migrations-api-openapi.yml#/components/schemas/Migration",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "provider": {
      "allOf": [
        {
          "$ref": "#/$defs/Nested"
        }
      ],
      "readOnly": true
    },
    "mailbox": {
      "$ref": "#/$defs/Mailbox"
    },
    "username": {
      "type": "string",
      "maxLength": 254
    }
  },
  "required": [
    "id",
    "mailbox",
    "provider",
    "username"
  ],
  "$defs": {
    "Mailbox": {
      "type": "object",
      "description": "Base mailbox serializer.",
      "properties": {
        "pk": {
          "type": "integer",
          "readOnly": true,
          "title": "ID"
        },
        "full_address": {
          "type": "string",
          "format": "email"
        },
        "use_domain_quota": {
          "type": "boolean"
        },
        "quota": {
          "type": "string"
        },
        "message_limit": {
          "type": [
            "integer",
            "null"
          ],
          "maximum": 9223372036854775807,
          "minimum": 0,
          "format": "int64",
          "title": "Message sending limit",
          "description": "Number of messages this mailbox can send per day"
        },
        "quota_usage": {
          "type": "integer",
          "readOnly": true
        },
        "is_send_only": {
          "type": "boolean"
        },
        "sent_messages_in_percent": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Return number of sent messages as a percentage.",
          "readOnly": true
        }
      },
      "required": [
        "full_address",
        "pk",
        "quota_usage",
        "sent_messages_in_percent"
      ]
    },
    "Nested": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "maxLength": 50
        },
        "address": {
          "type": "string",
          "maxLength": 200
        },
        "port": {
          "type": "integer",
          "maximum": 9223372036854775807,
          "minimum": 0,
          "format": "int64"
        },
        "secured": {
          "type": "boolean"
        }
      },
      "required": [
        "address",
        "id",
        "name"
      ]
    }
  }
}

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-migration"
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.