db_connection_override for this connection in the `pdt` maintenance context
managed
lock
boolean
Is this connection created and managed by Looker
custom_local_port
integer
This field is only applicable to connections over an SSH Tunnel. The value of this field would be the local port associated with the SSH tunnel if configured manually. Otherwise either enter NULL or exclude this field.
Maximum number of threads to use to build PDTs in parallel
disable_context_comment
boolean
When disable_context_comment is true comment will not be added to SQL
oauth_application_id
string
An External OAuth Application to use for authenticating to the database
always_retry_failed_builds
boolean
When true, error PDTs will be retried every regenerator cycle
uses_application_default_credentials
boolean
Whether the connection should authenticate with the Application Default Credentials of the host environment (limited to GCP and certain dialects).
impersonated_service_account
string
An alternative Service Account to use for querying datasets (used primarily with `uses_application_default_credentials`) (limited to GCP and certain dialects).
cost_estimate_enabled
boolean
When true, query cost estimate will be displayed in explore.
pdt_api_control_enabled
boolean
PDT builds on this connection can be kicked off and cancelled via API.
connection_pooling
boolean
Enable database connection pooling.
default_bq_connection
lock
boolean
When true, represents that this connection is the default BQ connection.
bq_storage_project_id
string
The project id of the default BigQuery storage project.
bq_roles_verified
boolean
When true, represents that all project roles have been verified.
p4sa_name
lock
string
The name of P4SA service account that is associated with the Looker instance
[[["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,["# Test Connection Configuration\n\nVersion 4.0.25.14 (latest)\n\n### Test a connection configuration.\n\nNote that a connection's 'dialect' property has a 'connection_tests' property that lists the\nspecific types of tests that the connection supports.\n\nThis API is rate limited.\n\nUnsupported tests in the request will be ignored.\n\nRequest\n-------\n\nPUT /connections/test \nDatatype \nDescription \nRequest \nHTTP Request \nbody \nHTTP Body \nExpand HTTP Body definition... \nbody \n[DBConnection](/looker/docs/reference/looker-api/latest/types/DBConnection) \nConnection\nExpand DBConnection definition... \ncan \n*lock* \nobject \nOperations the current user is able to perform on this object \nname \nstring \nName of the connection. Also used as the unique identifier \ndialect \n*lock* \n[Dialect](/looker/docs/reference/looker-api/latest/types/Dialect) \n(Read-only) SQL Dialect details \nsnippets \n[Snippet](/looker/docs/reference/looker-api/latest/types/Snippet)\\[\\] \npdts_enabled \n*lock* \nboolean \nTrue if PDTs are enabled on this connection \nnamed_driver_version_requested \nstring \nRequested JDBC driver version name \nnamed_driver_version_actual \n*lock* \nstring \nResolved JDBC driver version \nhost \nstring \nHost name/address of server; or the string 'localhost' in case of a connection over an SSH tunnel. \nport \nstring \nPort number on server. If the connection is over an SSH tunnel, then the local port associated with the SSH tunnel. \nusername \nstring \nUsername for server authentication \npassword \nstring \n(Write-Only) Password for server authentication \nuses_oauth \n*lock* \nboolean \nWhether the connection uses OAuth for authentication. \nuses_key_pair_auth \nboolean \nWhether the connection uses key-pair for authentication. \nuses_instance_oauth \n*lock* \nboolean \nWhether the integration uses the oauth instance account. \nuses_service_auth \n*lock* \nboolean \nWhether the connection uses service authentication certificate. \ncertificate \nstring \n(Write-Only) Base64 encoded Certificate body for server authentication (when appropriate for dialect). \nfile_type \nstring \n(Write-Only) Certificate keyfile type - .json, .p8 or .p12 \ndatabase \nstring \nDatabase name \ndb_timezone \nstring \nTime zone of database \nquery_timezone \nstring \nTimezone to use in queries \nschema \nstring \nSchema name \nmax_connections \ninteger \nMaximum number of concurrent connection to use \nmax_queries \ninteger \nMaximum number of concurrent queries to begin on this connection \nmax_queries_per_user \ninteger \nMaximum number of concurrent queries per user to begin on this connection \nmax_billing_gigabytes \nstring \nMaximum size of query in GBs (BigQuery only, can be a user_attribute name) \nssl \nboolean \nUse SSL/TLS when connecting to server \nverify_ssl \nboolean \nVerify the SSL \ntmp_db_name \nstring \nName of temporary database (if used) \ntmp_db_host \nstring \nName of temporary host (if used) \njdbc_additional_params \nstring \nAdditional params to add to JDBC connection string \npool_timeout \ninteger \nConnection Pool Timeout, in seconds \ndialect_name \nstring \n(Read/Write) SQL Dialect name \nsupports_data_studio_link \n*lock* \nboolean \nDatabase connection has the ability to support open data studio from explore \ncreated_at \n*lock* \nstring \nCreation date for this connection \nuser_id \n*lock* \nstring \nId of user who last modified this connection configuration \nexample \n*lock* \nboolean \nIs this an example connection? \nuser_db_credentials \nboolean \n(Limited access feature) Are per user db credentials enabled. Enabling will remove previously set username and password \nuser_attribute_fields \nstring\\[\\] \nmaintenance_cron \nstring \nCron string specifying when maintenance such as PDT trigger checks and drops should be performed \nlast_regen_at \n*lock* \nstring \nUnix timestamp at start of last completed PDT trigger check process \nlast_reap_at \n*lock* \nstring \nUnix timestamp at start of last completed PDT reap process \nsql_runner_precache_tables \nboolean \nPrecache tables in the SQL Runner \nsql_writing_with_info_schema \nboolean \nFetch Information Schema For SQL Writing \nafter_connect_statements \nstring \nSQL statements (semicolon separated) to issue after connecting to the database. Requires \\`custom_after_connect_statements\\` license feature \npdt_context_override \n[DBConnectionOverride](/looker/docs/reference/looker-api/latest/types/DBConnectionOverride) \ndb_connection_override for this connection in the \\`pdt\\` maintenance context \nmanaged \n*lock* \nboolean \nIs this connection created and managed by Looker \ncustom_local_port \ninteger \nThis field is only applicable to connections over an SSH Tunnel. The value of this field would be the local port associated with the SSH tunnel if configured manually. Otherwise either enter NULL or exclude this field. \ntunnel_id \nstring \nThe Id of the ssh tunnel this connection uses \nuses_tns \nboolean \nEnable Transparent Network Substrate (TNS) connections \npdt_concurrency \ninteger \nMaximum number of threads to use to build PDTs in parallel \ndisable_context_comment \nboolean \nWhen disable_context_comment is true comment will not be added to SQL \noauth_application_id \nstring \nAn External OAuth Application to use for authenticating to the database \nalways_retry_failed_builds \nboolean \nWhen true, error PDTs will be retried every regenerator cycle \nuses_application_default_credentials \nboolean \nWhether the connection should authenticate with the Application Default Credentials of the host environment (limited to GCP and certain dialects). \nimpersonated_service_account \nstring \nAn alternative Service Account to use for querying datasets (used primarily with \\`uses_application_default_credentials\\`) (limited to GCP and certain dialects). \ncost_estimate_enabled \nboolean \nWhen true, query cost estimate will be displayed in explore. \npdt_api_control_enabled \nboolean \nPDT builds on this connection can be kicked off and cancelled via API. \nconnection_pooling \nboolean \nEnable database connection pooling. \ndefault_bq_connection \n*lock* \nboolean \nWhen true, represents that this connection is the default BQ connection. \nbq_storage_project_id \nstring \nThe project id of the default BigQuery storage project. \nbq_roles_verified \nboolean \nWhen true, represents that all project roles have been verified. \np4sa_name \n*lock* \nstring \nThe name of P4SA service account that is associated with the Looker instance \nquery_holding_disabled \nboolean \nDisable query holding for this connection. \nquery \nHTTP Query \nExpand HTTP Query definition... \ntests \nstring\\[\\] \n\nResponse\n--------\n\n### 200: Test results\n\nDatatype \nDescription \n(array) \n[DBConnectionTestResult](/looker/docs/reference/looker-api/latest/types/DBConnectionTestResult)\\[\\] \ncan \n*lock* \nobject \nOperations the current user is able to perform on this object \nconnection_string \n*lock* \nstring \nJDBC connection string. (only populated in the 'connect' test) \nmessage \n*lock* \nstring \nResult message of test \nname \n*lock* \nstring \nName of test \nstatus \n*lock* \nstring \nResult code of test\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### 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### 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"]]
