The SMTP
Short for simple mail transfer protocol, SMTP is a protocol for sending email messages between servers. component of the Keyfactor API An API is a set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. includes methods necessary to programmatically edit and retrieve the SMTP configuration profile and send a test email message. Editing the SMTP configuration profile in Keyfactor Command will only apply within the software. Only one SMTP profile may be configured.
This method has two available versions. Keyfactor recommends using the newer method when possible. For more information about versioning, see Versioning.
Table 836: SMTP Endpoints Version 1
| Endpoint | Method | Description | Link |
|---|---|---|---|
| / | GET & PUT | Version 1 GET and PUT API endpoints were deprecated for Keyfactor Command version 25.1. If the RelayUsername is configured to use a PAM secret, the Version 1 GET and POST response will return UnsupportedPAMSecret as the value for RelayUsername because PAM secret is only available in Version 2 of the endpoints. | |
| /Test | POST | Sends a test email message to confirm SMTP configuration. | POST SMTP Test |
Version 2 of the SMTP API endpoints include PAM PAM (Privileged Access Management): Controls privileged access by vaulting credentials, enforcing least-privilege/just-in-time access, rotating secrets, and auditing sessions. Across Keyfactor products, PAM protects diverse sensitive operations and secrets—for example certificate stores and CA credentials—via built-in or third-party providers; external integrations are delivered as custom PAM extensions (several published on Keyfactor’s public GitHub). secret functionality.
Table 837: SMTP Endpoints Version 2
| Endpoint | Method | Description | Link |
|---|---|---|---|
| / | GET | Returns information about the SMTP configuration profile. | GET SMTP |
| / | PUT | Updates settings for the SMTP configuration profile. | PUT SMTP |
Was this page helpful? Provide Feedback