Skip to main content

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.

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

Success

Schema
  • errorMessage string
  • errorCode int32
Loading...