User Guide Getting Started Help Center Documentation Community Training
Looker
  
English
Français
Deutsch
日本語
Config : Manage General Configuration

Get Backup Configuration

GET/api/3.1/backup_configuration
backup_configuration()

Implementation Notes

Get the current Looker internal database backup configuration.

Response Class

BackupConfiguration {
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,
can (object, read-only): Operations the current user is able to perform on this object
}

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

PATCH/api/3.1/backup_configuration
update_backup_configuration(body)

Implementation Notes

Update the Looker internal database backup configuration.

Response Class

BackupConfiguration {
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,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
body true Options for Backup Configuration body
BackupConfiguration {
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,
can (object, read-only): Operations the current user is able to perform on this object
}

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 Internal Help Resources Content beta

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 {
menu_item_text (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,
can (object, read-only): Operations the current user is able to perform on this object
}

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 beta

PATCH/api/3.1/internal_help_resources_content
update_internal_help_resources_content(body)

Implementation Notes

Update internal help resources content.

Response Class

InternalHelpResourcesContent {
menu_item_text (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,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
body true Internal Help Resources Content body
InternalHelpResourcesContent {
menu_item_text (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,
can (object, read-only): Operations the current user is able to perform on this object
}

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 Internal Help Resources beta

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 {
enabled (boolean): If true and internal help resources content is not blank then the link for internal help resources will be show in the help menu and the content displayed within Looker,
can (object, read-only): Operations the current user is able to perform on this object
}

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 beta

PATCH/api/3.1/internal_help_resources
update_internal_help_resources(body)

Implementation Notes

Update internal help resources settings.

Response Class

InternalHelpResources {
enabled (boolean): If true and internal help resources content is not blank then the link for internal help resources will be show in the help menu and the content displayed within Looker,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
body true Custom Welcome Email body
InternalHelpResources {
enabled (boolean): If true and internal help resources content is not blank then the link for internal help resources will be show in the help menu and the content displayed within Looker,
can (object, read-only): Operations the current user is able to perform on this object
}

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 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 {
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.,
can (object, read-only): Operations the current user is able to perform on this object
}

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 {
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.,
can (object, read-only): Operations the current user is able to perform on this object
}

Parameters

Parameter Required? Description Parameter Type Data Type
legacy_feature_id true id of legacy feature integer int64
body true Legacy Feature body
LegacyFeature {
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.,
can (object, read-only): Operations the current user is able to perform on this object
}

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 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
}

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 {
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
}
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 beta

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,
can (object, read-only): Operations the current user is able to perform on this object
}

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 beta

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,
can (object, read-only): Operations the current user is able to perform on this object
}

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,
can (object, read-only): Operations the current user is able to perform on this object
}

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
}
Top