Virtual Connections Methods


Virtual connections are a centralized way to share access to databases and tables, allowing for convenient reuse. A virtual connection has one or more database connections, where server locations, database names, and credentials are defined. Each database connection accesses one database or file. Associated data policies provide security for workbooks, data sources, and flows that use virtual connections.

Using the virtual connections methods of the Tableau Server REST API you can:

  • Get a list of virtual connections and details for each.
  • Get and update the connection information for a virtual connection.

This functionality relates to the UI elements and concepts described at: Use a Virtual Connection(Link opens in a new window).

Use Postman

Our Postman collection of requests enables you to construct, send, and examine HTTP requests to the Tableau Server or Tableau Cloud API without writing initial code. Postman is a free online app used by many developers for prototyping API calls, investigating issues, and generating request code in a variety of languages.

Postman: Virtual Connections(Link opens in a new window)

Add Tags to Virtual Connection

Adds tags to a virtual connection.

Version: Available in API 3.23 (Tableau Cloud June 2024 / Tableau Server 2024.2) and later. Version Overview(Link opens in a new window)

License: Requires Tableau Data Management(Link opens in a new window).

Permissions: You must have the View permission for the virtual connection and your site role must be at least Explorer.   Permissions Overview(Link opens in a new window)

JWT Access Scope: tableau:virtual_connection_tags:update

URI

PUT /api/api-version/sites/site-id/virtualconnections/virtualconnection-id/tags

Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The LUID for the site.
virtualconnection-id The LUID for the virtual connection.

Request Body

<tsRequest>
  <tags>
    <tag label="tag" />
    <!-- ...additional tag elements... -->
  </tags>
</tsRequest>

Attribute Values

tag The text of the tag.

cURL Request Example

curl --location --request PUT 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/tags' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3' --data @data.xml

Contents of data.xml. 

<tsRequest>
  <tags>
    <tag label="Office" />
    <!-- ...additional tag elements... -->
  </tags>
</tsRequest>

Response Code

200

Response Body

<tsResponse>
  <tags>
    <tag label="tag"/>
    <!-- ...additional tags... -->
  </tags>
</tsResponse>

Errors

HTTP status error Code Condition Details
400 400000 Bad request The content of the request body is missing or incomplete, or contains malformed XML.
400 400049 Error adding tags There was a problem adding tags to the specified virtual connection.
403 403004 Adding tags forbidden The user doesn't have permissions to add tags to the virtual connection.
404 404000 Site not found The site ID in the URI is not for an existing site.
404 404006 Virtual connection not found The virtual connection ID in URI doesn't correspond to an existing virtual connection.
404 405000 Invalid request method Request type was not PUT.

For more information, see Handling Errors.

Add Virtual Connection Permissions

Adds permissions to the specified virtual connection for a user or group. You can specify multiple sets of permissions using one call.

If a specified permission has already been granted or denied for a given user or group, the system ignores it.

URI

PUT /api/api-version/sites/site-id/virtualconnections/virtualconnection-id/permissions

Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The ID of the site that contains the virtual connection.
virtualconnection-id The ID of the virtual connection to set permissions for.

Request Body

<tsRequest>
  <permissions>
    <granteeCapabilities>
      <user id="user-id" />
      <capabilities>
        <capability name="capability-name" mode="capability-mode" />
        <!--   ...additional capabilities...   -->
      </capabilities>
    </granteeCapabilities>
    <granteeCapabilities>
      <group id="group-id" />
      <capabilities>
        <capability name="capability-name" mode="capability-mode" />
        <!--   ...additional capabilities...   -->
      </capabilities>
    </granteeCapabilities>
    <!--   ...additional granteeCapability sets...   -->
  </permissions>
</tsRequest>

Attribute Values

user-id The LUID of the user to add permissions for. A request does not need to include both a user and a group grantee.
group-id The LUID of the group to add permissions for. A request does not need to include both a user and a group grantee.
capability-name

The capability to assign. Valid capabilities for a virtual connection are Read, Connect, Overwrite, ChangeHierarchy, Delete, and ChangePermissions.

For more information, see Permissions.
capability-mode Allow to allow the capability, or Deny to deny it.

Permissions

You must be an administrator or have the ChangePermissions permission for the virtual connection (either explicitly or implicitly).

Required scope for JWT authorization

Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17).

Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see Access scopes for UATs(Link opens in a new window) (Cloud), or Access Scopes for Connected Apps(Link opens in a new window) in the Tableau Cloud Help or Access Scopes for Connected Apps(Link opens in a new window) in the Tableau Server Help.

tableau:permissions:update

Response Code

200

Response Body

<tsResponse>
  <permissions>
    <virtualConnection id="virtualconnection-id"
      name="virtual-connection-name">
      <owner id="user-id"/>
    </virtualConnection>
    <granteeCapabilities>
      <user id="user-id" />
      <capabilities>
        <capability name="capability-name" mode="capability-mode" />
        <!--   ... additional capabilities ...   -->
      </capabilities>
    </granteeCapabilities>
    <granteeCapabilities>
      <group id="group-id" />
      <capabilities>
        <capability name="capability-name" mode="capability-mode" />
        <!--   ... additional capabilities ...   -->
      </capabilities>
    </granteeCapabilities>
    <!--   ... additional granteeCapability sets ...   -->
  </permissions>
</tsResponse>

Version

Version 3.23 and later. For more information, see REST API and Resource Versions.

Errors

HTTP status error Code Condition Details
400 400000 Bad request The content of the request body is missing or incomplete, or contains malformed XML.
400 400009 Invalid capability The specified capability is invalid for a virtual connection. Valid capabilities for a virtual connection are Read, Connect, Overwrite, ChangeHierarchy, Delete, and ChangePermissions.
403 403004 Permissions setting forbidden The user tried to change permissions for a virtual connection but doesn't have the permission to change them.
404 404000 Site not found The specified site doesn't correspond to an existing site.
404 404002 User not found The user specified in the request body doesn't correspond to an existing user.
404 404012 Group not found The group specified in the request body doesn't correspond to an existing group.
404 404013 Capability not assigned The capability in the URI is not assigned to the specified user or group with the specified mode (Allow or Deny).
404 404014 Capability not found A capability specified in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.
405 405000 Invalid request method Request type was not PUT.
400 409004 Invalid LUID The virtual connection LUID in the URI was not found.

For more information, see Handling Errors.

Example

curl --location --request PUT 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/permissions' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3' --data '<tsRequest> <permissions> <granteeCapabilities> <user id="9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d" /> <capabilities> <capability name="read" mode="allow" /> </capabilities> </granteeCapabilities> </permissions> </tsRequest>'

Add Virtual Connection to Server Schedule

Adds a task to refresh a virtual connection to an existing server schedule on Tableau Server.
For Tableau Cloud, see Create Cloud Extract Refresh Task.

This method identifies and refreshes only the tables in the virtual connection that are configured as extracts; live tables are ignored.

Version: Available in API 3.30 and later.

License: Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle.

Permissions: Tableau Server users who are not server administrators or site administrators can only add a virtual connection to a schedule if they own the virtual connection, or are the project leader for the project that contains the virtual connection.

Access Scope: tableau:schedules:update

For more information, see Versions(Link opens in a new window), Permissions(Link opens in a new window), Access scopes for UATs(Link opens in a new window) (Cloud), and access scopes for Cloud(Link opens in a new window), Server-Windows,(Link opens in a new window) or Server-Linux(Link opens in a new window).

URI

PUT /api/api-version/sites/site-id/schedules/schedule-id/virtualconnections

URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The LUID for the site.
schedule-id The LUID for the schedule that you are associating with the virtual connection.

Request Body

<tsRequest>
  <task>
    <extractRefresh transactionLevel="transaction-level" incremental="incremental-flag">
      <virtualConnection id="virtualconnection-id" />
      <startingItemIds>
        <startingItemId>starting-item-id</startingItemId>
        <!-- . . . more <startingItemId> elements . . . -->
      </startingItemIds>
    </extractRefresh>
  </task>
</tsRequest>

Attribute Values

transaction-level

Optional. DATABASE or TABLE. Default is DATABASE.

  • If set to DATABASE: If any table extract refresh fails, none of the extracts are updated.
  • If set to TABLE: If a table extract fails, only that table's extract isn't updated.
incremental-flag

Optional, boolean. Default is false.

  • If set to false, do a full refresh. Fully refresh all extracts including those configured for incremental extract.
  • If set to true, do an incremental refresh. Add new rows to incremental extracts. Full refresh other extracts.
virtualconnection-id The LUID of the virtual connection to add to the schedule.
starting-item-id The LUID of an extract table in the virtual connection. You may have more than one <startingItemId> element inside of a <startingItemIds> element.

cURL Request Example

curl --request PUT 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/schedules/9a4ebbab-9ec8-487a-9b48-47fa81d6077a/virtualconnections' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3' --data '<tsRequest><task><extractRefresh><virtualConnection id="12ab34cd-56ef-78ab-90cd-12ef34ab56cd" /></extractRefresh></task></tsRequest>'

Response Code

200

Response Body

<tsResponse>
  <task>
    <extractRefresh id="9dd16fd7-8bbc-4c0d-9f75-9c7330a29396"
      priority="50"
      consecutiveFailedCount="0"
      type="ExtractServiceFullRefreshExtractTask"
      transactionLevel="DATABASE">
      <schedule id="c09d0586-80b3-4bb4-a1fa-508436243792"
        name="Weekday early mornings"
        state="Active"
        priority="50"
        createdAt="2026-07-15T12:28:01Z"
        updatedAt="2026-07-17T07:11:19Z"
        type="Extract"
        frequency="Weekly"
        nextRunAt="2026-07-20T04:00:00Z"/>
      <virtualConnection id="e3ebe049-8f94-4501-8fb0-faba6ccbbc85"/>
      <startingItemIds>
        <startingItemId>3577de68-2779-4962-b13d-3265ec98a4cb</startingItemId>
      </startingItemIds>
    </extractRefresh>
  </task>
</tsResponse>

Errors

HTTP status error Code Condition Details
400 400000 Bad Request The content of the request body is missing or incomplete, or contains malformed XML.
400 400223 Virtual connection table not found. A LUID in startingItemIds is not an extract-eligible table on the virtual connection.
400 400225 Duplicate virtual connection table. startingItemIds contains the same table LUID more than once.
400 404049 No virtual connection specified. The request body must include a virtual connection in the extractRefresh element.
400 409004 Invalid parameter. startingItemIds contains a value that is not a valid LUID.
400 409090 No extract-eligible tables. The virtual connection has no active revision, or none of its tables are configured for extract refresh.
403 403078 Unable to create the task.

One of the following applies:

  • The user is not a system or site administrator and does not own the virtual connection.
  • The virtual connection already has a refresh scheduled on this schedule.
  • The virtual connection is in a personal space.
  • The extract refresh operation is not allowed for the virtual connection.
404 404023 Schedule not found. Check the schedule LUID.
404 404049 Virtual connection not found. Check the virtual connection LUID.
405 405000 Method not allowed. Request type must be PUT.

For more information, see Handling Errors.

Create Cloud Extract Refresh Task

Creates a custom schedule for an extract refresh on Tableau Cloud. The target of the schedule can be a data source, a workbook, or a virtual connection.
For Tableau Server, see Add data source to server schedule, Add workbook to server schedule, and Add virtual connection to server schedule.

Version: Available in API 3.20 (Tableau Cloud June 2023) and later. Virtual connection support added in API 3.30. Not available for Tableau Server. Version Overview(Link opens in a new window)

License: No additional license required for a data source or workbook target. A virtual connection target requires Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle.

Permissions: Administrators and any user with the creator role can create a custom schedule for an extract refresh.  Permissions Overview(Link opens in a new window)

JWT Access Scope: tableau:tasks:create

URI

POST /api/api-version/sites/site-id/tasks/extractRefreshes

URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The LUID for the site.

Request Body

<tsRequest>
  <extractRefresh type="FullRefresh">
    <workbook id="54321fd-6365-44d5-925b-644e5281b605" />
  </extractRefresh>
  <schedule frequency="Daily">
    <frequencyDetails start="18:30:00" end="23:30:00">
      <intervals>
        <interval hours="4"/>
        <interval weekDay="Sunday"/>
        <interval weekDay="Wednesday"/>
      </intervals>
    </frequencyDetails>
  </schedule>
</tsRequest>
{
  "extractRefresh": {
    "type": "FullRefresh",
    "workbook": {
      "id": "54321fd-6365-44d5-925b-644e5281b605"
    }
  },
  "schedule": {
    "frequency": "Daily",
    "frequencyDetails": {
      "start": "18:30:00",
      "end": "23:30:00",
      "intervals": {
        "interval": [
          { "hours": "4" },
          { "weekDay": "Sunday" },
          { "weekDay": "Wednesday" }
        ]
      }
    }
  }

Request Attributes

All request attributes are required to create a custom schedule for an extract refresh, except where noted below.

extractRefresh type The type of extract refresh being scheduled. Valid values include:
  • FullRefresh
  • IncrementalExtract
extractRefresh transactionLevel

(Optional) : Only used with a virtual connection.

Optional. DATABASE or TABLE. Default is DATABASE.

  • If set to DATABASE: If any table extract refresh fails, none of the extracts are updated.
  • If set to TABLE: If a table extract fails, only that table's extract isn't updated.
workbook id
or datasource id
or virtualConnection id		 The LUID of the workbook, data source, or virtual connection that is the target of the custom schedule.
startingItemId

Only used with a virtual connection, when extractRefresh type is FullRefresh

The LUID of an extract table in the virtual connection. You may have more than one <startingItemId> element inside of a <startingItemIds> element. See Virtual Connection Example.
tableLuid

Only used with a virtual connection, when extractRefresh type is IncrementalExtract

The LUID of an extract table in the virtual connection. You may have more than one <tableLiud> element inside of a <tableLiuds> element. See Virtual Connection Example.
schedule frequency (Required to create subscription) enumeration: The scheduled frequency for triggering the task. Valid values include:
  • Hourly
  • Daily
  • Weekly
  • Monthly
frequencyDetails start (Required to create subscription) time: If the schedule frequency is Daily, Weekly, or Monthly, then start is the time of day on which scheduled jobs should run. If the frequency is Hourly, then start is the beginning of the time range during which jobs should be started. The valid format is HH:MM:SS.
frequencyDetails end

(Required to create subscription) time: If the schedule frequency is Hourly, or Daily with an interval of hours less than 24, then end is the time of day on which scheduled jobs should stop being run. The valid format is HH:MM:SS. Time should be specified in 5 minute increments and the difference between start and end times should be increments of 60 minutes. For example, a valid frequencyDetail would be: 

<frequencyDetail start="20:45:00" end="21:45:00">
  . . .
</frequencyDetail>
interval {interval type} (Required to create subscription) string: Defines when and how often a scheduled job executes within the time parameters set in the start and end values of the frequencyDetails of the schedule. The type and valid values for an interval expression depend on the declared frequency of the schedule as follows:

FrequencyValid interval values
Hourly The value of an interval for an Hourly schedule can be only one of either:
  • hours="1" The number of hours between jobs. 1 is the only valid value.
  • minutes="60" The number of minutes between jobs. 60 is the only valid value.
  • weekDay="weekday" The weekday(s) the job will be run on. Valid values are: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday.

    For example, to schedule to run a job every hour on Sunday and Wednesday, during the time range specified in frequencyDetails use an interval like: 
    <intervals>
  <interval hours="1"/>
  <interval weekDay="Sunday"/>
  <interval weekDay="Wednesday"/>
<intervals>

Daily The value of Daily can have multiple weekday elements, but only one hours declaration. An hours interval is required.
  • hours="interval" The interval between execution of jobs on the weekday(s) specified. Valid values are 2, 4, 6, 8, 12, or 24. Note that if the interval value of a daily schedule is less than 24, a frequencyDetail end time must be supplied.
  • weekDay="weekday" The weekday(s) the job will be run on. Valid values are: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday.

    For example, to schedule to run a job every 4 hours on Sunday and Wednesday, during the time range specified in frequencyDetails use an interval like:
    <intervals>
  <interval hours="4"/>
  <interval weekDay="Sunday"/>
  <interval weekDay="Wednesday"/>
<intervals>
WeeklyweekDay="weekday" The day of the week the schedule should run on. You can only specify a single day for a Weekly schedule. Valid values are: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday.
Monthly

The day(s) of the month a job should be scheduled to run on. There are two ways to define a monthly interval:

Specify the day(s) using the number of the day in the month;

  • monthDay="day" The number of the day of the month. Valid values are the whole numbers 1 to 31 or LastDay. If you specify monthDay by day number then you can use multiple interval instances to choose for the job to run on multiple days in the month. If you use LastDay then only one instance of interval can be used in the schedule to specify the last day of the month.

Specify the day by describing which occurrence of a weekday within the month.

  • monthDay="occurrence_of_weekday" Weekday="weekday" The occurrence of the specified weekday within the month when a job should be run. Valid values for occurrencee_of_weekday are First, Second, Third, Fourth, Fifth, or LastDay. Valid values for weekday are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday. If the value is lastDay then the job will run on the last occurrence of the specified weekday in the month.

    For example, to make a schedule that that would run a job on the third Thursday of each month, you would use:
    <interval monthDay="Third" weekDay="Thursday"/>

Virtual Connection Example

When the target is a virtual connection, use virtualConnection id instead of workbook id or datasource id. The following example includes only the <extractRefresh> and child elements for brevity; see the primary example above for the a full request without the elements that apply only to virtual connections.

Incremental refresh of specific tables, with a table-level transaction: 

<extractRefresh type="IncrementalRefresh" transactionLevel="TABLE">
  <virtualConnection id="33a16da9-e96b-4190-83ed-c85192683052" />
  <tableLuids>
    <tableLuid>b4e39d59-19c3-4380-8ea4-9bfa4ed8fb84</tableLuid>
    <!-- . . . more <tableLuid> elements . . . -->
  </tableLuids>
</extractRefresh>

cURL Request Example

curl --location --request POST "https://10ax.online.tableau.com/api/3.29/sites/a946d998-2ead-4894-bb50-1054a91dcab3/tasks/extractRefreshes" --header "Content-Type: application/xml" --data "<tsRequest> <extractRefresh type='FullRefresh'> <workbook id='0057ccac-872a-11e5-bb51-f763326b1350' /> </extractRefresh> <schedule frequency='Daily'> <frequencyDetails start='18:30:00' end='23:00:00'> <intervals> <interval hours='4'/> </intervals> <intervals> <interval weekDay='Sunday'/> </intervals> <intervals> <interval weekDay='Wednesday'/> </intervals> </frequencyDetails> </schedule> </tsRequest>"

200

Response Body

When the target is a virtual connection, the response's extractRefresh element includes a transactionLevel attribute and a virtualConnection element (with a sibling startingItemIds, if starting items were specified) in place of datasource or workbook.

<tsResponse>
  <extractRefresh
    id="13237fd-6365-44d5-925b-644e5281b605"
    consecutiveFailedCount="0"
    type="IncrementalRefresh" >
      <datasource id="0057ccac-872a-11e5-bb51-f763326b1350" />
  </extractRefresh>
  <schedule id="cdfe8548-84c8-418e-9b33-2c0728b2398a"
    createdAt="2023-04-06T23:43:12-0700"
    updatedAt="2023-04-06T23:43:12-0700"
    frequency="Daily"
    nextRunAt="2023-04-06T23:43:12-0700">
        <frequencyDetails start="18:30:00" end="23:30:00">
        <intervals>
          <interval hours="4"/>
          <interval weekDay="Sunday"/>
          <interval weekDay="Wednesday"/>
        </intervals>
      </frequencyDetails>
  </schedule>
</tsResponse>
{
  "extractRefresh": {
    "id": "13237fd-6365-44d5-925b-644e5281b605",
    "consecutiveFailedCount": "0",
    "type": "IncrementalRefresh",
    "datasource": {
      "id": "0057ccac-872a-11e5-bb51-f763326b1350"
    }
  },
  "schedule": {
    "id": "cdfe8548-84c8-418e-9b33-2c0728b2398a",
    "createdAt": "2023-04-06T23:43:12-0700",
    "updatedAt": "2023-04-06T23:43:12-0700",
    "frequency": "Daily",
    "nextRunAt": "2023-04-06T23:43:12-0700",
    "frequencyDetails": {
      "start": "18:30:00",
      "end": "23:30:00",
      "intervals": {
        "interval": [
          { "hours": "4" },
          { "weekDay": "Sunday" },
          { "weekDay": "Wednesday" }
        ]
      }
    }
  }
}

Errors

HTTP status error Code Condition Details
400 400000 Bad Request The content of the request body is missing or incomplete, or contains malformed XML.
400 400225 Duplicate starting item startingItemIds contains a duplicate table LUID.
409 409090 Extract operation not allowed The virtual connection has no extract-configured tables; all tables are live.
401 401002 Unauthorized Access The authentication token provided in the request header was invalid or has expired.
404 404026 Task not found The task for the extract refresh could not be found.
409 409004 invalid parameter value The request is malformed or contains an invalid or missing schedule or interval parameter value. When the difference between start and end times are not increments of one hour, this error will result.

For more information, see Handling Errors.

Delete Extracts from Virtual Connection

Deletes the extracts from a virtual connection, which changes it from extract to live mode.

This operation applies to the entire virtual connection. You can't target individual tables.

Version: Available in API 3.30.

License: Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle.

Permissions: Extracts for virtual connections can be deleted by Tableau server or site administrators, and by users who own the virtual connection or are an owner or leader of the project where the virtual connection resides.

Access Scope: tableau:extracts:delete

For more information, see Versions(Link opens in a new window), Permissions(Link opens in a new window), Access scopes for UATs(Link opens in a new window) (Cloud), and access scopes for Cloud(Link opens in a new window), Server-Windows,(Link opens in a new window) or Server-Linux(Link opens in a new window).

URI

POST /api/api-version/sites/site-id/virtualconnections/virtualconnection-id/deleteExtract

URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The LUID for the site.
virtualconnection-id The LUID for the virtual connection whose extract is to be deleted.

Request Body

The request body is an empty tsRequest element.

              <tsRequest/>
              
            

{}

cURL Request Example

curl --request POST 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/deleteExtract' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3' --data '<tsRequest/>'

Response Code

204 No Content

Response Body

None

Errors

HTTP status error Code Condition Details
400 409128 No extract to delete. The virtual connection has no extract. Neither the active revision nor any of its tables has extracts enabled.
400 409099 Unable to delete the extract. A generic error occurred while converting the virtual connection to live and deleting its extract.
403 409098 User not authorized to delete the extract. The user must be able to see the virtual connection and must have permission to convert its extract to live.
404 404049 Virtual connection not found. Check the virtual connection LUID. This error also occurs if the virtual connection has no active revision.

For more information, see Handling Errors.

Delete Tag from Virtual Connection

Deletes a tag from a virtual connection.

Version: Available in API 3.23 (Tableau Cloud June 2024 / Tableau Server 2024.2) and later. Version Overview(Link opens in a new window)

License: Requires Tableau Data Management(Link opens in a new window).

Permissions: You must have the View permission for the virtual connection and your site role must be at least Explorer.   Permissions Overview(Link opens in a new window)

JWT Access Scope: tableau:virtual_connection_tags:delete

URI

DELETE /api/api-version/sites/site-id/virtualconnections/virtualconnection-id/tags/tag-name

Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The LUID for the site.
virtualconnection-id The LUID for the virtual connection.
tag-name The text of the tag.

Request Body

None

cURL Request Example

curl --location --request DELETE 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/tags/office' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3'

Response Code

204

Response Body

None

Errors

HTTP status error Code Condition Details
400 400077 Error deleting tag There was a problem deleting the tag from the specified virtual connection.
403 403004 Deleting tags forbidden The user doesn't have permissions to add delete tags from the virtual connection.
404 404000 Site not found The site ID or URL namespace in the URI doesn't correspond to an existing site.
404 404004 Virtual connection not found The virtual connection ID in the URI doesn't correspond to an existing virtual connection.
404 404007 Tag not found The tag in the URI doesn't exist for the specified virtual connection.
405 405000 Invalid request method Request type was not DELETE.

For more information, see Handling Errors.

Delete Virtual Connection

Deletes a virtual connection.

Version: Available in API 3.23 (Tableau Cloud June 2024 / Tableau Server 2024.2) and later. Version Overview(Link opens in a new window)

License: Requires Tableau Data Management(Link opens in a new window).

Permissions: You must have the Delete permission for the virtual connection and your site role must be at least Creator.   Permissions Overview(Link opens in a new window)

JWT Access Scope: tableau:virtual_connections:delete

URI

DELETE /api/api-version/sites/site-id/virtualconnections/virtualconnection-id

URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The LUID for the site.
virtualconnection-id The LUID for the virtual connection.

Request Body

None

cURL Request Example

(Use the icon in the top right corner to copy the text.) 

curl --request DELETE 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3'

Response Code

204

Response Body

None

Errors

HTTP status error Code Condition Details
403 403004 User not authorized. Check to make sure the user has the required permissions.
404 404049 Virtual connection not found Check the virtual connection LUID.
409 409122 Generic error An unknown error occurred.

For more information, see Handling Errors.

Delete Virtual Connection Permission

Removes the specified virtual connection permission for the specified group or user.

URI

DELETE /api/api-version/sites/site-id/virtualconnections/virtualconnection-id/permissions/groups/group-id/capability-name/capability-mode

DELETE /api/api-version/sites/site-id/virtualconnections/virtualconnection-id/permissions/users/user-id/capability-name/capability-mode

Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The ID of the site that contains the virtual connection.
virtualconnection-id The ID of the virtual connection to remove the permission for.
group-id The LUID of the group to remove the permission for. A request does not need to include both a user and a group grantee.
user-id The LUID of the user to remove the permission for. A request does not need to include both a user and a group grantee.
capability-name

The capability to remove the permission for. Valid capabilities for a virtual connection are Read, Connect, Overwrite, ChangeHierarchy, Delete, and ChangePermissions.

For more information, see Permissions.
capability-mode Allow to remove the allow permission, or Deny to remove the deny permission.

Request Body

None

Permissions

You must be an administrator or have the Delete permission for the virtual connection (either explicitly or implicitly).

Required scope for JWT authorization

Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17).

Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see Access scopes for UATs(Link opens in a new window) (Cloud), or Access Scopes for Connected Apps(Link opens in a new window) in the Tableau Cloud Help or Access Scopes for Connected Apps(Link opens in a new window) in the Tableau Server Help.

tableau:permissions:delete

Response Code

204

Response Body

None

Version

Version 3.23 and later. For more information, see REST API and Resource Versions.

Errors

HTTP status error Code Condition Details
400 400009 Invalid capability The specified capability is invalid for a virtual connection. Valid capabilities for a virtual connection are Read, Connect, Overwrite, ChangeHierarchy, Delete, and ChangePermissions.
403 403004 Permissions setting forbidden The user tried to change permissions for a virtual connection but doesn't have the permission to change them.
404 404000 Site not found The specified site doesn't correspond to an existing site.
404 404002 User not found The user specified in the request body doesn't correspond to an existing user.
404 404012 Group not found The group ID in the URI doesn't correspond to an existing group.
404 404013 Capability not assigned The capability in the URI is not assigned to the specified user or group with the specified mode (Allow or Deny).
404 404014 Capability not found A capability specified in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.
405 405000 Invalid request method Request type was not DELETE.
400 409004 Invalid LUID The virtual connection LUID in the URI was not found.

For more information, see Handling Errors.

Example

curl --location --request DELETE 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/permissions/users/9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d/read/allow' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3'

Download Virtual Connection

Downloads a virtual connection in .tvcx format.
To download a JSON representation of a virtual connection instead, see Download Virtual Connection as JSON.

A .tvcx file is a packaged virtual connection. You can publish a downloaded .tvcx file with Publish Virtual Connection.

Version: Available in API 3.30 and later.

License: Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle.

Permissions: You must have the Overwrite permission for the virtual connection and your site role must be at least Creator, or you must be a site or server administrator.

Access Scope: tableau:virtual_connections:read

For more information, see Versions(Link opens in a new window), Permissions(Link opens in a new window), Access scopes for UATs(Link opens in a new window) (Cloud), and access scopes for Cloud(Link opens in a new window), Server-Windows,(Link opens in a new window) or Server-Linux(Link opens in a new window).

URI

GET /api/api-version/sites/site-id/virtualconnections/virtualconnection-id/content

URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The LUID of the site that contains the virtual connection.
virtualconnection-id The LUID of the virtual connection to download. To get the LUID, use List Virtual Connections.

Unlike Download Data Source, this method has no includeExtract parameter. If the virtual connection uses extracts, the download always includes them. Encrypted extracts are decrypted before packaging, so the downloaded .tvcx file can be published to any site.

Request Body

None

cURL Request Example

(Use the icon in the top right corner to copy the text.) 

curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/content" -X GET -H "X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3" -o my-virtualconnection.tvcx

The response is a file that contains the virtual connection.

Response Code

200

Response Headers

Content-Type: application/octet-stream

Content-Disposition: name="tableau_virtual_connection_content"; filename="virtualconnection-filename.tvcx"

Response Body

The virtual connection in .tvcx format, a binary ZIP archive with the following contents:

virtualconnection-name.tvcx (ZIP)
  virtualconnection-name.tvc        The virtual connection schema (tables, columns,
                                    connections, and policy collection)
  Data/Extracts/*.hyper             Hyper extracts. Present only if the virtual
                                    connection uses extracts.

A .tvcx file for a virtual connection that has only live tables contains just the .tvc schema file.

Errors

HTTP status error Code Condition Details
400 400200 Download virtual connection error The virtual connection ID is not a valid ID, or the .tvcx file could not be built.
403 403174 Download virtual connection forbidden The user does not have permission to download the virtual connection.
404 404000 Site not found The site LUID in the URI doesn't correspond to an existing site.
404 404049 Virtual connection not found The virtual connection does not exist.
405 405000 Invalid request method Request type was not GET.

For more information, see Handling Errors.

Download Virtual Connection as JSON

Downloads a JSON-representation of a virtual connection.
To download a virtual connection as a .tvcx file, see Download Virtual Connection.

Version: Available in API 3.23 (Tableau Cloud June 2024 / Tableau Server 2024.2) and later. Version Overview(Link opens in a new window)

License: Requires Tableau Data Management(Link opens in a new window).

Permissions: You must have the Overwrite permission for the virtual connection and your site role must be at least Creator.   Permissions Overview(Link opens in a new window)

JWT Access Scope: tableau:virtual_connections:read

URI

GET /api/api-version/sites/site-id/virtualconnections/virtualconnection-id

URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The LUID for the site.
virtualconnection-id The LUID for the virtual connection.

Request Body

None

cURL Request Example

(Use the icon in the top right corner to copy the text.) 

curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd" -X GET -H "Content-Type: application/xml" -H "X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3"

Response Code

200

Response Body

<tsResponse>
  <virtualConnection name="virtualconnection-name">
    <project id="1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e"/>
    <owner id="9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d"/>
    <content>virtualconnection-as-json</content>
  </virtualConnection>
</tsResponse>

{
  "virtualConnection": {
    "project": {
      "id": "1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e"
    },
    "owner": {
      "id": "9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d"
    },
    "content": "virtualconnection-as-json",
    "name": "virtualconnection-name"
  }
}

The response body contains the project LUID, owner LUID, and a content element (for XML output) or content property (for JSON output) containing the virtual connection schema rendered as JSON.

If the response is XML, the content element is unescaped JSON.

If the response is JSON, the content property is escaped JSON.

Errors

HTTP status error Code Condition Details
400 400200 Generic error An unknown error occurred.
403 403174 User not authorized. Check to make sure the user has the required permissions.
404 404049 Virtual connection not found Check the virtual connection LUID.

For more information, see Handling Errors.

Download Virtual Connection Revision as JSON

Downloads a JSON-representation of an earlier revision of a virtual connection.

Version: Available in API 3.23 (Tableau Cloud June 2024 / Tableau Server 2024.2) and later. Version Overview(Link opens in a new window)

License: Requires Tableau Data Management(Link opens in a new window).

Permissions: You must have the Overwrite permission for the virtual connection and your site role must be at least Creator.   Permissions Overview(Link opens in a new window)

JWT Access Scope: tableau:virtual_connections:read

URI

GET /api/api-version/sites/site-id/virtualconnections/virtualconnection-id/revisions/revision-number

URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The LUID for the site.
virtualconnection-id The LUID for the virtual connection.
revision-number The revision number (revisionNumber) of the virtual connection, as returned by the Get Virtual Connection Revisions method. This is an integer, not a LUID.

Request Body

None

cURL Request Example

(Use the icon in the top right corner to copy the text.) 

curl 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/revisions' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3'

Response Code

200

Response Body

<tsResponse>
  <virtualConnection name="virtualconnection-name">
    <project id="project-id"/>
    <owner id="owner-id"/>
    <content>virtualconnection-as-json</content>
  </virtualConnection>
</tsResponse>

{
  "virtualConnection": {
    "project": {
      "id": "project-id"
    },
    "owner": {
      "id": "owner-id"
    },
    "content": "virtualconnection-as-json",
    "name": "virtualconnection-name"
  }
}

The response body contains the project LUID, owner LUID, and a content element (for XML output) or content property (for JSON output) containing the virtual connection schema rendered as JSON.

If the response is XML, the content element is unescaped JSON.

If the response is JSON, the content property is escaped JSON.

Errors

HTTP status error Code Condition Details
400 400200 Generic error An unknown error occurred. Check to make sure the revision number is a revision and not the active virtual connection.
403 403174 User not authorized. Check to make sure the user has the required permissions.
404 404049 Virtual connection not found Check the virtual connection LUID. Check that the revision number exists.

For more information, see Handling Errors.

List Virtual Connection Revisions

Lists revisions for a virtual connection.

Version: Available in API 3.23 (Tableau Cloud June 2024 / Tableau Server 2024.2) and later. Version Overview(Link opens in a new window)

License: Requires Tableau Data Management(Link opens in a new window).

Permissions: You must have the Overwrite permission for the virtual connection and your site role must be at least Creator.   Permissions Overview(Link opens in a new window)

JWT Access Scope: tableau:virtual_connections:read

Note: This method can only succeed if version history is enabled for the specified site. For more information, see Maintain a History of Revisions(Link opens in a new window) in the Tableau Server Help.

URI

GET /api/api-version/sites/site-id/virtualconnections/virtual-connection-id/revisions

GET /api/api-version/sites/site-id/virtualconnections/virtual-connection-id/revisions/?pageSize=page-size&pageNumber=page-number

URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The LUID for the site.
virtual-connection-id The LUID for the virtual connection.
page-size (Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number (Optional) The offset for paging. The default is 1. For more information, see Paginating Results.

Request Body

None

cURL Request Example

(Use the icon in the top right corner to copy the text.) 

curl 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/revisions' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3 '

Response Code

200

Response Body

<tsResponse>
  <pagination pageNumber="page-number" pageSize="page-size" totalAvailable="page-count"/>
  <revisions>
    <revision revisionNumber="revision-number" publishedAt="datetime" deleted="deleted-flag" current="current-flag">
      <publisher id="publisher-id" name="publisher-username"/>
    </revision>
    <revision revisionNumber="revision-number" publishedAt="datetime" deleted="deleted-flag" current="current-flag">
      <publisher id="publisher-id" name="publisher-username"/>
    </revision>
    <!-- ...Additional revisions... -->
</revisions>
</tsResponse>

"pagination": {
    "pageNumber": "page-number",
    "pageSize": "page-size",
    "totalAvailable": "page-count"
  },
  "revisions": {
    "revision": [
      {
        "publisher": {
          "id": "publisher-id",
          "name": "publisher-username"
        },
        "revisionNumber": "revision-number",
        "publishedAt": "datetime",
        "deleted": deleted-flag,
        "current": current-flag
      },
      {
        "publisher": {
          "id": "publisher-id",
          "name": "publisher-username"
        },
        "revisionNumber": "revision-number",
        "publishedAt": "datetime",
        "deleted": deleted-flag,
        "current": current-flag
      },
      {
        ...Additional revisions...
      }
    ]
  }
}

The current property of a revision shows false for all revisions except for the currently active virtual connection revision, in which case it shows true.

Errors

HTTP status error Code Condition Details
400 400058 Generic error An unknown error occurred.
403 403054 User not authorized. User doesn't have permissions to revisions on this virtual connection. Check the user's permissions.
403 403173 User not authorized. User forbidden from listing virtual connection revisions. Check the user's permissions and site role.
403 403053 Revision history is disabled on the site. Check the revision history setting.
404 404049 Virtual connection not found Check the virtual connection LUID.

For more information, see Handling Errors.

List Virtual Connections

Returns a list of available virtual connection names and IDs.

Version: Available in API 3.18 (Tableau Cloud December 2022 / Server 2023.1) and later. Version Overview

License: Requires Tableau Data Management(Link opens in a new window).

Permissions: By default, all users can view virtual connections.  Permissions Overview

JWT Access Scope: tableau:content:read

URI

GET /api/api-version/sites/site-id/virtualconnections

GET /api/api-version/sites/site-id/virtualconnections/?pageSize=page-size&pageNumber=page-number

GET /api/api-version/sites/site-id/virtualconnections/?sort=sort-expression

URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The LUID for the site that contains the virtual connection.
page-size (Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number (Optional) The offset for paging. The default is 1. For more information, see Paginating Results.
sort-expression (Optional) An expression that lets you specify the order in which virtual connection information is returned. If you do not specify a sort expression, the sort order of the information that's returned is undefined. For more information, see Filtering and Sorting.

Request Body

None

cURL Request Example

curl --location --request GET "https://MY_SERVER/api/3.18/sites/a946d998-2ead-4894-bb50-1054a91dcab3/virtualconnections" \ --header "X-Tableau-Auth: 3bl3fJb0T6qxhaCqneNhWg"Nmv6zrJfYeiiovCuEs2grrBAZlREbRGl"a946d998-2ead-4894-bb50-1054a91dcab3"

Response Code

200

Response Body

<tsResponse> 
  <pagination pageNumber="page-number" pageSize="page-size" totalAvailable="total-available" />
  <virtualConnections>
    <virtualConnection 
      createdAt="datetime-created" 
      hasExtracts="has-extracts-flag" 
      id="virtual-connection-id" 
      isCertified="is-certified-flag" 
      name="virtualconnection-name" 
      updatedAt="datetime-updated" 
      webpageUrl="web-page-url"/>
  </virtualConnections>
</tsResponse>

{
  "pagination": {
    "pageNumber": "page-number",
    "pageSize": "page-size",
    "totalAvailable": "total-available"
  },
  "virtualConnections": {
    "virtualConnection": {
      "createdAt": "datetime-created",
      "hasExtracts": "has-extracts-flag",
      "id": "virtual-connection-id",
      "isCertified": "is-certified-flag",
      "name": "virtualconnection-name",
      "updatedAt": "datetime-updated",
      "webpageUrl": "web-page-url"
    }
  }
}

Errors

HTTP status error Code Condition Details
400 400000 Bad request The content of the request body is missing or incomplete, or contains malformed XML.
400 400006 Invalid page number The page number parameter is not an integer, is less than one, or is greater than the final page number for virtual connections at the requested page size.
400 400007 Invalid page size The page size parameter is not an integer, or is less than one.
400 400008 Invalid parameter value A parameter in the request body is missing or invalid.
403 403014 Page size limit exceeded The specified page size is larger than the maximum page size.
404 404000 Site not found The site ID in the URI doesn't correspond to an existing site.
405 405000 Invalid request method Request type was not GET.

For more information, see Handling Errors.

List Virtual Connection Database Connections

Returns information about database connections in the specified virtual connection

Version: Available in API 3.18 (Tableau Cloud December 2022 / Server 2023.1) and later. Version Overview

License: Requires Tableau Data Management(Link opens in a new window).

Permissions: Users who are not administrators can query a virtual connection only if they have explicit or implicit [Connect] (view) permission for the virtual connection.  Permissions Overview

JWT Access Scope: tableau:content:read

URI

GET /api/api-version/sites/site-id/virtualconnections/virtual-connection-id/connections

GET /api/api-version/sites/site-id/virtualconnections/virtual-connection-id/connections?pageSize=page-size&pageNumber=page-number

URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The LUID for the site that contains the virtual connection.
virtual-connection-id The LUID for the virtual connection that includes the database connections.
page-size (Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number (Optional) The offset for paging. The default is 1. For more information, see Paginating Results.

Request Body

None

cURL Request Example

curl --location --request GET "https://MY_SERVER/api/3.18/sites/a946d998-2ead-4894-bb50-1054a91dcab3/virtualconnections/26bc30d8-90d6-4af1-922d-ac285e7b08fb/connections?X-Tableau-Auth =3bl3fJb0T6qxhaCqneNhWg"Nmv6zrJfYeiiovCuEs2grrBAZlREbRGl"a946d998-2ead-4894-bb50-1054a91dcab3"

Response Code

200

Response Body

<tsResponse>
  <pagination pageNumber="pageNumber" pageSize="page-size" totalAvailable="total-available" />
  <virtualConnectionConnections>
    <connection
      id="connection-id" 
      serverAddress="server-address" 
      dbClass="database-type" 
      serverPort="port-number" 
      userName="connection-user-name"/>
  </virtualConnectionConnections>
</tsResponse>

{
  "pagination": {
    "pageNumber": "pageNumber",
    "pageSize": "page-size",
    "totalAvailable": "total-available"
  },
  "virtualConnectionConnections": {
    "connection": {
      "id": "connection-id",
      "serverAddress": "server-address",
      "dbClass": "database-type",
      "serverPort": "port-number",
      "userName": "connection-user-name"
    }
  }
}

Errors

HTTP status error Code Condition Details
400 400006 Invalid page number The page number parameter is not an integer, is less than one, or is greater than the final page number for virtual connections at the requested page size.
400 400007 Invalid page size The page size parameter is not an integer, or is less than one.
401 401002 Unauthorized The authentication token provided in the request header was invalid or has expired.
403 403014 Page size limit exceeded The specified page size is larger than the maximum page size.
404 404000 Site not found The site ID in the URI doesn't correspond to an existing site.
405 405000 Invalid request method Request type was not GET.

For more information, see Handling Errors.

Publish Virtual Connection

Publishes a virtual connection on the specified site, either from a packaged virtual connection file (.tvcx) or from a downloaded JSON representation.

If the virtual connection does not exist, it is published as a new virtual connection. If it already exists and you choose to overwrite it, the virtual connection is published as a revision of the existing virtual connection.

You can publish in either of these ways:

Version: Available in API 3.23 (Tableau Cloud June 2024 / Tableau Server 2024.2) and later. Support for publishing a .tvcx file added in API 3.30.

License: Requires Tableau Data Management(Link opens in a new window).

Permissions: You must have the Overwrite permission for the virtual connection and your site role must be at least Creator, or you must be a Tableau administrator.

Access Scope: tableau:virtual_connections:create. Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3).

For more information, see Versions(Link opens in a new window), Permissions(Link opens in a new window), Access scopes for UATs(Link opens in a new window) (Cloud), and access scopes for Cloud(Link opens in a new window), Server-Windows,(Link opens in a new window) or Server-Linux(Link opens in a new window).

To publish a .tvcx file, you can call this method in two ways. You can publish a virtual connection in a single request. To do that, you include the content of the .tvcx file in the body of the request. The maximum size of a file that can be published in a single request is about 64 MB.

Alternatively, you can publish a .tvcx file in multiple parts. To do that, you initiate a file upload by calling Initiate File Upload, send portions of the file to the server using Append to File Upload, and then commit the upload by calling Publish Virtual Connection. In this case, Publish Virtual Connection doesn't contain the file to publish. We recommend this approach for files larger than about 64 MB, such as files that include large extracts.

Virtual connections with extracts
A .tvcx file for a virtual connection that uses extracts contains the Hyper extract files, in addition to the virtual connection schema. A .tvcx file for a live virtual connection contains only the schema. This method accepts both kinds of file.

Draft or active
When you publish a JSON representation, the virtual connection can be published as a draft or as an active virtual connection, as set by the publishAsDraft parameter. A virtual connection that you publish from a .tvcx file is always published as an active virtual connection, whether or not the file includes extracts. The publishAsDraft parameter does not apply to a .tvcx file.

For more information, see Publishing Resources.

URI

POST /api/api-version/sites/site-id/virtualconnections

POST /api/api-version/sites/site-id/virtualconnections?publishAsDraft=publish-as-draft-flag

POST /api/api-version/sites/site-id/virtualconnections?overwrite=overwrite-flag

POST /api/api-version/sites/site-id/virtualconnections?uploadSessionId=upload-session-id&overwrite=overwrite-flag

URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The LUID of the site to publish to.
publish-as-draft-flag (Optional) true to publish the virtual connection as a draft, or false to publish it as an active virtual connection. The default is true. This parameter applies only when you publish a JSON representation. The parameter is case sensitive.

If the virtual connection contains an extract, the publishAsDraft parameter value is ignored and the virtual connection is published as a draft.

Note: If you are using the REST API to publish a virtual connection as a draft, note the virtual connection's LUID (virtualconnection id) in the response body. Use that LUID to build a URL to further edit, create extracts for, or publish the virtual connection using the virtual connection editor in the regular web interface. For more information, see "Draft in Progress" in the Tableau Cloud Product Help(Link opens in a new window) and Tableau Server Product Help(Link opens in a new window).
overwrite-flag true to overwrite a virtual connection that has the same name in the target project, or false to fail if the specified virtual connection already exists. The default is false. If overwrite-flag is set to true but the virtual connection doesn't already exist, the operation succeeds.
upload-session-id (Optional, .tvcx files only) If you are calling this method to commit a file that was uploaded in parts, this value contains the upload session ID that was generated by a call to Initiate File Upload. If this value is not included, the server assumes that the body of the request contains the file to be published.

Request Body

The request body depends on whether you publish a .tvcx file or a JSON representation.

Publishing a .tvcx file

The content type in the header of requests to publish a .tvcx file must use the mixed multipart content type with a boundary string definition, in the form of: Content-Type: multipart/mixed; boundary=boundary-string. The server uses this content type to tell a .tvcx request from a JSON request. A request with any other content type, such as application/octet-stream or multipart/form-data, is handled as a request to publish a JSON representation and fails.

Publishing a file in the request body 

--boundary-string
Content-Disposition: name="request_payload"
Content-Type: text/xml

<tsRequest>
  <virtualConnection name="virtualconnection-name">
    <project id="project-id" />
    <owner id="owner-id" />
  </virtualConnection>
</tsRequest>
--boundary-string
Content-Disposition: name="tableau_virtual_connection"; filename="virtualconnection-name.tvcx"
Content-Type: application/octet-stream

content-of-virtualconnection-file
--boundary-string--

Committing a file previously uploaded 

--boundary-string
Content-Disposition: name="request_payload"
Content-Type: text/xml

<tsRequest>
  <virtualConnection name="virtualconnection-name">
    <project id="project-id" />
    <owner id="owner-id" />
  </virtualConnection>
</tsRequest>
--boundary-string--

Publishing a JSON representation 

<tsRequest>
  <virtualConnection name="virtualconnection-name">
    <project id="project-id" />
    <owner id="owner-id" />
    <content>virtualconnection-as-json</content>
  </virtualConnection>
</tsRequest>

{
  "virtualConnection": {
    "project": {
      "id": "project-id"
    },
    "owner": {
      "id": "owner-id"
    },
    "content": "virtualconnection-as-json",
    "name": "virtualconnection-name"
  }
}

Request Attributes

For a .tvcx file

boundary-string (Required) A string of characters that is guaranteed to be unique within the body of the request, and that is used to delimit sections of the request body. This value must be declared as a header that has this format:

Content-type: multipart/mixed; boundary=boundary-string
virtualconnection-name (Required) The name to assign to the virtual connection when it is saved on the server. This is typically derived from the file name.
project-id (Optional) The LUID of the project to publish to. If you omit it, the virtual connection is published to the default project.
owner-id (Optional) The LUID of the owner of the virtual connection. If you omit it, the authenticated user becomes the owner.
tableau_virtual_connection file part The .tvcx file. Include it when you publish in a single request. Omit it when you commit a file that was uploaded in parts. If you include both a file part and the uploadSessionId parameter, or if you include neither, the request fails.

For a JSON representation

virtualconnection-name The name of the virtual connection you are publishing. If publishing an existing virtual connection as a revision, the virtual connection name is ignored.
project-id The LUID of the project you are publishing to.
owner-id This attribute is required, but is ignored.
virtualconnection-as-json

The virtual connection schema rendered as JSON, as obtained using the Download Virtual Connection as JSON or Download Virtual Connection Revision as JSON method. The schema appears in the content element (for XML output) or content property (for JSON output).

Note: Changing the downloaded schema and then using it with this method isn't supported.

When using the Publish Virtual Connection method, we recommend using the virtual connection schema format that matches the format you used for downloading it. This is important because the virtual connection schema returned by the download methods has escape characters in it if the output was JSON. If you download and publish using different formats, you will have to make changes to the JSON representation of the virtual connection.

In other words:

  • If the output of the Download Virtual Connection as JSON method was XML (except for the content element, which is always a form of JSON), use XML when using this Publish Virtual Connection method.
  • If the output of the Download Virtual Connection as JSON method was JSON (in which case it will have escape characters in the content property), use JSON when using this Publish Virtual Connection method.
  • Alternatively, you can escape or unescape the schema yourself if you are downloading and publishing using different formats.

For more information on the difference between using XML and using JSON with the REST API, see Fundamentals of the Tableau Server REST API.

cURL Example

Publishing a .tvcx file

curl "http://MY_SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections?overwrite=false" -X POST -H "X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3" -H "Content-Type: multipart/mixed; boundary=----TabBoundary" --data-binary @publish-vconn-request.txt

The file publish-vconn-request.txt contains the multipart request body shown above in Publishing a file in the request body.

Publishing a JSON representation

curl --location 'http://MY_SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections?overwrite=true&publishAsDraft=false' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3' --data @data.xml

Content of data.xml: 

<tsRequest>
  <virtualConnection name="Batters">
    <project id="1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e"/>
    <owner id="9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d"/>
    <content>virtualconnection-as-json</content>
  </virtualConnection>
</tsRequest>

Replace virtualconnection-as-json in this example with the virtual connection schema you downloaded using the Download Virtual Connection as JSON method.

Response Code

201

Response Body

The response is the same whether you publish a JSON representation or a .tvcx file.

<tsResponse>
  <virtualConnection id="virtualconnection-id" name="virtualconnection-name">
    <project id="project-id" />
  </virtualConnection>
</tsResponse>

{
  "virtualConnection": {
    "project": {
      "id": "project-id"
    },
    "id": "virtualconnection-id",
    "name": "virtualconnection-name"
  }
}

Errors

HTTP status error Code Condition Details
400 400000 Bad request

When you publish a .tvcx file, the request is not valid for one of these reasons:

  • The request does not include request_payload or the virtualConnection element.
  • The virtualConnection element does not include a name.
  • The request includes both the .tvcx file and uploadSessionId, or it includes neither. Include only one.
  • The file for the uploadSessionId is no longer available.
  • The .tvcx file is not valid.
  • The virtual connection could not be published with the extract in the .tvcx file.
400 400201 Publish virtual connection error The virtual connection could not be published. This includes content that is not valid virtual connection JSON, or a .tvcx file or its contents that could not be read.
403 403008 Insufficient site storage The content would exceed the site's storage quota. Applies when publishing a .tvcx file.
403 403175 Publish virtual connection forbidden The user does not have permission to publish the virtual connection.
404 404015 File upload not found The uploadSessionId does not match an upload owned by the user. Applies when publishing a .tvcx file.
404 404049 Virtual connection not found The virtual connection could not be found while publishing it with the extract in the .tvcx file.
405 405000 Invalid request method Request type was not POST.
409 409123 Virtual connection exists A virtual connection with the same name already exists in the project and overwrite is false. Applies when publishing a .tvcx file.

For more information, see Handling Errors.

List Virtual Connection Permissions

Returns a list of permissions for a specific virtual connection.

URI

GET /api/api-version/sites/site-id/virtualconnections/virtualconnection-id/permissions

Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The ID of the site that contains the virtual connection.
virtualconnection-id The ID of the virtual connection to get permissions for.

Request Body

None

Permissions

You must be an administrator or have the Read (View) permission for the virtual connection (either explicitly or implicitly).

Required scope for JWT authorization

Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17).

Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see Access scopes for UATs(Link opens in a new window) (Cloud), or Access Scopes for Connected Apps(Link opens in a new window) in the Tableau Cloud Help or Access Scopes for Connected Apps(Link opens in a new window) in the Tableau Server Help.

tableau:permissions:read

Response Code

200

Response Body

<tsResponse>
    <permissions>
        <parent id="project-id"
            type="Project"/>
        <virtualConnection id="virtualconnection-id"
            name="virtualconnection-name">
            <owner id="owner-id"/>
        </virtualConnection>
        <granteeCapabilities>
            <group id="group-id"/>
            <capabilities>
                <capability name="capability-name"
                    mode="capability-mode"/>
                <!--   ...additional capabilities...   -->
            </capabilities>
        </granteeCapabilities>
        <granteeCapabilities>
            <user id="user-id"/>
            <capabilities>
                <capability name="capability-name"
                    mode="capability-mode"/>
                <!--   ...additional capabilities...   -->
            </capabilities>
        </granteeCapabilities>
        <!--   ...additional granteeCapability sets...   -->
    </permissions>
</tsResponse>

Note: The parent element is included in the response only if the workbook's permissions are determined by project-level default permissions and project permissions are locked. Project permissions can be locked for a new project when you call Create Project or for an existing project by calling Update Project. For more information, see Lock Content Permissions to the Project(Link opens in a new window).

Version

Version 3.23 and later. For more information, see REST API and Resource Versions.

Errors

HTTP status error Code Condition Details
404 404000 Site not found The site ID in the URI doesn't correspond to an existing site.
404 404004 Virtual Connection not found The virtual connection ID in the URI doesn't correspond to an existing virtual connection.
405 405000 Invalid request method Request type was not GET.

For more information, see Handling Errors.

Example

curl --location 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/permissions' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3'

Update Virtual Connection

Updates a virtual connection's name, owner, project, or certification status.

Version: Available in API 3.23 (Tableau Cloud June 2024 / Tableau Server 2024.2) and later. Version Overview(Link opens in a new window)

License: Requires Tableau Data Management(Link opens in a new window).

Permissions: You must have the Overwrite permission for the virtual connection and your site role must be at least Creator.   Permissions Overview(Link opens in a new window)

JWT Access Scope: tableau:virtual_connections:update

URI

PUT /api/api-version/sites/site-id/virtualconnections/virtualconnection-id

URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The LUID for the site.
virtualconnection-id The LUID for the virtual connection.

Request Body

(Use the icon in the top right corner to copy the text.) 

<tsRequest>
  <virtualConnection name="virtualconnection-name"
    isCertified="certified-flag"
    certificationNote="certification-message">
    <project id="project-id"/>
    <owner id="owner-id"/>
  </virtualConnection>
</tsRequest>

(Use the icon in the top right corner to copy the text.) 

{
  "virtualConnection": {
    "name": "virtualconnection-name",
    "isCertified": "certified-flag",
    "certificationNote": "certification-message",
    "project": {
      "id": "project-id"
    },
    "owner": {
      "id": "owner-id"
    }
  }
}

Request Attributes

virtualconnection-name The name of the virtual connection.
certification-flag Boolean. If true, the virtual connection is certified. If false, it won't.
certification-message The certification label's message.
project-id The LUID of the project the virtual connection is located in.
owner-id

The LUID of the user that owns the virtual connection.

Request attributes that are different from the virtual connection's current properties result in updating the virtual connection.

cURL Request Example

(Use the icon in the top right corner to copy the text.) 

curl --request PUT 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3' --data @data.xml

Contents of data.xml.

(Use the icon in the top right corner to copy the text.) 

<tsRequest>
  <virtualConnection name="Batters"
    isCertified="true"
    certificationNote="Approved by Marketing">
    <project id="1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e"/>
    <owner id="9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d"/>
  </virtualConnection>
</tsRequest>

Response Code

200

Response Body

<tsResponse>
  <virtualConnection id="virtualconnection-id"
    isCertified="certified-flag"
    name="virtualconnection-name">
    <project id="project-id"/>
    <owner id="owner-id"/>
  </virtualConnection>
</tsResponse>

{
  "virtualConnection": {
    "project": {
      "id": "project-id"
    },
    "owner": {
      "id": "owner-id"
    },
    "id": "virtualconnection-id",
    "isCertified": certified-flag,
    "name": "virtualconnection-id"
  }
}

Errors

HTTP status error Code Condition Details
400 400203 Generic error An unknown error occurred.
403 403004 User not authorized to change virtual connection Check to make sure the user has the required permissions.
403 403176 User not authorized to change virtual connection's owner Check to make sure the user has the required permissions.
403 403177 User not authorized to move assets into the target project. Check to make sure the user has the required permissions.
403 403178 User not authorized to move the virtual connection Check to make sure the user has the required permissions.
404 404049 Virtual connection not found Check the virtual connection LUID.
409 409124 A virtual connection with the chosen name already exists in the project. Try a different virtual connection name.

For more information, see Handling Errors.

Update Virtual Connection Database Connections

Updates the server address, port, username, or password for the specified database connection in a virtual connection.

Version: Available in API 3.18 (Tableau Cloud December 2022 / Server 2023.1) and later. Version Overview

License: Requires Tableau Data Management(Link opens in a new window).

Permissions: Users who are administrators or have the site role of Creator or higher can update a database connection.  Permissions Overview

JWT Access Scope: tableau:virtualconnectionconnections:update

URI

PUT /api/api-version/sites/site-id/virtualconnections/virtual-connection-id/connections/connection-id/modify

URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The LUID for the site that contains the virtual connection.
virtual-connection-id The LUID for the virtual connection that includes the database connections.
connection-id The ID of the database connection. To determine what connections are in a virtual connection, call List Virtual Connection Database Connections(Link opens in a new window).

Request Body

<tsRequest>
 <connection
   serverAddress="server-address"
   serverPort="port-number"
   userName="test"
   password="password" />
</tsRequest>
{
  "connection": {
    "serverAddress": "server-address",
    "serverPort": "port-number",
    "userName": "test",
    "password": "password"
  }
}

 

Request Attributes

connection serverAddress The new server for the database connection.
connection serverPort The new port for the database connection
connection userName The new username for the database connection.
connection password The new password for the database connection.

cURL Request Example

curl --location --request PUT "https://MY_SERVER/api/3.18/sites/a946d998-2ead-4894-bb50-1054a91dcab3/virtualconnections/26bc30d8-90d6-4af1-922d-ac285e7b08fb/connections/26bc30d8-90d6-4af1-922d-ac285e7b08fb"

Response Code

200

Response Body

Copy 
<tsResponse>
  <virtualConnectionConnections>
    <connection 
      id="connection-id" 
      serverAddress="server-address" 
      serverPort="port-number"
      userName="connection-user-name"
      password="password"/>
  </virtualConnectionConnections>
</tsResponse>

Copy 
{
  "virtualConnectionConnections": {
    "connection": {
      "id": "connection-id",
      "serverAddress": "server-address",
      "serverPort": "port-number",
      "userName": "connection-user-name",
      "password": "password"
    }
  }
}

Errors

HTTP status error Code Condition Details
400 400000 Bad request The content of the request body is missing or incomplete, or contains malformed XML.
401 401002 Unauthorized The authentication token provided in the request header was invalid or has expired.
403 403004 Operation unauthorized The user isn’t authorized to perform the task.
404 404000 Site not found The site ID in the URI doesn't correspond to an existing site.
405 405000 Invalid request method Request type was not PUT.

For more information, see Handling Errors.

Update Virtual Connection Now

Runs an extract refresh on the specified virtual connection.

This method identifies and refreshes only the tables in the virtual connection that are configured as extracts; live tables are ignored. No additional input is required from the caller.

Note: This method will fail and result in an error if your Server Administrator has disabled the RunNow setting for the site. For more information, see Tableau Server Settings(Link opens in a new window).

Version: Available in API 3.30 and later.

License: Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle.

Permissions: Users who are not server administrators or site administrators can only refresh extracts for virtual connections if they own the virtual connection, or if they are the project leader for the project.

Access Scope: tableau:tasks:run

For more information, see Versions(Link opens in a new window), Permissions(Link opens in a new window), Access scopes for UATs(Link opens in a new window) (Cloud), and access scopes for Cloud(Link opens in a new window), Server-Windows,(Link opens in a new window) or Server-Linux(Link opens in a new window).

URI

POST /api/api-version/sites/site-id/virtualconnections/virtualconnection-id/refresh

URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.
site-id The LUID for the site.
virtualconnection-id The LUID for the virtual connection to refresh.

Request Body

The request body is an empty tsRequest element.

<tsRequest/>

{}

cURL Request Example

(Use the icon in the top right corner to copy the text.) 

curl --request POST 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/refresh' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3' --data '<tsRequest/>'

Response Code

202

Response Body

<tsResponse>
  <job id="job-id" mode="Asynchronous" type="RefreshExtract" createdAt="date-time">
    <extractRefreshJob>
      <virtualConnection id="virtualconnection-id" name="virtualconnection-name" />
    </extractRefreshJob>
  </job>
</tsResponse>

{
  "job": {
    "id": "job-id",
    "mode": "Asynchronous",
    "type": "RefreshExtract",
    "createdAt": "date-time",
    "extractRefreshJob": {
      "virtualConnection": {
        "id": "virtualconnection-id",
        "name": "virtualconnection-name"
      }
    }
  }
}

Errors

HTTP status error Code Condition Details
400 403180 Full refresh not allowed. A full refresh extract operation is not allowed for the virtual connection.
400 403181 Incremental refresh not allowed. The request specified an incremental refresh, but an incremental refresh extract operation is not allowed for the virtual connection.
400 409090 No extract-eligible tables. The virtual connection has no active revision or no extract-eligible tables. Live tables are not refreshed.
403 403199 User not authorized to refresh the virtual connection. The user must have either the Manage Extract or the Allow Extract Refresh permission on the virtual connection.
403 409082 Run Now is disabled for the site. Enable Run Now for the site, then try the request again.
404 404049 Virtual connection not found. Check the virtual connection LUID.
405 405000 Method not allowed. Direct virtual connection extract refresh is not enabled for this site.
409 409093 Operation already in queue. An extract refresh job for the virtual connection is already in the queue.

For more information, see Handling Errors.


Back to top
Thanks for your feedback!Your feedback has been successfully submitted. Thank you!