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

Global

Configurations API

HTTP REQUEST: GET

List all global Configuration values

GET/api/1.0/properties/configurations
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": "account.host",
      "name": "account.host",
      "value": "cheese",
      "type": "string",
      "role": "configuration",
      "group": "account",
      "configurable": true,
      "scope": "global"
    },
    {
      "id": "account.port",
      "name": "account.port",
      "value": "10504",
      "type": "int",
      "role": "configuration",
      "group": "account",
      "configurable": true,
      "scope": "global"
    },
    {
      "id": "tableau.server.readTimeout",
      "name": "tableau.server.readTimeout",
      "value": "60s",
      "type": "int",
      "role": "configuration",
      "group": "tableau",
      "configurable": true,
      "scope": "global"
    }
  ]
}

Configuration Set API

HTTP REQUEST: POST

Sets the global configuration value

POST/api/1.0/properties/configurations/{configurationId}/{newValue}
URI PARAMETERS
NameTypeDescription
configurationIdstringThe Global Configuration ID (non-UUID, human readable) for which you are querying.
newValuestring
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": "account.host",
    "name": "account.host",
    "value": "newValue",
    "type": "string",
    "role": "configuration",
    "group": "account",
    "configurable": true,
    "scope": "global"
  }
}