Skip to main content

Deprecated: Get active SMTP Configuration

GET 
https://$CUSTOM-DOMAIN/admin/v1/smtp
deprecated

Returns the active SMTP configuration from the system. This is used to send E-Mails to the users.

Deprecated: please move to the new endpoint GetEmailProvider.

Responses​

A successful response.

Schema

    smtpConfig

    object

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to (string)
    senderAddress string
    senderName string
    tls boolean
    host string
    user string
    replyToAddress string
    state string

    Possible values: [SMTP_CONFIG_STATE_UNSPECIFIED, SMTP_CONFIG_ACTIVE, SMTP_CONFIG_INACTIVE]

    Default value: SMTP_CONFIG_STATE_UNSPECIFIED

    description string
    id string
curl -L 'https://$CUSTOM-DOMAIN/admin/v1/smtp' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/admin/v1
Auth
ResponseClear

Click the Send API Request button above and see the response here!