DOCUMENTATIONAPI REFERENCEAI-Link
DownloadsSupport
Loading search results...
Tableau

Tableau

Server API

HTTP REQUEST: GET

Lists Tableau Server Configurations

GET/api/1.0/org/{orgId}/tableau
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization Id (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if the org identified by orgId does not exist.
500A server error occurred. Check the logs for more details.
200 Response Body
{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": [
    {
      "id": "c86408f7-6f8b-401b-5e89-1d727488af15",
      "org_id": "default",
      "name": "Marketing Tableau Server",
      "server_uri": "https://tableau.server.com",
      "username": "user",
      "password": "password",
      "raw_site_names": "marketing,sales",
      "default_site_name": "default",
      "site_names": [
        "marketing",
        "sales"
      ]
    }
  ]
}

HTTP REQUEST: POST

Create a new Tableau Server Configurations

POST/api/1.0/org/{orgId}/tableau
QUERY PARAMETERS
NameTypeDescription
modestringIf mode is equal to the string 'test', the server will validate the configuration and the create will not be executed.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if the org identified by orgId does not exist.
500A server error occurred. Check the logs for more details.
Request Body
{
  "org_id": "default",
  "name": "Sales Tableau Server",
  "server_uri": "https://tableau.server.com",
  "username": "user",
  "password": "password",
  "raw_site_names": "sales, sales Operations",
  "default_site_name": "default",
  "site_names": [
    "sales",
    "sales Operations"
  ]
}
200 Response Body
{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "org_id": "default",
    "name": "Sales Tableau Server",
    "server_uri": "https://tableau.server.com",
    "username": "user",
    "password": "password",
    "raw_site_names": "sales, sales Operations",
    "default_site_name": "default",
    "site_names": [
      "sales",
      "sales Operations"
    ]
  }
}

Server Update & Delete API

HTTP REQUEST: POST

Updates Tableau Server Configuration

POST/api/1.0/org/{orgId}/tableau/{tableauServerId}
QUERY PARAMETERS
NameTypeDescription
modestringIf mode is equal to the string 'test', the server will validate the configuration and the update will not be executed.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if the org identified by orgId does not exist.
500A server error occurred. Check the logs for more details.
Request Body
{
  "org_id": "default",
  "name": "New Sales Tableau Server",
  "server_uri": "https://tableau.server.com",
  "username": "user",
  "password": "password",
  "raw_site_names": "sales, sales Operations",
  "default_site_name": "default",
  "site_names": [
    "sales",
    "sales Operations"
  ]
}
200 Response Body
{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "id": "c86408f7-6f8b-401b-5e89-1d727488af15",
    "org_id": "default",
    "name": "New Sales Tableau Server",
    "server_uri": "https://tableau.server.com",
    "username": "user",
    "password": "password",
    "raw_site_names": "sales, sales Operations",
    "default_site_name": "default",
    "site_names": [
      "sales",
      "sales Operations"
    ]
  }
}

HTTP REQUEST: DELETE

Delete a Tableau Server Configuration Identified by tableauServerId

DELETE/api/1.0/org/{orgId}/tableau/{tableauServerId}
URI PARAMETERS
NameTypeDescription
orgIdstringThe Organization Id (UUID) for which you are querying.
tableauServerIdstringThe Tableau Server Id (UUID) for which you are querying.
RESPONSES
CodeDescription
200Success.
401This error will occur if calling user does not have access right for the API.
404This error will occur if the org identified by orgId does not exist.
500A server error occurred. Check the logs for more details.
200 Response Body
{
  "status": {
    "i18n_message": "response.ok",
    "message": "OK"
  },
  "response": {
    "org_id": "default",
    "name": "Sales Tableau Server",
    "server_uri": "https://tableau.server.com",
    "username": "user",
    "password": "password",
    "raw_site_names": "sales, sales Operations",
    "default_site_name": "default",
    "site_names": [
      "sales",
      "sales Operations"
    ]
  }
}