WebDomain

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/mail-in-a-box/main/json-schema/mail-in-a-box-web-domain-schema.json",
  "title": "WebDomain",
  "description": "Web domain details.",
  "x-generated": "2026-10-28",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/mailinabox-openapi.yml#/components/schemas/WebDomain",
  "type": "object",
  "required": [
    "custom_root",
    "domain",
    "root",
    "ssl_certificate",
    "static_enabled"
  ],
  "properties": {
    "custom_root": {
      "type": "string"
    },
    "domain": {
      "$ref": "#/$defs/Hostname"
    },
    "root": {
      "type": "string"
    },
    "ssl_certificate": {
      "type": "array",
      "minItems": 2,
      "maxItems": 2,
      "uniqueItems": true,
      "items": {
        "oneOf": [
          {
            "type": "string"
          },
          {
            "type": "string",
            "enum": [
              "danger",
              "success"
            ]
          }
        ]
      }
    },
    "static_enabled": {
      "type": "boolean"
    }
  },
  "$defs": {
    "Hostname": {
      "type": "string",
      "format": "hostname",
      "description": "Hostname format."
    }
  }
}