GET /config/extension_management/extensions/{extension_id}

Retrieves an extension based on the supplied extension_id.

Requires the System Administrator or Security Admin permissions. Retrieves an extension based on the supplied extension_id.

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

Table 2. GET /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.
content_limit	query	Optional	Number (Integer)	text/plain	Optional - Limit the number of manifest items returned for each extension
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/{extension_id} response codes
HTTP Response Code	Unique Code	Description
200		The requested extension has been retrieved.
404	22603	The requested extension cannot be found.
422	22606	A supplied numeric parameter was not positive.
500	22602	An error has occurred while trying to retrieve the requested extension.

Response Description

An extension containing 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


{
    "add_time": 42,
    "added_by": "String",
    "author": "String",
    "authored_by_email": "String",
    "beta": true,
    "content_operation_error": "String",
    "contents": [
        {
            "content_metadata": "String",
            "content_type_id": 42,
            "content_type_name": "String",
            "identifier": "String"
        }
    ],
    "description": "String",
    "exported_qradar_version": "String",
    "file_location": "String",
    "fips_compliant": true,
    "full_uninstall": true,
    "id": 42,
    "install_time": 42,
    "installed_by": "String",
    "min_qradar_version": "String",
    "name": "String",
    "signed": "String <one of: NOT_SIGNED, SIGNED_NOT_VERIFIED_NOT_VALIDATED, SIGNED_AND_VERIFIED_NOT_VALIDATED, SIGNED_AND_VERIFIED_AND_VALIDATED, SIGNED_AND_VERIFIED_NOT_VALIDATED_OLDCA, SIGNED_AND_VERIFIED_AND_VALIDATED_OLDCA, UNKNOWN>",
    "signer_date": 42,
    "signer_subject": "String",
    "size": 42,
    "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>",
    "supported_languages": [
        "String"
    ],
    "validation_date": 42,
    "version": "String"
}