REST API Requirements

Here are the requirements for using the Tableau Server REST API:

  • Tableau Server version: To program with the REST API, you need Tableau Server 9.0 or a later version. Some methods were added in later versions of Tableau Server. The documentation for individual API methods indicates the version of Tableau Server that's required for using that method.

  • API enabled: By default, Tableau Server is installed with the REST API enabled, but it can be disabled. To disable or enable the REST API, use the tsm configuration set command. Change the api.server.enabled setting to true to enable the API or false to disable the API.

    Note: The REST API must be enabled to publish flow output from Tableau Prep to Tableau Server.

Thanks for your feedback! There was an error submitting your feedback. Try again or send us a message.