JSON file structure

Last Updated : Jun 10, 2026 |

The following table shows attributes that are used in a JSON file to describe dynamic configuration settings:

Attribute

Description

name

The name of the setting.

description

The description of the setting. Avaya Aura® Device Services displays the description when you hover your mouse over the setting name.

If you do not want to provide a description for the setting, set description to "".

type

The data type of the setting.

Settings that represent passwords must have the String type.

default_value

The default value of the setting.

If you do not want to provide a default value, set default_value to "".

version

The version of the setting.

The default version for settings available on Avaya Aura® Device Services. Therefore, you must set the version value for any setting that you import to Avaya Aura® Device Services as follows:

  • Less than 100 if the setting is introduced as a new setting.

  • More that 100 if the setting overwrites any existing setting.

The version value must be higher than the values used in previous imports.

category

The attribute that indicates that the setting represents a password. Avaya Aura® Device Services hides the actual values of these settings on the Avaya Aura® Device Services web administration portal.

For settings that represent passwords, you must include this attribute and set it to PASSWORD.

Do not use this attribute for other settings.

The following example shows a JSON file containing the following two settings:

  • DYNAMIC_SETTING_PASSWORD: Configuration setting that represents a password.

  • DYNAMIC_SETTING_NON_PASSWORD: Non-password configuration settings.

{
	"settings": [
	{
		"name": "DYNAMIC_SETTING_PASSWORD",
		"description": "This is a setting that is used as a password.",
		"type": "String",
		"default_value": "password12345",
		"version": "2",
		"category":"PASSWORD"
	},
	{
		"name": "DYNAMIC_SETTING_NON_PASSWORD",
		"description": "This is a non-password setting of integrer type.",
		"type": "Integer",
		"default_value": "8443",
		"version": "50"
	}
	]
}