Skip to content

Create or update SMTP configuration

PUT
/clusters/{cluster_id}/realms/{realm}/smtp
curl --request PUT \
  --url http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/realms/customer-portal/smtp \
  --header 'API-Key: <API-Key>' \
  --header 'API-Version: 2026-06-01.beta' \
  --header 'Content-Type: application/json' \
  --data '{ "host": "smtp.sendgrid.net", "port": 587, "encryption": "none", "from_email": "hello@example.com", "from_name": "example", "auth_type": "basic", "username": "example", "password": "example", "token_url": "https://example.com", "token_scope": "example", "client_id": "example", "client_secret": "example" }'

Creates or replaces the SMTP configuration for a realm. Credentials (password, client secret) are write-only; omit them to retain the existing value.

Required scope: smtp:write

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
cluster_id
required
string format: uuid
realm
required

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

string
>= 1 characters <= 63 characters /^[a-zA-Z][a-zA-Z0-9-]*$/

Example 

customer-portal

Header Parameters

Section titled “Header Parameters”
API-Version
required
string
Allowed values: 2026-06-01.beta

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
host
required
string
>= 1 characters <= 255 characters
port
required
integer
>= 1 <= 65535

Example 

587
encryption

Encryption mode. Defaults to none.

string
Allowed values: none ssl starttls
from_email
required

Sender email address.

string format: email
from_name
string
<= 255 characters
auth_type
required
string
Allowed values: basic oauth2
username

Required when auth_type is basic.

string
<= 255 characters
password

Required when auth_type is basic and no password is currently stored. Omit to retain the existing password.

string
token_url

Required when auth_type is oauth2.

string format: uri
token_scope

Required when auth_type is oauth2.

string
>= 1 characters <= 255 characters
client_id

Required when auth_type is oauth2.

string
>= 1 characters <= 255 characters
client_secret

Required when auth_type is oauth2 and no client secret is stored. Omit to retain the existing secret.

string

Responses

Section titled “Responses”

200

Section titled “200”

The request has succeeded.

Media typeapplication/json

SMTP email delivery configuration for a realm.

object
cluster_id
required
string format: uuid
realm
required

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

string
>= 1 characters <= 63 characters /^[a-zA-Z][a-zA-Z0-9-]*$/
host
required
string
>= 1 characters <= 255 characters
port
required
integer
>= 1 <= 65535
encryption
required
string
Allowed values: none ssl starttls
from_email
required

Sender email address.

string format: email
from_name
string
<= 255 characters
auth_type
required
string
Allowed values: basic oauth2
username

SMTP username. Present when auth_type is basic.

string
has_password
required

true when a password is stored for this configuration.

boolean
token_url

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

string format: uri
token_scope

OAuth 2.0 token scope. Present when auth_type is oauth2.

string
client_id

OAuth 2.0 client ID. Present when auth_type is oauth2.

string
has_client_secret
required

true when a client secret is stored for this configuration.

boolean
status
required
string
Allowed values: configured verified failed
last_tested

Timestamp of the last connection test.

string format: date-time
created_at
required
string format: date-time
updated_at
required
string format: date-time

Example 

{
  "realm": "customer-portal",
  "host": "smtp.sendgrid.net",
  "port": 587,
  "encryption": "none",
  "from_email": "noreply@mycompany.com",
  "from_name": "MyCompany",
  "auth_type": "basic",
  "status": "configured"
}

400

Section titled “400”

The server could not understand the request due to invalid syntax.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

401

Section titled “401”

Access is unauthorized.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

403

Section titled “403”

Access is forbidden.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

404

Section titled “404”

The server cannot find the requested resource.

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

422

Section titled “422”

Client error

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri
errors
required
Array<object>
>= 1 items
object
field
required
string
detail
required
string
code
string
value

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "errors": [
    {
      "field": "example",
      "detail": "example",
      "code": "example",
      "value": "example"
    }
  ]
}

429

Section titled “429”

Client error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

Headers

Section titled “Headers”
Retry-After
integer
RateLimit-Limit
integer
RateLimit-Remaining
integer
RateLimit-Reset
integer
X-RateLimit-Limit-Second
integer
X-RateLimit-Remaining-Second
integer
X-RateLimit-Limit-Minute
integer
X-RateLimit-Remaining-Minute
integer
X-RateLimit-Limit-Hour
integer
X-RateLimit-Remaining-Hour
integer
X-RateLimit-Limit-Day
integer
X-RateLimit-Remaining-Day
integer

500

Section titled “500”

Server error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}

501

Section titled “501”

Server error

Media typeapplication/problem+json

RFC 9457 Problem Details object.

object
type
required
string format: uri
title
required
string
status
required
integer
detail
required
string
instance
string format: uri

Example generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com"
}
© 2026 Skycloak. All Rights Reserved. Design by Yasser SolimanKeycloak™ is a trademark of the Linux Foundation. Skycloak is not affiliated with the Keycloak project.