GET /config/extension_management/extensions

Retrieve a list of extensions.

Requires the System Administrator or Security Admin permissions. 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.

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.

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. 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 - The 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 person who generated the extension.
  • authored_by_email - String - The email address 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 - An 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.
  • fips_compliant - Boolean - True if the extension is FIPS compliant.

Response Sample


[{"min_qradar_version": "String", "add_time": 42, "added_by": "String", "author": "String", "fips_compliant": true, "description": "String", "signed": "String <one of: NOT_SIGNED, SIGNED_NOT_VERIFIED, SIGNED_AND_VERIFIED, UNKNOWN>", "authored_by_email": "String", "file_location": "String", "install_time": 42, "exported_qradar_version": "String", "version": "String", "supported_languages": ["String"], "size": 42, "contents": [{"identifier": "String", "content_type_id": 42, "content_metadata": "String", "content_type_name": "String"}], "content_operation_error": "String", "full_uninstall": true, "name": "String", "installed_by": "String", "id": 42, "beta": true, "status": "String <one of: UPLOADED, UPLOADING, INSTALLED, INSTALLING, INSTALL_FAILED, UNINSTALLED, UNINSTALLING, UNINSTALL_FAILED, NOT_INSTALLED, PREVIEWING, NONE, INSTALLED_WITH_ERROR, UNINSTALL_PREVIEWING, UNINSTALL_PREVIEW_FAILED>"}]