POST /config/extension_management/extensions

Uploads the supplied extension file to the QRadar system.

Table 1. POST /config/extension_management/extensions resource details
MIME Type
application/json

Table 2. POST /config/extension_management/extensions request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
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. POST /config/extension_management/extensions request body details
Parameter	Data Type	MIME Type	Description	Sample
file	File	application/x-gzip	Required - The Extension file. Must be a properly-formed QRadar extension/content export, either an XML file or an XML within a ZIP or TAR.GZ archive. Must be provided with MIME type application/xml, application/zip, application/x-gzip or multipart/form-data	File

Table 4. POST /config/extension_management/extensions response codes
HTTP Response Code	Unique Code	Description
201		The supplied extension file has been uploaded.
409	22613	The supplied extension file can not be uploaded because it shares the same hub_id and version as one of the extensions in the system.
412	22619	null
412	22620	null
422	22607	The supplied extension could not be validated successfully
422	22616	The supplied manifest for the extension is invalid.
500	22602	An error has occurred while trying to upload the extension file.

Response Description

An extension containing the following fields:

id - Number - Unique ID of this extension within the QRadar deployment.
name - String - The name of the extension.
description - String - The description of the extension.
author - String - The author (person who generated) the extension.
authored_by_email - String - The email of the author.
version - String - The version of the extension.
supported_languages - Array of strings - The language tags supported by this extension.
exported_qradar_version - String - The version of the QRadar deployment this extension was exported from.
min_qradar_version - String - The minimum QRadar version required for the extension to function properly.
file_location - String - The location of the extension file on disk.
size - Number - The size in bytes of the extension file.
signed - String - The state of the extension's signature.
beta - Boolean - True if the extension is considered to be beta or experimental.
added_by - String - The user or authorized service that added the extension to QRadar.
installed_by - String The user or authorized service that installed the extension.
add_time - Number - The date/time at which the extension was added to QRadar, represented as number of milliseconds since Unix epoch.
install_time - Number - The date/time at which the extension was installed, represented as number of milliseconds since Unix epoch.
full_uninstall - Boolean - True if the extension and all of its contents can be fully uninstalled.
status - String - The tag corresponding to the current status of the extension. Possible values are UPLOADED, UPLOADING, INSTALLED, INSTALLING, INSTALL_FAILED, UNINSTALLED, UNINSTALLING, UNINSTALL_FAILED, NOT_INSTALLED, PREVIEWING, NONE.
contents - Array of objects representing an item contained within the extension. Each object has the following fields:
- content_type_id - Number - The ID of the content type.
- content_type_name - String - The name of the content type.
- identifier - String - The descriptive name/identifier of the item.

Response Sample


{
  "file_location": "/store/cmt/exports/qidmaps.xml",
  "supported_languages": [
    "en_US"
  ],
  "contents": [
    {
      "content_type_id": 27,
      "identifier": "",
      "content_type_name": "qidmap"
    }
  ],
  "status": "INSTALLED",
  "signed": "NOT_SIGNED",
  "full_uninstall": false,
  "min_qradar_version": null,
  "beta": false,
  "version": "7.2.6.20150821144442",
  "size": 675,
  "id": 2,
  "author": "admin",
  "authored_by_email": "account@company.com",
  "description": null,
  "exported_qradar_version": null,
  "name": "qidmaps.xml",
  "install_time": 1440612194941,
  "installed_by": "admin",
  "added_by": "admin",
  "add_time": 1440555001236
}