JSON API » plugins » plugins/list

Gets the fields of all plugins.

Input parameters

Requires authentication and the user role privilege if available=1, else the plugins role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
available	Integer	1 to return plugins available to a customer, 0 to return all plugins.	No	0
customer	Integer	ID of customer. Only used if available=1.	No	Customer of authentication user.

Responses

Code	Description
200	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.

Data returned

An array of fields, corresponding to the rows of the plugins table in the database.

Example: With required parameters

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

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

Change history

Version	Changes
3.13	Function added.