Update Tableau Server

POST 
/org/:orgId/tableau/:tableauServerId

Updates Tableau Server Configuration

Request

Path Parameters

orgId stringrequired

The Organization Id (UUID) for which you are querying.

tableauServerId stringrequired

The Tableau Server Id (UUID) for which you are querying.

Query Parameters

mode stringrequired

If mode is equal to the string 'test', the server will validate the configuration and the update will not be executed.

application/json

Body

required

any

Responses

200

Success.

application/json

Schema

Schema

any

Example (from schema)

{
  "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"
    ]
  }
}

Example

{
  "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"
    ]
  }
}

401

This error will occur if calling user does not have access right for the API.

404

This error will occur if the org identified by orgId does not exist.

500

A server error occurred. Check the logs for more details.

Loading...