JSON API » plugins » plugins/update

Updates an existing plugin.

Input parameters

Requires authentication and the plugins role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of plugin to update.	Yes
answer	Integer	1 to answer before executing, 0 not to. Setting to 0 may cause billing problems.	No	Current value.
command	String	Command to execute.	No	Current value.
customer	Integer	ID of customer who may use this plugin. -1 for all.	No	Current value.
description	String	Description.	No	Current value.
name	String	Name.	No	Current value.
panel	Integer	1 to display in control panel, 0 not to.	No	Current value.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
201	Input passed validation. Only returned if validation=1.
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 plugin does not exist.

Data returned

No data is returned.

Example: Changing the name

http://enswitch.example.com/api/json/plugins/update/?auth_username=user;auth_password=password;id=123;name=example

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
3.13	Function added.