DELETE /config/extension_management/extensions/{extension_id}

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

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

Table 2. DELETE /config/extension_management/extensions/{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 to be uninstalled.
fields	header	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. DELETE /config/extension_management/extensions/{extension_id} request body details
Parameter	Data Type	MIME Type	Description	Sample
configData	Object	application/json	null	{ "action_type": "String", "cache_uuid": "String", "configs": [ { "config_type": "String <one of: OVERWRITE, SKIP, DEPENDENCIES, PRESERVE>", "content_type_id": 42, "content_type_name": "String", "id": 42, "key_fields": { "String": "String" } } ] }

Table 4. DELETE /config/extension_management/extensions/{extension_id} response codes
HTTP Response Code	Unique Code	Description
202		The requested uninstall task has been started.
404	22603	The requested extension cannot be found.
404	22604	The task status for status_id cannot be found.
409	22611	The supplied extension cannot be uninstalled because it is already in the process of being uninstalled.
409	22617	The extension can not be uninstalled because it is already in the process of being previewed/installed.
409	22618	null
409	22623	null
422	22606	A supplied numeric parameter was not positive.
500	22602	An error has occurred while trying to uninstall an extension.

Response Description

A JSON string depicting the accepted task for uninstalling 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": "Uninstalling an extension",
 "status_location": "https://10.10.10.10/console/restapi/api/config/extension_management/extensions_task_status/25"
}