Skip to content

← All integrations

Mail server

Renews and installs the HTTPS certificate on Proxmox Mail Gateway through its API.

The appliance runs the integration and connects to Proxmox Mail Gateway through Proxmox Mail Gateway REST API over HTTPS on port 8006. No service agent is installed on Proxmox Mail Gateway.

What happens

  1. The appliance connects to Proxmox Mail Gateway through Proxmox Mail Gateway REST API on port 8006.
  2. Each target is one node. The integration checks certificate and key, takes over the relevant API/Web UI ACME renewal and uploads leaf, intermediates and key with reload.
  3. The certificate slot and a fresh TLS handshake must show the new leaf. VE normally uses 8006, PBS 8007 and PMG 8006; cluster and SMTP identities remain.

Technical details

Connection
The integration runs on the appliance, which connects over HTTPS to Proxmox Mail Gateway REST API, port 8006. No service agent is installed.
Service ports
8006, 8007
What you need
VE: Datacenter > Permissions > Roles: create SSLBrainCert with Sys.Audit and Sys.Modify. Datacenter > Permissions > API Tokens: add a user token (privilege separation on); Permissions > Add > API Token Permission: path /, token, role SSLBrainCert. The user needs these rights too. Sys.Modify on the node changes certificates/ACME domains; Sys.Audit on / reads node config/cluster status. PBS: Configuration > Access Control > API Token: add a token; Permissions > Add > API Token Permission: path /system, role Admin, for token and user. Sys.Modify on /system/certificates is needed even to read the certificate. VE/PBS: enter user@realm!tokenid as user and the token secret as password. PMG: use an account with role Administrator; enter user@pam (or user@pmg) and its password. PMG has no API tokens; two-factor accounts cannot renew unattended.
Actions
Discovery, Installation, Verification, Rollback
Integrations
proxmox-api 2.0.0
Note
  • Restoring a custom identity needs previous matching certificate and key as inputs. VE can restore its previous default slot without its key. Rollback also uses previous slot and ACME state and preserves later changes. Update clients that pin the server’s fingerprint. The certificate chain consists of the intermediate certificates that link the server certificate to a root certificate the browser trusts. ACME is the protocol a CA uses to issue certificates automatically.

Next steps