JSON API » menus » menus/list

Gets the fields of all menus.

Input parameters

Requires authentication and the menus role privilege.

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 rows of the menus table in the database.

Example: With required parameters

http://enswitch.example.com/api/json/menus/list/?auth_username=user;auth_password=password

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "id":1, "name":"example1", ... }, { "id":2, "name":"example2", ... } ] }

Change history

VersionChanges
4.0auth_username and auth_password input parameters added, and authentication required.
3.13Function added.