POST /config/extension_management/extensions/v2/{extension_id}

Install an extension based on the supplied extension_id. This is an asynchronous action.

Installs the Extension corresponding to the supplied extension_id. Alternatively can be used to preview an Extension, showing what values would be applied if the Extension was installed.

Table 1. POST /config/extension_management/extensions/v2/{extension_id} resource details
MIME Type
application/json

Table 2. POST /config/extension_management/extensions/v2/{extension_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
extension_id	path	Required	Number (Integer)	text/plain	Required - The id of the extension.
action_type	query	Required	String	text/plain	Required - The desired action to take on the Extension (INSTALL or PREVIEW)
overwrite	query	Optional	Boolean	text/plain	Optional - If true, any existing items on the importing system will be overwritten if the extension contains the same items. If false, existing items will be preserved, and the corresponding items in the extension will be skipped.
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. POST /config/extension_management/extensions/v2/{extension_id} response codes
HTTP Response Code	Unique Code	Description
202		The requested install or preview task has been started.
404	22603	The requested extension cannot be found.
404	22604	The task status for status_id cannot be found.
409	22612	The supplied extension cannot be installed/previewed because it is already installed
409	22611	The supplied extension cannot be installed/previewed because it is already in the process of being installed/previewed.
409	22618	The requested task can not be initiated because another preview/install task is already in progress.
422	22605	The supplied action type is invalid
422	22606	A supplied numeric parameter was not positive.
422	22619	The package is not valid. Some of the required dependencies are missing.
500	22602	An error has occurred while trying to install or preview the requested extension.

Response Description

A JSON string depicting the accepted task for previewing/installing an extension:

status_id - Number - id of the task status.
message - String - description of the accepted task.
status_location - String - the url of the task status.

Response Sample


{
	"status_id": 25,
	"message": "Installing an extension",
	"status_location": "https://10.10.10.10/console/restapi/api/config/extension_management/extensions_task_status/25"
}