Tableau Server includes a set of administrative services and tools called Tableau Services Manager (TSM). This set of documentation describes the prerelease (0.5 alpha) TSM API, which you can use to perform a wide range of tasks, including the following:
You can also perform these tasks using the Tableau-supported TSM command line interface.
When you use the TSM API, you make requests using standard HTTP verbs like GET and POST. Each resource that you request is located at an endpoint like the following:
https://<server>:<port>/api/<version>/<endpoint>
For example, to send an authentication request to the login
endpoint, you might send a request to the following URL:
https://your-server:8850/api/0.5/login
The TSM API and the Tableau Server REST API are both RESTful APIs, but they do not share authentication methods or functionality. You use the TSM API to manage the state and services of Tableau Server, and you use the Use the Tableau Server REST API to manage users, groups, workbooks other content on Tableau Server.
Depending on the endpoint, you might also need to include the following parameters in the request:
Request path parameters
The parameters to include as part of the main URL path. All parameters are required.
For example, in the /asyncJobs/<jobId>
endpoint, <jobId>
is a path parameter.
Request query parameters
The query parameters to include in the request URL. Parameters are marked as required or optional.
Use the following syntax to specify query parameters:
/<endpoint>?<query_parameter>=<query_parameter1_value>&<query_parameter2>=<query_parameter2_value>
For example:
/backupFixedFile?writePath=backup_name&skipVerification=true
Request body parameters
The parameters to include in the request body. Request body parameters are required.
In the example below, <user_name>
and <password>
are request body parameters.
{
"authentication": {
"name": "<user_name>",
"password": "<password>"
}
}
For more information and for a full list of endpoints (or methods), see the TSM API Reference. To see examples of how you can use the TSM API, see Samples.
If a request results in an error, the server returns an HTTP status code that indicates the general nature of the error. These can include 400 (Bad Request) if Tableau Server or Tableau Online cannot parse or interpret the message in the request, 403 (Forbidden) if the request was not authorized, 404 (Not Found) if a resource could not be located, and 405 (Method Not Allowed) if the wrong verb was used for an operation(for example, making a GET request instead of a POST request).
In the following error codes, the first three digits show the HTTP status code, and the last three digits show the error code.
Code | Error Type |
---|---|
400500 | REQUEST_NOT_PROCESSED |
400501 | LICENSE_ALREADY_ACTIVATED_ERROR |
400502 | LICENSE_INVALID_KEY_ERROR |
400503 | REQUEST_CONTENT_NOT_ALLOWED |
400504 | BAD_FILE_UPLOAD |
400505 | BAD_PARAMS |
400506 | LICENSE_REGISTRATION_VALIDATION_ERROR |
400507 | FILESTORE_CANNOT_DECOMMISSION |
400508 | CONFIGURATION_VALIDATION_ERROR |
401500 | UNAUTHORIZED |
403500 | FORBIDDEN |
404500 | RESOURCE_NOT_FOUND |
405000 | RESOURCE_METHOD_NOT_ALLOWED |
405500 | METHOD_NOT_ALLOWED |
408000 | REQUEST_TIMEOUT |
409500 | IDENTITY_STORE_ALREADY_INITIALIZED |
409501 | REQUESTED_PENDING_NOT_ALLOWED |
409502 | ENTITY_KEY_COLLISION |
409504 | RUN_AS_USER_CANNOT_LOGON |
409505 | RUN_AS_USER_CANNOT_READ_AD |
409506 | ENTITY_IN_USE |
409507 | READ_ONLY_CONFIG_KEY |
409508 | VALIDATION_FAILED |
409509 | FILESTORE_NEEDS_TO_BE_DECOMMISSIONED |
409510 | SERVER_CANNOT_OVERWRITE_FILE |
409511 | ASYNC_JOB_NOT_QUEUED |
409512 | SERVER_NEEDS_TO_BE_STOPPED |
409513 | AUTH_CONFIG_ERROR |
409514 | IDENTITY_STORE_ERROR |
409515 | LDAP_SEARCH_ERROR |
409516 | SERVER_NEEDS_TO_BE_STARTED |
409517 | TWO_ZOOKEEPER_ENSEMBLES |
413500 | PAYLOAD_TOO_LARGE |
423500 | SERVER_CANNOT_ACCESS_FILE |
500501 | LICENSE_RETURN_ERROR |
500502 | LICENSE_RESYNC_ERROR |
500504 | LICENSE_SERVER_ERROR |
500505 | INITIALIZATION_REQUEST_ERROR |
500506 | LICENSE_SERVER_OFFLINE_ERROR |
500507 | REGISTRATION_REQUEST_ERROR |
500508 | LICENSE_REGISTRATION_INTERNAL_ERROR |
500509 | SECURITY_CONFIGURATION_INTERNAL_ERROR |
500600 | INTERNAL_SERVER_ERROR |
503500 | ZOOKEEPER_SERVICE_UNAVAILABLE |
503501 | NODE_ID_GENERATOR_UNAVAILABLE |