Stalwart core API

openapi: 3.1.0
info:
  title: Stalwart core API
  version: '2026-10-28'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-28: 4 operation(s) read from 4 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Stalwart has published no machine-readable contract that the
    pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 7
    documentation: 37
    pages-with-code: 12
    pages-read: 21
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-28'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://stalw.art/docs/install/platform/linux
  - https://stalw.art/docs/management/cli
  - https://stalw.art/docs/server/autoconfig
  - https://stalw.art/docs/server/reverse-proxy
  x-docs-section: core
servers:
- url: https://get.stalw.art
paths:
  /.well-known/openid-configuration:
    get:
      operationId: get_well_known_openid_configuration
      tags:
      - API
      summary: GET /.well-known/openid-configuration
      x-source: https://stalw.art/docs/server/reverse-proxy
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -s https://mail.example.com/.well-known/openid-configuration \n A different symptom points to a different cause. If the\
          \ proxy, or every user behind it, is suddenly refused, check whether the proxy’s address has been banned, as described in Diagnosing\
          \ and clearing a ban . Edit page Last updated: Oct 26, 2026 Previous Configuration Next PROXY protocol"
  /autodiscover/autodiscover.xml:
    post:
      operationId: post_autodiscover_autodiscover_xml
      tags:
      - Autodiscover
      summary: Outlook sends POST /autodiscover/autodiscover.xml to autodiscover.<domain>, with the address in the request body.
      description: Stalwart answers only the Outlook Autodiscover XML schema (http://schemas.microsoft.com/exchange/autodiscover/outlook/responseschema/2006a)
        and returns the IMAP, POP3 and SMTP settings with the email address as login name. Requests for other schemas receive an error response
        with code 601.
      x-source: https://stalw.art/docs/server/autoconfig
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAutodiscoverAutodiscoverXmlRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostAutodiscoverAutodiscoverXmlResponse'
      x-evidence:
        kind: documentation
  /install.sh:
    get:
      operationId: get_install_sh
      tags:
      - Install
      summary: GET /install.sh
      x-source: https://stalw.art/docs/install/platform/linux
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --proto ' =https ' --tlsv1.2 -sSf https://get.stalw.art/install.sh -o install.sh $ sudo sh install.sh \n The script downloads\
          \ the latest release for the host’s architecture and creates an unprivileged service account for the server, so that the server does\
          \ not run as root. It then installs the binary and its directories, registers a service with the host’s service manager, which starts\
          \ the ser"
  /stalwartlabs/cli/releases/latest/download/stalwart-cli-installer.sh:
    get:
      operationId: get_stalwartlabs_cli_releases_latest_download_stalwart_cli_installer_sh
      tags:
      - Stalwartlabs
      summary: GET /stalwartlabs/cli/releases/latest/download/stalwart-cli-installer.sh
      x-source: https://stalw.art/docs/management/cli
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --proto ' =https ' --tlsv1.2 -LsSf \\ https://github.com/stalwartlabs/cli/releases/latest/download/stalwart-cli-installer.sh\
          \ | sh \n Windows (PowerShell installer) Section titled “Windows (PowerShell installer)” \n Terminal window powershell - ExecutionPolicy\
          \ Bypass - c \" irm https://github.com/stalwartlabs/cli/releases/latest/download/stalwart-cli-installer.ps1 | iex \" \n Homebrew (macOS\
          \ / Linux"
security:
- bearer: []
components:
  schemas:
    PostAutodiscoverAutodiscoverXmlRequest:
      type: object
      properties:
        address:
          type: string
          description: The email address of the user, provided in the request body.
      required:
      - address
    PostAutodiscoverAutodiscoverXmlResponse:
      type: object
      properties:
        IMAP:
          type: string
          description: IMAP server settings returned in the XML response.
        POP3:
          type: string
          description: POP3 server settings returned in the XML response.
        SMTP:
          type: string
          description: SMTP server settings returned in the XML response.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
tags:
- name: API
- name: Autodiscover
- name: Install
- name: Stalwartlabs