Get Configuration

Returns the current node configuration properties including defaults, installer values, and configured values. Requires admin password.

Request

GET /nxt?requestType=getConfiguration&adminPassword=<adminPassword>

Parameters

Name	Type	Required	Description
adminPassword	string	Conditional	Admin password required if nxt.adminPassword is set. If the node is configured without a password (nxt.disableAdminPassword is true or host is localhost with empty password), this is not required.

Response

{
  "properties": [
    {
      "name": "nxt.apiServerPort",
      "group": "UI",
      "description": "The port for the API server",
      "defaultValue": "22024",
      "installerValue": "22024",
      "configuredValue": "22024",
      "type": "INTEGER",
      "min": 0,
      "max": 65535
    }
  ]
}

Response Fields

Field	Type	Description
properties	array of objects	Array of configuration property objects.
properties[].name	string	Property name.
properties[].group	string	Property group (e.g., UI, Blockpool, Database).
properties[].description	string	Human-readable description.
properties[].defaultValue	string	Default value of the property.
properties[].installerValue	string	Value used by the installer.
properties[].configuredValue	string	Currently configured value from nxt.properties.
properties[].type	string	Property type: STRING, INTEGER, ACCOUNT, or STRING list.
properties[].isList	boolean	Present when type is STRING or ACCOUNT; indicates if the property accepts a list of values.
properties[].min	integer	Present when type is INTEGER; minimum allowed value.
properties[].max	integer	Present when type is INTEGER; maximum allowed value.

Source: JSONData.configProperty() in JSONData.java.

Notes

• This endpoint does not require the blockchain to be running (requireBlockchain = false).
• Not chain-specific — returns global configuration only.
• Requires admin password authentication (requirePassword = true).

Example

curl "http://localhost:22024/nxt?requestType=getConfiguration"

Related APIs

• Set Configuration
• Utility APIs