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.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes

Responses

CodeDescription
200Success.
401The authentication details provided are invalid.
402Your 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

VersionChanges
4.0System privilege requirement for sensitive configuration settings added.
3.13Function added.