Skip to main content
POST
Test a Tableau connection configuration

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Body

application/json

A Tableau connection to add.

name
string
required

Display name for the connection, as shown throughout SELECT.

Minimum string length: 1
server_url
string
required

Base URL of the Tableau deployment to connect to, including the scheme and without a site path — for example https://us-east-1.online.tableau.com.

site_name
string
required

The site on that deployment to read. Use the site's URL name; pass Default for the default site of a Tableau Server deployment.

Minimum string length: 1
credentials
TableauCredentials · object
required

The personal access token SELECT authenticates with. Validated against Tableau before the connection is added.

sync_enabled
boolean
default:true

Whether SELECT starts syncing data for this connection.

query_sanitization_enabled
boolean
default:false

Whether query text is sanitized before SELECT stores it.

Response

Successful Response

The result of validating a connection's configuration against Tableau.

success
boolean
required

Whether every applicable check passed.

checks
TableauConnectionValidationCheck · object[]
required

The checks that ran, in the order they ran. Read top-down to find where setup stopped working.