Set SMTP Setting

Version 4.0.24.16

Configure SMTP Settings

This API allows users to configure the SMTP settings on the Looker instance. Only admin users are authorised to call this API.

Request

POST /smtp_settings
Datatype
Description
Request
HTTP Request
body
HTTP Body
Expand HTTP Body definition...
body
SMTP Setting Configuration
Expand SmtpSettings definition...
address
string
SMTP Server url
from
string
From e-mail address
user_name
string
User name
password
string
Password
port
integer
SMTP Server's port
enable_starttls_auto
boolean
Is TLS encryption enabled?
ssl_version
string
TLS version selected Valid values are: "TLSv1_1", "SSLv23", "TLSv1_2".
default_smtp
boolean
Whether to enable built-in Looker SMTP

Response

204: Successfully updated SMTP settings

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

403: Permission Denied

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

409: Resource Already Exists

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

422: Validation Error

Datatype
Description
(object)
message
string
Error details
Expand ValidationErrorDetail definition...
field
string
Field with error
code
string
Error code
message
string
Error info message
documentation_url
string
Documentation link
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link