Skip to main content

Get Entity Settings

Get list of entity settings used to modify default behaviour for linked entity like servers or server groups

Responses

Success


Schema
  • entitySettings object[]
  • name string

    Name of the setting

  • description string

    Description of the setting

  • acceptableValues string[]

    Specifies values which are acceptable when modifying the setting value. This will only be returned if there are specific set of values which can be accepted.

  • defaultValue string

    Value used to get default system behaviour

  • values object[]
  • value string

    Value set for the specified setting linked to the specified entity

  • comment string

    Comment set by user while modifying the specified entity setting for the given entity

  • entity object
  • id int32
  • name string
  • type string
  • isModified boolean

    Specifies if the setting is already modified by the user

  • type string

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

    Type of the setting

  • isRestartRequired boolean

    Specifies if it is required to restart the services for any changes to take effect

  • minValue int32

    Specifies minimum value that can be set to modify specified global setting. It is only returned if the setting type is Integer

  • maxValue int32

    Specifies maximum value that can be set to modify specified global setting. It is only returned if the setting type is Integer

  • category string

    Category to which setting belongs

Loading...