Skip to main content

Deprecated: List SMTP Configs

POST 

/smtp/_search

deprecated

Returns a list of SMTP configurations.

Deprecated: please move to the new endpoint ListEmailProviders.

Request​

Body

required

    query

    object

    Object unspecific list filters like offset, limit and asc/desc.

    offset uint64
    limit int64

    Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

    asc boolean

    default is descending

Responses​

A successful response.

Schema

    details

    object

    totalResult uint64
    processedSequence uint64
    viewTimestamp date-time

    the last time the view got updated

    result

    object[]

  • Array [

  • 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
  • ]

Loading...