JSON API » configs » configs/update

Updates a configuration setting.

Input parameters

Requires authentication and the system role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
nameStringName of configuration setting.Yes
valueStringValue to set.Yes
noteStringNote text.NoEmpty string.

Responses

CodeDescription
204Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
404The configuration setting does not exist.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/configs/update/?auth_username=user;auth_password=password;name=asterisk_version;value=11

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

VersionChanges
3.15note parameter added.
3.13Function added.