Modify Global Settings

Modify global settings used to override system default behaviour

application/json

Request Body

• globalSettings object[]

  name string required

  Name of the setting to be modified. This cannot be modified but is required to identify the setting for which the new value is to be set.

  category string required

  Category of the setting to be modified. This cannot be modified but is required to identify the setting for which the new value is to be set.

  type string required

  Possible values: [Integer, String, Boolean, Multi string]

  Type of the setting to be modified. This cannot be modified but is required to identify the setting for which the new value is to be set.

  newValue string

  New value which will be set for the specified setting, there can be fixed acceptables values for some settings. To get more details about what are acceptable value for a setting, use GET GlobalSettings or GET EntitySettings.

  comment string

  Comment to specify why this value was set for the specified setting

  reset boolean

  To reset the value of any already modified setting, set this to true to reset the value and regain default behaviour

Responses

• 200

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

PUT /v4/globalsettings    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

Body

• Default
• Modify global settings
• Reset global settings

---

{
  "globalSettings": [
    {
      "name": "string",
      "category": "string",
      "type": "Integer",
      "newValue": "string",
      "comment": "string",
      "reset": true
    }
  ]
}

curl -L -X PUT 'https://localhost/webconsole/api/V4/GlobalSettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "globalSettings": [
    {
      "name": "string",
      "category": "string",
      "type": "Integer",
      "newValue": "string",
      "comment": "string",
      "reset": true
    }
  ]
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/GlobalSettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "globalSettings": [
    {
      "name": "string",
      "category": "string",
      "type": "Integer",
      "newValue": "string",
      "comment": "string",
      "reset": true
    }
  ]
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/GlobalSettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "globalSettings": [
    {
      "name": "string",
      "category": "string",
      "type": "Integer",
      "newValue": "string",
      "comment": "string",
      "reset": true
    }
  ]
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/GlobalSettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "globalSettings": [
    {
      "name": "string",
      "category": "string",
      "type": "Integer",
      "newValue": "string",
      "comment": "string",
      "reset": true
    }
  ]
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/GlobalSettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "globalSettings": [
    {
      "name": "string",
      "category": "string",
      "type": "Integer",
      "newValue": "string",
      "comment": "string",
      "reset": true
    }
  ]
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/GlobalSettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "globalSettings": [
    {
      "name": "string",
      "category": "string",
      "type": "Integer",
      "newValue": "string",
      "comment": "string",
      "reset": true
    }
  ]
}'

curl -L -X PUT 'https://localhost/webconsole/api/V4/GlobalSettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "globalSettings": [
    {
      "name": "string",
      "category": "string",
      "type": "Integer",
      "newValue": "string",
      "comment": "string",
      "reset": true
    }
  ]
}'