Config

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/planka/main/json-schema/planka-config-schema.json",
  "title": "Config",
  "x-generated": "2026-10-27",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/planka-openapi.json#/components/schemas/Config",
  "type": "object",
  "required": [
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the config (always set to '1')"
    },
    "smtpHost": {
      "type": [
        "string",
        "null"
      ],
      "description": "Hostname or IP address of the SMTP server"
    },
    "smtpPort": {
      "type": [
        "number",
        "null"
      ],
      "description": "Port number of the SMTP server"
    },
    "smtpName": {
      "type": [
        "string",
        "null"
      ],
      "description": "Client hostname used in the EHLO command for SMTP"
    },
    "smtpSecure": {
      "type": "boolean",
      "description": "Whether to use a secure connection for SMTP"
    },
    "smtpTlsRejectUnauthorized": {
      "type": "boolean",
      "description": "Whether to reject unauthorized or self-signed TLS certificates for SMTP connections"
    },
    "smtpUser": {
      "type": [
        "string",
        "null"
      ],
      "description": "Username for authenticating with the SMTP server"
    },
    "smtpPassword": {
      "type": [
        "string",
        "null"
      ],
      "description": "Password for authenticating with the SMTP server"
    },
    "smtpFrom": {
      "type": [
        "string",
        "null"
      ],
      "description": "Default \"from\" used for outgoing SMTP emails"
    },
    "createdAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the config was created"
    },
    "updatedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the config was last updated"
    }
  }
}