Modoboa · Schema

RelayDomain

RelayDomain serializer class.

EmailMail ServerOpen SourceWebmailManagementCompany

Properties

Name Type Description
pk integer
name string The domain name
enabled boolean Check to activate this domain
transport object
enable_dkim boolean If you activate this feature, a DKIM key will be generated for this domain.
dkim_key_selector string
dkim_public_key string
View JSON Schema on GitHub

JSON Schema

modoboa-relay-domain-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/modoboa/json-schema/modoboa-relay-domain-schema.json",
  "title": "RelayDomain",
  "description": "RelayDomain serializer class.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/modoboa-relaydomains-api-openapi.yml#/components/schemas/RelayDomain",
  "type": "object",
  "properties": {
    "pk": {
      "type": "integer",
      "readOnly": true,
      "title": "ID"
    },
    "name": {
      "type": "string",
      "description": "The domain name",
      "maxLength": 253
    },
    "enabled": {
      "type": "boolean",
      "description": "Check to activate this domain"
    },
    "transport": {
      "$ref": "#/$defs/Transport"
    },
    "enable_dkim": {
      "type": "boolean",
      "title": "Enable DKIM signing",
      "description": "If you activate this feature, a DKIM key will be generated for this domain."
    },
    "dkim_key_selector": {
      "type": "string",
      "maxLength": 30
    },
    "dkim_public_key": {
      "type": "string",
      "readOnly": true
    }
  },
  "required": [
    "dkim_public_key",
    "name",
    "pk",
    "transport"
  ],
  "$defs": {
    "Transport": {
      "type": "object",
      "description": "Serializer for Transport model.",
      "properties": {
        "service": {
          "type": "string",
          "maxLength": 30
        },
        "settings": {
          "type": "object",
          "additionalProperties": {}
        }
      },
      "required": [
        "service",
        "settings"
      ]
    }
  }
}

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-relay-domain"
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.