SMTP

Test SMTP configuration

Sends a test email using the saved SMTP configuration. Returns the test result.

Required scope: smtp:write

post/clusters/{cluster_id}/realms/{realm}/smtp/test

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/clusters/{cluster_id}/realms/{realm}/smtp/test
  • Auth: API key in header API-Key

Path parameters

cluster_idstring uuid required
realmstring required

Keycloak realm name (not ID). Must start with a letter; allows letters, digits, and hyphens.

Example:customer-portal

Headers

API-Version'2026-06-01.beta' required

Request body

emailstring email required

Recipient email address for the test message.

Response

The request has succeeded.

successboolean required
messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.