REST API Versions
Versions of the REST API are identified using major and minor version numbers in the format
<major>.<minor>, as in
When you make a request using the REST API, you include the API version number as part of the request, as in the following example:
When a new version of the REST API becomes available, if you try to call a method that was introduced in the new version but the URI includes a previous version, the method call will fail. In the API reference documentation, each method includes a Version section that tells you the version of the REST API in which that method was introduced.
Small changes to the REST API might be made during update releases, which are identified using the format <major>.<minor>.<update-release>. For example,
2.0.1 is an update release for version 2.0 of the REST API. Update releases might include bug fixes, and might include a new element or attribute in the XML body for a method.
When you specify the API version in the URI of a request, do not include the update release value. For example, when you specify the version number in the URI for update release
2.0.1, use version
Although an update release does not change the version of the REST API, an update release can include changes to the XML for requests and responses. If so, these updates are reflected in the REST API schema (.xsd file). Unlike the version numbers for the REST API as a whole, the version number of the schema file does reflect update releases.
If you rely on the schema (for example, if you generate code from it), you should make sure that you have the latest version of the .xsd file. You should also examine the changes in the schema and determine whether they affect you.
You can determine the version of the schema file by looking at the
xsi:schemaLocation attribute in the opening
<tsResponse> tag of the response body. The
following example shows what the tag looks like for the 3.4 version of the schema.
<tsResponse xmlns="http://tableau.com/api" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://tableau.com/api http://tableau.com/api/ts-api-3.4.xsd">
Tableau Server versions and REST API versions
Versions of the REST API are made available with releases of Tableau Server. The following table lists versions of Tableau Server and of the corresponding REST API and REST API schema versions.
|Tableau Server version||REST API version||Schema version|
|9.0.1 and later versions of 9.0||2.0||2.0.1|