Configuration Set

Configuration Set

The Application Summary method returns a list of the available Configuration Scalars. Some or all of the returned configuration scalars may be marked as editable.

The Configuration Set method is an API which allows an administrator to set a new value for an editable configuration scalar. The configuration scalar will be updated in the running config, but the value will be lost on restart of the application.

To make this value permanent on restart, the value must be separately updated in the relevant n2svcd.xml file, database, or wherever the official value of that configuration scalar is stored.

Internally, the ManageApp sends a !MANAGEMENT-CONFIGURATION-SCALAR-REQUEST message to the application and wait for the corresponding !MANAGEMENT-CONFIGURATION-SCALAR-RESPONSE message.

HTTP Request

Special characters in the or must be URI percent-encoded.

The JSON Object has the following structure:

Attribute Type Description
new_value String [Required] The new value which is being submitted.

HTTP Response

In the case of successful update, the following HTTP Response is returned:

The attributes of the JSON Object are as follows:

Attribute Type Description
success 1 [Required] Indicates successful update.
app_name 1 [Required] The name of the Application which whose configuration was set.
configuration_key 1 [Required] The name of the configuration key which was set.
new_value String [Required] The new value which was assigned. May differ from the requested value.

In the case of a soft error performing the configuration update (e.g. value is out of range, user does not have admin authority, etc.) the response is also JSON, with the following structure:

Attribute Type Description
success 0 [Required] Indicates update was not successful.
error 1 [Required] Human readable explaination of the error cause.

In the case of a more serious internal processing error (e.g. Invalid URI, Invalid request body, etc.) the response may be a non-200 HTTP Status, with an optional text/plain Content describing the reason for failure.