6. API

The smtpd process is controlled via an API, which in turn is used by management tools such as the command line interface, Visual Studio Code integration, and web administration. Those tools can be installed on either a central location (controlling an entire cluster) or on the MTA hosts themselves.

• 6.1. Endpoints
  • 6.1.1. Monitor
    • 6.1.1.1. Endpoints
      • 6.1.1.1.1. /metrics
      • 6.1.1.1.2. /ready
      • 6.1.1.1.3. /healthy
  • 6.1.2. Control sockets
  • 6.1.3. HTTP/JSON
    • 6.1.3.1. Installation
      • 6.1.3.1.1. Distributions
        • 6.1.3.1.1.1. Ubuntu
        • 6.1.3.1.1.2. RHEL
      • 6.1.3.1.2. Startup
    • 6.1.3.2. Upgrade
    • 6.1.3.3. Configuration
      • 6.1.3.3.1. Authentication directives
      • 6.1.3.3.2. Listener directives
      • 6.1.3.3.3. Other directives
      • 6.1.3.3.4. Environment directives
    • 6.1.3.4. Examples
• 6.2. API reference
  • 6.2.1. Command list
• 6.3. Version compatibility
• 6.4. HTTP submission
  • 6.4.1. Endpoint reference
    • 6.4.1.1. Authentication
    • 6.4.1.2. HTTP request format
    • 6.4.1.3. HTTP response format
  • 6.4.2. Examples