Get All Connections

GET/api/3.1/connections

all_connections(fields)

Implementation Notes

Get information about all connections.

Response Class

  array

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 }

Create Connection

POST/api/3.1/connections

create_connection(body)

Implementation Notes

Create a connection using the specified configuration.

Response Class

DBConnection {

can (object, read-only): Operations the current user is able to perform on this object,

name (string): Name of the connection. Also used as the unique identifier,

dialect (Dialect, read-only): (Read-only) SQL Dialect details,

snippets (Array[Snippet], read-only): SQL Runner snippets for this connection,

pdts_enabled (boolean, read-only): True if PDTs are enabled on this connection,

host (string): Host name/address of server,

port (string): Port number on server,

username (string): Username for server authentication,

password (string): (Write-Only) Password for server authentication,

uses_oauth (boolean, read-only): Whether the connection uses OAuth for authentication.,

certificate (string): (Write-Only) Base64 encoded Certificate body for server authentication (when appropriate for dialect).,

file_type (string): (Write-Only) Certificate keyfile type - .json or .p12,

database (string): Database name,

db_timezone (string): Time zone of database,

query_timezone (string): Timezone to use in queries,

schema (string): Scheme name,

max_connections (long): Maximum number of concurrent connection to use,

max_billing_gigabytes (string): Maximum size of query in GBs (BigQuery only, can be a user_attribute name),

ssl (boolean): Use SSL/TLS when connecting to server,

verify_ssl (boolean): Verify the SSL,

tmp_db_name (string): Name of temporary database (if used),

jdbc_additional_params (string): Additional params to add to JDBC connection string,

pool_timeout (long): Connection Pool Timeout, in seconds,

dialect_name (string): (Read/Write) SQL Dialect name,

created_at (string, read-only): Creation date for this connection,

user_id (string, read-only): Id of user who last modified this connection configuration,

example (boolean, read-only): Is this an example connection?,

user_db_credentials (boolean): (Limited access feature) Are per user db credentials enabled. Enabling will remove previously set username and password,

user_attribute_fields (Array[string]): Fields whose values map to user attribute names,

maintenance_cron (string): Cron string specifying when maintenance such as PDT trigger checks and drops should be performed,

last_regen_at (string, read-only): Unix timestamp at start of last completed PDT trigger check process,

last_reap_at (string, read-only): Unix timestamp at start of last completed PDT reap process,

sql_runner_precache_tables (boolean): Precache tables in the SQL Runner,

sql_writing_with_info_schema (boolean): Fetch Information Schema For SQL Writing,

after_connect_statements (string): SQL statements (semicolon separated) to issue after connecting to the database. Requires custom_after_connect_statements license feature,

pdt_context_override (DBConnectionOverride): db_connection_override for this connection in the pdt maintenance context,

managed (boolean, read-only): Is this connection created and managed by Looker

}
Dialect {

name (string, read-only): The name of the dialect,

label (string, read-only): The human-readable label of the connection,

supports_cost_estimate (boolean, read-only): Whether the dialect supports query cost estimates,

cost_estimate_style (string, read-only): How the dialect handles cost estimation,

persistent_table_indexes (string, read-only): PDT index columns,

persistent_table_sortkeys (string, read-only): PDT sortkey columns,

persistent_table_distkey (string, read-only): PDT distkey column,

supports_streaming (boolean, read-only): Suports streaming results,

automatically_run_sql_runner_snippets (boolean, read-only): Should SQL Runner snippets automatically be run,

connection_tests (Array[string], read-only): Array of names of the tests that can be run on a connection using this dialect,

supports_inducer (boolean, read-only): Is supported with the inducer (i.e. generate from sql),

supports_multiple_databases (boolean, read-only): Can multiple databases be accessed from a connection using this dialect,

supports_persistent_derived_tables (boolean, read-only): Whether the dialect supports allowing Looker to build persistent derived tables,

has_ssl_support (boolean, read-only): Does the database have client SSL support settable through the JDBC string explicitly?

}
Snippet {

name (string, read-only): Name of the snippet,

label (string, read-only): Label of the snippet,

sql (string, read-only): SQL text of the snippet,

can (object, read-only): Operations the current user is able to perform on this object

}
DBConnectionOverride {

context (string): Context in which to override (pdt is the only allowed value),

host (string): Host name/address of server,

port (string): Port number on server,

username (string): Username for server authentication,

password (string): (Write-Only) Password for server authentication,

has_password (boolean, read-only): Whether or not the password is overridden in this context,

certificate (string): (Write-Only) Base64 encoded Certificate body for server authentication (when appropriate for dialect).,

file_type (string): (Write-Only) Certificate keyfile type - .json or .p12,

database (string): Database name,

schema (string): Scheme name,

jdbc_additional_params (string): Additional params to add to JDBC connection string,

after_connect_statements (string): SQL statements (semicolon separated) to issue after connecting to the database. Requires custom_after_connect_statements license feature

}

Parameters

Parameter	Required?	Description	Parameter Type	Data Type
body	true	Connection	body	DBConnection { can (object, read-only): Operations the current user is able to perform on this object, name (string): Name of the connection. Also used as the unique identifier, dialect (Dialect, read-only): (Read-only) SQL Dialect details, snippets (Array[Snippet], read-only): SQL Runner snippets for this connection, pdts_enabled (boolean, read-only): True if PDTs are enabled on this connection, host (string): Host name/address of server, port (string): Port number on server, username (string): Username for server authentication, password (string): (Write-Only) Password for server authentication, uses_oauth (boolean, read-only): Whether the connection uses OAuth for authentication., certificate (string): (Write-Only) Base64 encoded Certificate body for server authentication (when appropriate for dialect)., file_type (string): (Write-Only) Certificate keyfile type - .json or .p12, database (string): Database name, db_timezone (string): Time zone of database, query_timezone (string): Timezone to use in queries, schema (string): Scheme name, max_connections (long): Maximum number of concurrent connection to use, max_billing_gigabytes (string): Maximum size of query in GBs (BigQuery only, can be a user_attribute name), ssl (boolean): Use SSL/TLS when connecting to server, verify_ssl (boolean): Verify the SSL, tmp_db_name (string): Name of temporary database (if used), jdbc_additional_params (string): Additional params to add to JDBC connection string, pool_timeout (long): Connection Pool Timeout, in seconds, dialect_name (string): (Read/Write) SQL Dialect name, created_at (string, read-only): Creation date for this connection, user_id (string, read-only): Id of user who last modified this connection configuration, example (boolean, read-only): Is this an example connection?, user_db_credentials (boolean): (Limited access feature) Are per user db credentials enabled. Enabling will remove previously set username and password, user_attribute_fields (Array[string]): Fields whose values map to user attribute names, maintenance_cron (string): Cron string specifying when maintenance such as PDT trigger checks and drops should be performed, last_regen_at (string, read-only): Unix timestamp at start of last completed PDT trigger check process, last_reap_at (string, read-only): Unix timestamp at start of last completed PDT reap process, sql_runner_precache_tables (boolean): Precache tables in the SQL Runner, sql_writing_with_info_schema (boolean): Fetch Information Schema For SQL Writing, after_connect_statements (string): SQL statements (semicolon separated) to issue after connecting to the database. Requires `custom_after_connect_statements` license feature, pdt_context_override (DBConnectionOverride): db_connection_override for this connection in the `pdt` maintenance context, managed (boolean, read-only): Is this connection created and managed by Looker } Dialect { name (string, read-only): The name of the dialect, label (string, read-only): The human-readable label of the connection, supports_cost_estimate (boolean, read-only): Whether the dialect supports query cost estimates, cost_estimate_style (string, read-only): How the dialect handles cost estimation, persistent_table_indexes (string, read-only): PDT index columns, persistent_table_sortkeys (string, read-only): PDT sortkey columns, persistent_table_distkey (string, read-only): PDT distkey column, supports_streaming (boolean, read-only): Suports streaming results, automatically_run_sql_runner_snippets (boolean, read-only): Should SQL Runner snippets automatically be run, connection_tests (Array[string], read-only): Array of names of the tests that can be run on a connection using this dialect, supports_inducer (boolean, read-only): Is supported with the inducer (i.e. generate from sql), supports_multiple_databases (boolean, read-only): Can multiple databases be accessed from a connection using this dialect, supports_persistent_derived_tables (boolean, read-only): Whether the dialect supports allowing Looker to build persistent derived tables, has_ssl_support (boolean, read-only): Does the database have client SSL support settable through the JDBC string explicitly? } Snippet { name (string, read-only): Name of the snippet, label (string, read-only): Label of the snippet, sql (string, read-only): SQL text of the snippet, can (object, read-only): Operations the current user is able to perform on this object } DBConnectionOverride { context (string): Context in which to override (`pdt` is the only allowed value), host (string): Host name/address of server, port (string): Port number on server, username (string): Username for server authentication, password (string): (Write-Only) Password for server authentication, has_password (boolean, read-only): Whether or not the password is overridden in this context, certificate (string): (Write-Only) Base64 encoded Certificate body for server authentication (when appropriate for dialect)., file_type (string): (Write-Only) Certificate keyfile type - .json or .p12, database (string): Database name, schema (string): Scheme name, jdbc_additional_params (string): Additional params to add to JDBC connection string, after_connect_statements (string): SQL statements (semicolon separated) to issue after connecting to the database. Requires `custom_after_connect_statements` license feature }

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 }

Get Connection

GET/api/3.1/connections/{connection_name}

connection(connection_name, fields)

Implementation Notes

Get information about a connection.