ZITADEL Docs
APIsCore ResourcesV1Instance Objects

ListSMTPConfigs

Deprecated: List SMTP Configs

Returns a list of SMTP configurations.

Deprecated: please move to the new endpoint ListEmailProviders.

POST
/smtp/_search

Request Body

application/json

query?
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/smtp/_search" \  -H "Content-Type: application/json" \  -d '{}'
{
  "details": {
    "totalResult": 0,
    "processedSequence": 0,
    "viewTimestamp": "1s"
  },
  "result": [
    {
      "details": {
        "sequence": 0,
        "creationDate": "1s",
        "changeDate": "1s",
        "resourceOwner": "string"
      },
      "senderAddress": "string",
      "senderName": "string",
      "tls": true,
      "host": "string",
      "user": "string",
      "replyToAddress": "string",
      "state": "SMTP_CONFIG_STATE_UNSPECIFIED",
      "description": "string",
      "id": "string"
    }
  ]
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?