Get Backup Configuration deprecated
GET/api/3.1/backup_configuration
backup_configuration()
Implementation Notes
WARNING: The Looker internal database backup function has been deprecated.
Response Class
BackupConfiguration {
can (object, read-only): Operations the current user is able to perform on this object,
type (string): Type of backup: looker-s3 or custom-s3,
custom_s3_bucket (string): Name of bucket for custom-s3 backups,
custom_s3_bucket_region (string): Name of region where the bucket is located,
custom_s3_key (string): (Write-Only) AWS S3 key used for custom-s3 backups,
custom_s3_secret (string): (Write-Only) AWS S3 secret used for custom-s3 backups,
url (string, read-only): Link to get this item
}
Parameters
None
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Update Backup Configuration deprecated
PATCH/api/3.1/backup_configuration
update_backup_configuration(body)
Implementation Notes
WARNING: The Looker internal database backup function has been deprecated.
Response Class
BackupConfiguration {
can (object, read-only): Operations the current user is able to perform on this object,
type (string): Type of backup: looker-s3 or custom-s3,
custom_s3_bucket (string): Name of bucket for custom-s3 backups,
custom_s3_bucket_region (string): Name of region where the bucket is located,
custom_s3_key (string): (Write-Only) AWS S3 key used for custom-s3 backups,
custom_s3_secret (string): (Write-Only) AWS S3 secret used for custom-s3 backups,
url (string, read-only): Link to get this item
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| body | true | Options for Backup Configuration | body |
BackupConfiguration {
can (object, read-only): Operations the current user is able to perform on this object, type (string): Type of backup: looker-s3 or custom-s3, custom_s3_bucket (string): Name of bucket for custom-s3 backups, custom_s3_bucket_region (string): Name of region where the bucket is located, custom_s3_key (string): (Write-Only) AWS S3 key used for custom-s3 backups, custom_s3_secret (string): (Write-Only) AWS S3 secret used for custom-s3 backups, url (string, read-only): Link to get this item }
|
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
Get Cloud Storage
GET/api/3.1/cloud_storage
cloud_storage_configuration()
Implementation Notes
Get the current Cloud Storage Configuration.
Response Class
BackupConfiguration {
can (object, read-only): Operations the current user is able to perform on this object,
type (string): Type of backup: looker-s3 or custom-s3,
custom_s3_bucket (string): Name of bucket for custom-s3 backups,
custom_s3_bucket_region (string): Name of region where the bucket is located,
custom_s3_key (string): (Write-Only) AWS S3 key used for custom-s3 backups,
custom_s3_secret (string): (Write-Only) AWS S3 secret used for custom-s3 backups,
url (string, read-only): Link to get this item
}
Parameters
None
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Update Cloud Storage
PATCH/api/3.1/cloud_storage
update_cloud_storage_configuration(body)
Implementation Notes
Update the current Cloud Storage Configuration.
Response Class
BackupConfiguration {
can (object, read-only): Operations the current user is able to perform on this object,
type (string): Type of backup: looker-s3 or custom-s3,
custom_s3_bucket (string): Name of bucket for custom-s3 backups,
custom_s3_bucket_region (string): Name of region where the bucket is located,
custom_s3_key (string): (Write-Only) AWS S3 key used for custom-s3 backups,
custom_s3_secret (string): (Write-Only) AWS S3 secret used for custom-s3 backups,
url (string, read-only): Link to get this item
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| body | true | Options for Cloud Storage Configuration | body |
BackupConfiguration {
can (object, read-only): Operations the current user is able to perform on this object, type (string): Type of backup: looker-s3 or custom-s3, custom_s3_bucket (string): Name of bucket for custom-s3 backups, custom_s3_bucket_region (string): Name of region where the bucket is located, custom_s3_key (string): (Write-Only) AWS S3 key used for custom-s3 backups, custom_s3_secret (string): (Write-Only) AWS S3 secret used for custom-s3 backups, url (string, read-only): Link to get this item }
|
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
Get Custom Welcome Email
GET/api/3.1/custom_welcome_email
custom_welcome_email()
Implementation Notes
Get the current status and content of custom welcome emails.
Response Class
CustomWelcomeEmail {
can (object, read-only): Operations the current user is able to perform on this object,
enabled (boolean): If true, custom email content will replace the default body of welcome emails,
content (string): The HTML to use as custom content for welcome emails. Script elements and other potentially dangerous markup will be removed.,
subject (string): The text to appear in the email subject line. Only available with a whitelabel license and whitelabel_configuration.advanced_custom_welcome_email enabled.,
header (string): The text to appear in the header line of the email body. Only available with a whitelabel license and whitelabel_configuration.advanced_custom_welcome_email enabled.
}
Parameters
None
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Update Custom Welcome Email Content
PATCH/api/3.1/custom_welcome_email
update_custom_welcome_email(body, send_test_welcome_email)
Implementation Notes
Update custom welcome email setting and values. Optionally send a test email with the new content to the currently logged in user.
Response Class
CustomWelcomeEmail {
can (object, read-only): Operations the current user is able to perform on this object,
enabled (boolean): If true, custom email content will replace the default body of welcome emails,
content (string): The HTML to use as custom content for welcome emails. Script elements and other potentially dangerous markup will be removed.,
subject (string): The text to appear in the email subject line. Only available with a whitelabel license and whitelabel_configuration.advanced_custom_welcome_email enabled.,
header (string): The text to appear in the header line of the email body. Only available with a whitelabel license and whitelabel_configuration.advanced_custom_welcome_email enabled.
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| body | true | Custom Welcome Email setting and value to save | body |
CustomWelcomeEmail {
can (object, read-only): Operations the current user is able to perform on this object, enabled (boolean): If true, custom email content will replace the default body of welcome emails, content (string): The HTML to use as custom content for welcome emails. Script elements and other potentially dangerous markup will be removed., subject (string): The text to appear in the email subject line. Only available with a whitelabel license and whitelabel_configuration.advanced_custom_welcome_email enabled., header (string): The text to appear in the header line of the email body. Only available with a whitelabel license and whitelabel_configuration.advanced_custom_welcome_email enabled. }
|
| send_test_welcome_email | false | If true a test email with the content from the request will be sent to the current user after saving | boolean | boolean |
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
| 429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Send a test welcome email to the currently logged in user with the supplied content
PUT/api/3.1/custom_welcome_email_test
update_custom_welcome_email_test(body)
Implementation Notes
Requests to this endpoint will send a welcome email with the custom content provided in the body to the currently logged in user.
Response Class
WelcomeEmailTest {
content (string): The content that would be sent in the body of a custom welcome email,
subject (string): The subject that would be sent for the custom welcome email,
header (string): The header that would be sent in the body of a custom welcome email
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| body | true | Subject, header, and Body of the email to be sent. | body |
WelcomeEmailTest {
content (string): The content that would be sent in the body of a custom welcome email, subject (string): The subject that would be sent for the custom welcome email, header (string): The header that would be sent in the body of a custom welcome email }
|
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
| 429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get Digest_emails
GET/api/3.1/digest_emails_enabled
digest_emails_enabled()
Implementation Notes
Retrieve the value for whether or not digest emails is enabled.
Response Class
DigestEmails {
is_enabled (boolean): Whether or not digest emails are enabled
}
Parameters
None
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Update Digest_emails
PATCH/api/3.1/digest_emails_enabled
update_digest_emails_enabled(body)
Implementation Notes
Update the setting for enabling/disabling digest emails.
Response Class
DigestEmails {
is_enabled (boolean): Whether or not digest emails are enabled
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| body | true | Digest_emails | body |
DigestEmails {
is_enabled (boolean): Whether or not digest emails are enabled }
|
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
| 429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Deliver digest email contents
POST/api/3.1/digest_email_send
create_digest_email_send()
Implementation Notes
Trigger the generation of digest email records and send them to Looker’s internal system. This does not send.
any actual emails, it generates records containing content which may be of interest for users who have become inactive. Emails will be sent at a later time from Looker’s internal system if the Digest Emails feature is enabled in settings.
Response Class
DigestEmailSend {
configuration_delivered (boolean): True if content was successfully generated and delivered
}
Parameters
None
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get Internal Help Resources Content
GET/api/3.1/internal_help_resources_content
internal_help_resources_content()
Implementation Notes
Set the menu item name and content for internal help resources.
Response Class
InternalHelpResourcesContent {
can (object, read-only): Operations the current user is able to perform on this object,
organization_name (string): Text to display in the help menu item which will display the internal help resources,
markdown_content (string): Content to be displayed in the internal help resources page/modal
}
Parameters
None
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Update internal help resources content
PATCH/api/3.1/internal_help_resources_content
update_internal_help_resources_content(body)
Implementation Notes
Update internal help resources content.
Response Class
InternalHelpResourcesContent {
can (object, read-only): Operations the current user is able to perform on this object,
organization_name (string): Text to display in the help menu item which will display the internal help resources,
markdown_content (string): Content to be displayed in the internal help resources page/modal
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| body | true | Internal Help Resources Content | body |
InternalHelpResourcesContent {
can (object, read-only): Operations the current user is able to perform on this object, organization_name (string): Text to display in the help menu item which will display the internal help resources, markdown_content (string): Content to be displayed in the internal help resources page/modal }
|
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
| 429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get Internal Help Resources
GET/api/3.1/internal_help_resources_enabled
internal_help_resources()
Implementation Notes
Get and set the options for internal help resources.
Response Class
InternalHelpResources {
can (object, read-only): Operations the current user is able to perform on this object,
enabled (boolean): If true and internal help resources content is not blank then the link for internal help resources will be shown in the help menu and the content displayed within Looker
}
Parameters
None
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Update internal help resources configuration
PATCH/api/3.1/internal_help_resources
update_internal_help_resources(body)
Implementation Notes
Update internal help resources settings.
Response Class
InternalHelpResources {
can (object, read-only): Operations the current user is able to perform on this object,
enabled (boolean): If true and internal help resources content is not blank then the link for internal help resources will be shown in the help menu and the content displayed within Looker
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| body | true | Custom Welcome Email | body |
InternalHelpResources {
can (object, read-only): Operations the current user is able to perform on this object, enabled (boolean): If true and internal help resources content is not blank then the link for internal help resources will be shown in the help menu and the content displayed within Looker }
|
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
| 429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get All Legacy Features
GET/api/3.1/legacy_features
all_legacy_features()
Implementation Notes
Get all legacy features.
Response Class
array
Parameters
None
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get Legacy Feature
GET/api/3.1/legacy_features/{legacy_feature_id}
legacy_feature(legacy_feature_id)
Implementation Notes
Get information about the legacy feature with a specific id.
Response Class
LegacyFeature {
can (object, read-only): Operations the current user is able to perform on this object,
id (string, read-only): Unique Id,
name (string, read-only): Name,
description (string, read-only): Description,
enabled_locally (boolean): Whether this feature has been enabled by a user,
enabled (boolean, read-only): Whether this feature is currently enabled,
disallowed_as_of_version (string, read-only): Looker version where this feature became a legacy feature,
disable_on_upgrade_to_version (string, read-only): Looker version where this feature will be automatically disabled,
end_of_life_version (string, read-only): Future Looker version where this feature will be removed,
documentation_url (string, read-only): URL for documentation about this feature,
approximate_disable_date (date-time, read-only): Approximate date that this feature will be automatically disabled.,
approximate_end_of_life_date (date-time, read-only): Approximate date that this feature will be removed.,
has_disabled_on_upgrade (boolean, read-only): Whether this legacy feature may have been automatically disabled when upgrading to the current version.
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| legacy_feature_id | true | id of legacy feature | integer | int64 |
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Update Legacy Feature
PATCH/api/3.1/legacy_features/{legacy_feature_id}
update_legacy_feature(legacy_feature_id, body)
Implementation Notes
Update information about the legacy feature with a specific id.
Response Class
LegacyFeature {
can (object, read-only): Operations the current user is able to perform on this object,
id (string, read-only): Unique Id,
name (string, read-only): Name,
description (string, read-only): Description,
enabled_locally (boolean): Whether this feature has been enabled by a user,
enabled (boolean, read-only): Whether this feature is currently enabled,
disallowed_as_of_version (string, read-only): Looker version where this feature became a legacy feature,
disable_on_upgrade_to_version (string, read-only): Looker version where this feature will be automatically disabled,
end_of_life_version (string, read-only): Future Looker version where this feature will be removed,
documentation_url (string, read-only): URL for documentation about this feature,
approximate_disable_date (date-time, read-only): Approximate date that this feature will be automatically disabled.,
approximate_end_of_life_date (date-time, read-only): Approximate date that this feature will be removed.,
has_disabled_on_upgrade (boolean, read-only): Whether this legacy feature may have been automatically disabled when upgrading to the current version.
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| legacy_feature_id | true | id of legacy feature | integer | int64 |
| body | true | Legacy Feature | body |
LegacyFeature {
can (object, read-only): Operations the current user is able to perform on this object, id (string, read-only): Unique Id, name (string, read-only): Name, description (string, read-only): Description, enabled_locally (boolean): Whether this feature has been enabled by a user, enabled (boolean, read-only): Whether this feature is currently enabled, disallowed_as_of_version (string, read-only): Looker version where this feature became a legacy feature, disable_on_upgrade_to_version (string, read-only): Looker version where this feature will be automatically disabled, end_of_life_version (string, read-only): Future Looker version where this feature will be removed, documentation_url (string, read-only): URL for documentation about this feature, approximate_disable_date (date-time, read-only): Approximate date that this feature will be automatically disabled., approximate_end_of_life_date (date-time, read-only): Approximate date that this feature will be removed., has_disabled_on_upgrade (boolean, read-only): Whether this legacy feature may have been automatically disabled when upgrading to the current version. }
|
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
| 429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get All Locales
GET/api/3.1/locales
all_locales()
Implementation Notes
Get a list of locales that Looker supports.
Response Class
array
Parameters
None
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Set SMTP Setting
POST/api/3.1/smtp_settings
set_smtp_settings(body)
Implementation Notes
Configure SMTP Settings.
This API allows users to configure the SMTP settings on the Looker instance. This API is only supported in the OEM jar. Additionally, only admin users are authorised to call this API.
Response Class
None
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| body | true | SMTP Setting Configuration | body |
SmtpSettings {
address (string): SMTP Server url, from (string): From e-mail address, user_name (string): User name, password (string): Password, port (long): 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". }
|
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 409 | Resource Already Exists |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
| 429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 403 | Permission Denied |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 204 | Successfully updated SMTP settings |
Get All Timezones
GET/api/3.1/timezones
all_timezones()
Implementation Notes
Get a list of timezones that Looker supports (e.g. useful for scheduling tasks).
Response Class
array
Parameters
None
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get ApiVersion
GET/api/3.1/versions
versions(fields)
Implementation Notes
Get information about all API versions supported by this Looker instance.
Response Class
ApiVersion {
ApiVersionElement {
looker_release_version (string, read-only): Current Looker release version number,
current_version (ApiVersionElement, read-only): Current version for this Looker instance,
supported_versions (Array[ApiVersionElement], read-only): Array of versions supported by this Looker instance,
api_server_url (string, read-only): API server base url,
web_server_url (string, read-only): Web server base url
}ApiVersionElement {
version (string, read-only): Version number as it appears in '/api/xxx/' urls,
full_version (string, read-only): Full version number including minor version,
status (string, read-only): Status of this version,
swagger_url (string, read-only): Url for swagger.json for this version
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| fields | false | Requested fields. | string | string |
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get Whitelabel configuration
GET/api/3.1/whitelabel_configuration
whitelabel_configuration(fields)
Implementation Notes
This feature is enabled only by special license.
Gets the whitelabel configuration, which includes hiding documentation links, custom favicon uploading, etc.
Response Class
WhitelabelConfiguration {
id (long, read-only): Unique Id,
logo_file (string): Customer logo image. Expected base64 encoded data (write-only),
logo_url (string, read-only): Logo image url (read-only),
favicon_file (string): Custom favicon image. Expected base64 encoded data (write-only),
favicon_url (string, read-only): Favicon image url (read-only),
default_title (string): Default page title,
show_help_menu (boolean): Boolean to toggle showing help menus,
show_docs (boolean): Boolean to toggle showing docs,
show_email_sub_options (boolean): Boolean to toggle showing email subscription options.,
allow_looker_mentions (boolean): Boolean to toggle mentions of Looker in emails,
allow_looker_links (boolean): Boolean to toggle links to Looker in emails,
custom_welcome_email_advanced (boolean): Allow subject line and email heading customization in customized emails”,
setup_mentions (boolean): Remove the word Looker from appearing in the account setup page,
alerts_logo (boolean): Remove Looker logo from Alerts,
alerts_links (boolean): Remove Looker links from Alerts,
folders_mentions (boolean): Remove Looker mentions in home folder page when you don’t have any items saved
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| fields | false | Requested fields. | string | string |
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Update Whitelabel configuration
PUT/api/3.1/whitelabel_configuration
update_whitelabel_configuration(body)
Implementation Notes
Update the whitelabel configuration.
Response Class
WhitelabelConfiguration {
id (long, read-only): Unique Id,
logo_file (string): Customer logo image. Expected base64 encoded data (write-only),
logo_url (string, read-only): Logo image url (read-only),
favicon_file (string): Custom favicon image. Expected base64 encoded data (write-only),
favicon_url (string, read-only): Favicon image url (read-only),
default_title (string): Default page title,
show_help_menu (boolean): Boolean to toggle showing help menus,
show_docs (boolean): Boolean to toggle showing docs,
show_email_sub_options (boolean): Boolean to toggle showing email subscription options.,
allow_looker_mentions (boolean): Boolean to toggle mentions of Looker in emails,
allow_looker_links (boolean): Boolean to toggle links to Looker in emails,
custom_welcome_email_advanced (boolean): Allow subject line and email heading customization in customized emails”,
setup_mentions (boolean): Remove the word Looker from appearing in the account setup page,
alerts_logo (boolean): Remove Looker logo from Alerts,
alerts_links (boolean): Remove Looker links from Alerts,
folders_mentions (boolean): Remove Looker mentions in home folder page when you don’t have any items saved
}
Parameters
| Parameter | Required? | Description | Parameter Type | Data Type |
|---|---|---|---|---|
| body | true | Whitelabel configuration | body |
WhitelabelConfiguration {
id (long, read-only): Unique Id, logo_file (string): Customer logo image. Expected base64 encoded data (write-only), logo_url (string, read-only): Logo image url (read-only), favicon_file (string): Custom favicon image. Expected base64 encoded data (write-only), favicon_url (string, read-only): Favicon image url (read-only), default_title (string): Default page title, show_help_menu (boolean): Boolean to toggle showing help menus, show_docs (boolean): Boolean to toggle showing docs, show_email_sub_options (boolean): Boolean to toggle showing email subscription options., allow_looker_mentions (boolean): Boolean to toggle mentions of Looker in emails, allow_looker_links (boolean): Boolean to toggle links to Looker in emails, custom_welcome_email_advanced (boolean): Allow subject line and email heading customization in customized emails”, setup_mentions (boolean): Remove the word Looker from appearing in the account setup page, alerts_logo (boolean): Remove Looker logo from Alerts, alerts_links (boolean): Remove Looker links from Alerts, folders_mentions (boolean): Remove Looker mentions in home folder page when you don’t have any items saved }
|
Response Messages
| HTTP Status Code | Reason | Response Model |
|---|---|---|
| 400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
| 422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
| 429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|