Add or Update Entity Settings

Select

SaaS

Customer Managed

This API allows you to add or update settings for linked entities, such as servers or server groups. Use this endpoint to modify the default behavior of these entities.

application/json

Request Body

• entitySettings 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.

  value string

  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

  entity object required

  id int32

  type string

Responses

• 200

---

Success

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

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

PUT /v4/entitysettings    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

• Default
• Modify entity setting
• Reset entity setting
• Set clean recovery point in entity of Recovery group
• Reset clean recovery point

---

{
  "entitySettings": [
    {
      "name": "string",
      "category": "string",
      "type": "Integer",
      "value": "string",
      "comment": "string",
      "reset": true,
      "entity": {
        "id": 0,
        "type": "string"
      }
    }
  ]
}

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/EntitySettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entitySettings": [
    {
      "name": "string",
      "category": "string",
      "type": "Integer",
      "value": "string",
      "comment": "string",
      "reset": true,
      "entity": {
        "id": 0,
        "type": "string"
      }
    }
  ]
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/EntitySettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entitySettings": [
    {
      "name": "string",
      "category": "string",
      "type": "Integer",
      "value": "string",
      "comment": "string",
      "reset": true,
      "entity": {
        "id": 0,
        "type": "string"
      }
    }
  ]
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/EntitySettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entitySettings": [
    {
      "name": "string",
      "category": "string",
      "type": "Integer",
      "value": "string",
      "comment": "string",
      "reset": true,
      "entity": {
        "id": 0,
        "type": "string"
      }
    }
  ]
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/EntitySettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entitySettings": [
    {
      "name": "string",
      "category": "string",
      "type": "Integer",
      "value": "string",
      "comment": "string",
      "reset": true,
      "entity": {
        "id": 0,
        "type": "string"
      }
    }
  ]
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/EntitySettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entitySettings": [
    {
      "name": "string",
      "category": "string",
      "type": "Integer",
      "value": "string",
      "comment": "string",
      "reset": true,
      "entity": {
        "id": 0,
        "type": "string"
      }
    }
  ]
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/EntitySettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entitySettings": [
    {
      "name": "string",
      "category": "string",
      "type": "Integer",
      "value": "string",
      "comment": "string",
      "reset": true,
      "entity": {
        "id": 0,
        "type": "string"
      }
    }
  ]
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/EntitySettings' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "entitySettings": [
    {
      "name": "string",
      "category": "string",
      "type": "Integer",
      "value": "string",
      "comment": "string",
      "reset": true,
      "entity": {
        "id": 0,
        "type": "string"
      }
    }
  ]
}'