GET /config/extension_management/extensions

Retrieve a list of extensions.

Retrieves a list of extensions.

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

Table 2. GET /config/extension_management/extensions request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
Range	header	Optional	String	text/plain	Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.
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.
filter	query	Optional	String	text/plain	Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.
sort	query	Optional	String	text/plain	Optional - This parameter is used to sort the elements in a list.

Table 3. GET /config/extension_management/extensions response codes
HTTP Response Code	Unique Code	Description
200		The requested list of extensions has been retrieved.
422	22608	The supplied filter is invalid.
422	22615	Unknown status used in filter.
422	22610	The selected field cannot be utilized for sorting.
422	22609	Only top-level-elements of the root entity can be sorted on.
500	22602	An error has occurred while trying to retrieve the list of extensions.

Response Description

A list of extensions. Each extension contains 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/custom_rule.zip",
    "supported_languages": [
      "en_US"
    ],
    "contents": [
      {
        "content_type_id": 3,
        "identifier": "No Description Supplied",
        "content_type_name": "custom_rule"
      },
      {
        "content_type_id": 28,
        "identifier": "Asset Reconciliation IPv4 Blacklist",
        "content_type_name": "reference_data"
      },
      {
        "content_type_id": 28,
        "identifier": "Asset Reconciliation IPv4 Whitelist",
        "content_type_name": "reference_data"
      },
      {
        "content_type_id": 32,
        "identifier": "No Description Supplied",
        "content_type_name": "reference_data_rules"
      }
    ],
    "status": "INSTALLED",
    "signed": "NOT_SIGNED",
    "full_uninstall": false,
    "min_qradar_version": null,
    "beta": false,
    "version": "7.2.6.20150825133843",
    "size": 8575,
    "id": 59,
    "author": "admin",
    "authored_by_email": "account@company.com",
    "description": null,
    "exported_qradar_version": null,
    "name": "custom_rule.xml",
    "install_time": 1440788704856,
    "installed_by": "admin",
    "added_by": "admin",
    "add_time": 1440693660702
  },
  {
    "file_location": "/store/cmt/exports/qidmap.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": "qidmap.xml",
    "install_time": 1440612194941,
    "installed_by": "admin",
    "added_by": "admin",
    "add_time": 1440555001236
  }
]