JSON API » configs » configs/list
Gets array of fields of all configuration settings.
Input parameters
Requires authentication and the menus or system role privileges. A few configuration settings containing sensitive information such as usernames and passwords require the system role privilege. If you do not have this privilege, these configuration settings will not be included.
| Name | Type | Description | Required | Default value |
|---|---|---|---|---|
| auth_username | String | Authentication username. | Yes | |
| auth_password | String | Authentication password. | Yes |
Responses
| Code | Description |
|---|---|
| 200 | Success. |
| 401 | The authentication details provided are invalid. |
| 402 | Your role does not allow this. |
Data returned
An array of fields, corresponding to the configuration settings.
Example: With required parameters
http://enswitch.example.com/api/json/configs/list/?auth_username=user;auth_password=password{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "name":"asterisk_version", "value":"11", ... }, { "name":"base_dir", "value":"/var/lib/enswitch", ... } ] }
Change history
| Version | Changes |
|---|---|
| 4.0 | System privilege requirement for sensitive configuration settings added. |
| 3.13 | Function added. |
