SMTP

Get SMTP configuration

Returns the SMTP configuration for a realm.

Required scope: smtp:read

get/clusters/{cluster_id}/realms/{realm}/smtp

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/clusters/{cluster_id}/realms/{realm}/smtp
  • 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

Response

The request has succeeded.

cluster_idstring uuid required
realmstring required

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

hoststring required
portinteger required
encryption'none' | 'ssl' | 'starttls' required
from_emailstring email required

Sender email address.

from_namestring
auth_type'basic' | 'oauth2' required
usernamestring

SMTP username. Present when auth_type is basic.

has_passwordboolean required

true when a password is stored for this configuration.

token_urlstring uri

OAuth 2.0 token endpoint URL. Present when auth_type is oauth2.

token_scopestring

OAuth 2.0 token scope. Present when auth_type is oauth2.

client_idstring

OAuth 2.0 client ID. Present when auth_type is oauth2.

has_client_secretboolean required

true when a client secret is stored for this configuration.

status'configured' | 'verified' | 'failed' required
last_testedstring date-time

Timestamp of the last connection test.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "realm": "customer-portal",
  "host": "smtp.sendgrid.net",
  "port": 587,
  "from_email": "noreply@mycompany.com",
  "from_name": "MyCompany"
}

Changes

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