JSON API » configs » configs/update
Updates a configuration setting.
Input parameters
Requires authentication and the system role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
name | String | Name of configuration setting. | Yes | |
value | String | Value to set. | Yes | |
note | String | Note text. | No | Empty string. |
Responses
Code | Description |
---|---|
204 | Success. |
400 | Invalid input parameters specified. Check the key and message fields for more details. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
404 | The 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
Version | Changes |
---|---|
3.15 | note parameter added. |
3.13 | Function added. |