Set SMTP Setting
Stay organized with collections
Save and categorize content based on your preferences.
Version 4.0.25.14 (latest)
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
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
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
message
lock
string
Error details
documentation_url
lock
string
Documentation link
403: Permission Denied
message
lock
string
Error details
documentation_url
lock
string
Documentation link
404: Not Found
message
lock
string
Error details
documentation_url
lock
string
Documentation link
409: Resource Already Exists
message
lock
string
Error details
documentation_url
lock
string
Documentation link
422: Validation Error
message
lock
string
Error details
Expand ValidationErrorDetail definition...
field
lock
string
Field with error
code
lock
string
Error code
message
lock
string
Error info message
documentation_url
lock
string
Documentation link
documentation_url
lock
string
Documentation link
429: Too Many Requests
message
lock
string
Error details
documentation_url
lock
string
Documentation link
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[],[],null,["# Set SMTP Setting\n\nVersion 4.0.25.14 (latest)\n\n### Configure SMTP Settings\n\nThis API allows users to configure the SMTP settings on the Looker instance.\nOnly admin users are authorised to call this API.\n\nRequest\n-------\n\nPOST /smtp_settings \nDatatype \nDescription \nRequest \nHTTP Request \nbody \nHTTP Body \nExpand HTTP Body definition... \nbody \n[SmtpSettings](/looker/docs/reference/looker-api/latest/types/SmtpSettings) \nSMTP Setting Configuration\nExpand SmtpSettings definition... \naddress \nstring \nSMTP Server url \nfrom \nstring \nFrom e-mail address \nuser_name \nstring \nUser name \npassword \nstring \nPassword \nport \ninteger \nSMTP Server's port \nenable_starttls_auto \nboolean \nIs TLS encryption enabled? \nssl_version \nstring \nTLS version selected Valid values are: \"TLSv1_1\", \"SSLv23\", \"TLSv1_2\". \ndefault_smtp \nboolean \nWhether to enable built-in Looker SMTP\n\nResponse\n--------\n\n### 204: Successfully updated SMTP settings\n\n### 400: Bad Request\n\nDatatype \nDescription \n(object) \n[Error](/looker/docs/reference/looker-api/latest/types/Error) \nmessage \n*lock* \nstring \nError details \ndocumentation_url \n*lock* \nstring \nDocumentation link\n\n### 403: Permission Denied\n\nDatatype \nDescription \n(object) \n[Error](/looker/docs/reference/looker-api/latest/types/Error) \nmessage \n*lock* \nstring \nError details \ndocumentation_url \n*lock* \nstring \nDocumentation link\n\n### 404: Not Found\n\nDatatype \nDescription \n(object) \n[Error](/looker/docs/reference/looker-api/latest/types/Error) \nmessage \n*lock* \nstring \nError details \ndocumentation_url \n*lock* \nstring \nDocumentation link\n\n### 409: Resource Already Exists\n\nDatatype \nDescription \n(object) \n[Error](/looker/docs/reference/looker-api/latest/types/Error) \nmessage \n*lock* \nstring \nError details \ndocumentation_url \n*lock* \nstring \nDocumentation link\n\n### 422: Validation Error\n\nDatatype \nDescription \n(object) \n[ValidationError](/looker/docs/reference/looker-api/latest/types/ValidationError) \nmessage \n*lock* \nstring \nError details \nerrors \n[ValidationErrorDetail](/looker/docs/reference/looker-api/latest/types/ValidationErrorDetail)\\[\\] \nExpand ValidationErrorDetail definition... \nfield \n*lock* \nstring \nField with error \ncode \n*lock* \nstring \nError code \nmessage \n*lock* \nstring \nError info message \ndocumentation_url \n*lock* \nstring \nDocumentation link \ndocumentation_url \n*lock* \nstring \nDocumentation link\n\n### 429: Too Many Requests\n\nDatatype \nDescription \n(object) \n[Error](/looker/docs/reference/looker-api/latest/types/Error) \nmessage \n*lock* \nstring \nError details \ndocumentation_url \n*lock* \nstring \nDocumentation link"]]
