1.9. http://localhost:7080/rest/plugins : Plugin related

Methods

• GET /plugins

  Description

  Looks for the plugins currently present in the system, optionally reloading them from the server's filesystem
  Parameters:

  Name	P.Type	Description	Required	Type	Allowed values	Default value
  name	Query	none		String	-all-	-none-
  enabled	Query	Look for enabled, disabled or both kinds of plugins?	false	Boolean	all
  version	Query	The version of the plugin to look for	false	String	all
  deleted	Query	Whether to look for deleted, installed or both plugins	false	Boolean	all	false
  reload	Query	Whether to reload the plugins from the filesystem before performing the search. This can be used to take into effect the plugins that have been manually put into server's plugin "dropbox" directory.	false	boolean	all
  ps	Query	Page size for paging	false	int	all	20
  page	Query	Page for paging, 0-based	false	Integer	all

  Return type: javax.ws.rs.core.Response

• GET /plugins/{id}

  Description

  Gets info about a single plugin
  Parameters:

  Name	P.Type	Description	Required	Type	Allowed values	Default value
  id	Path	The id of the plugin	true	int	all

  Return type: javax.ws.rs.core.Response

• PUT /plugins/{id}

  Description

  Updates the enablement of a plugin.
  Parameters:

  Name	P.Type	Description	Required	Type	Allowed values	Default value
  id	Path	The id of the plugin	true	int	all
  enabled	Query	true means plugin is enabled, false means plugin is disabled	false	boolean	all

  Return type: javax.ws.rs.core.Response

• DELETE /plugins/{id}

  Description

  Deletes a single plugin, optionally purging it.
  Parameters:

  Name	P.Type	Description	Required	Type	Allowed values	Default value
  id	Path	The id of the plugin	true	int	all

  Return type: javax.ws.rs.core.Response

• POST /plugins

  Description

  Puts the plugin provided using a content handle into a dropbox and scans the dropbox for changes. In another words, this can result in more than just the provided plugin to become registered in the server if there were some unregistered plugins waiting in the dropbox directory. The content identified by the handle is NOT deleted afterwards.
  Parameters:

  Name	P.Type	Description	Required	Type	Allowed values	Default value
  handle	Query	The handle retrieved from upload	false	String	all
  name	Query	Name of the plugin file	false	String	all

  Return type: javax.ws.rs.core.Response

• POST /plugins/deploy

  Description

  Pushes out all the enabled plugins to all the agents running at that point in time. Defaults to start that process immediately. The returned string is a handle that can be used to check whether all the agents received the updated plugins.
  Parameters:

  Name	P.Type	Description	Required	Type	Allowed values	Default value
  delay	Query	The delay in milliseconds before triggering the update on the agents	false	long	all	0

  Return type: javax.ws.rs.core.Response

• GET /plugins/deploy/{handle}

  Description

  Checks whether the deployment to the agents identified by the provided handle has finished or not.
  Parameters:

  Name	P.Type	Description	Required	Type	Allowed values	Default value
  handle	Path	The deploy handle	true	String	all

  Return type: javax.ws.rs.core.Response