JSON API » plugins » plugins/create

Creates a new 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
name	String	Name.	Yes
command	String	Command to execute.	Yes
answer	Integer	1 to answer before executing, 0 not to. Setting to 0 may cause billing problems.	No	1
customer	Integer	ID of customer who may use this plugin. -1 for all.	No	-1
description	String	Description.	No	Empty string.
panel	Integer	1 to display in control panel, 0 not to.	No	0
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
200	Success.
201	Input passed validation. Only returned if validation=1.
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

The ID of the created plugin.

Example: With required parameters

http://enswitch.example.com/api/json/plugins/create/?auth_username=user;auth_password=password;name=example;command=/bin/true

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123 } }

Change history

Version	Changes
3.13	Function added.