Skip to main content
GET
Get a Tableau connection

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Path Parameters

tableau_connection_id
string
required

Response

Successful Response

A connection to one Tableau site.

id
string
required
read-only

The unique identifier of the connection.

etag
string
required
read-only

Opaque strong ETag for this connection's configuration. Matches the ETag response header, and is what If-Match requires on a write. It changes whenever a configurable field on the connection changes.

name
string
required

Display name for the connection, as shown throughout SELECT.

connection_id
string
required
read-only

Identifier of the connection resource this Tableau connection belongs to (see GET /v2/connections/{connection_id}). Distinct from id, which identifies this Tableau connection specifically.

server_url
string
required

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

site_name
string
required

The site on that deployment SELECT reads. This is the site's URL name, which is what Tableau signs in against; Default names the default site of a Tableau Server deployment.

site_luid
string
required
read-only

The identifier Tableau assigns the site, resolved when the connection is added. Unlike site_name it survives a rename, so it is what SELECT keys the site's data and access rules on.

sync_enabled
boolean
required

Whether SELECT is currently syncing data for this connection.

query_sanitization_enabled
boolean
required

Whether query text is sanitized before SELECT stores it.

create_time
string
required
read-only

When the connection was added.

update_time
string
required
read-only

When the connection was last changed.

added_by_email
string | null

Email address of the person who added the connection. Null when it was not added by a person.

last_successful_sync_time
string | null

When SELECT last completed a sync for this connection. Null before the first one succeeds.