Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

POST /config/extension_management/extension_export_tasks

SUMMARY Exports an extension.

Exports an extension.

Table 1: POST /config/extension_management/extension_export_tasks resource details:

POST /config/extension_management/extension_export_tasks resource details
MIME Type

application/json

Table 2: POST /config/extension_management/extension_export_tasks request parameter details:

POST /config/extension_management/extension_export_tasks 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/extension_export_tasks request body details:

POST /config/extension_management/extension_export_tasks request body details
Parameter Data Type MIME Type Description Sample

configData

Object

application/json

Required - the configuration of the export.

{ "export_contents": [ { "content_item_ids": [ "String" ], "content_type": "String <one of: LOG_SOURCE_TYPES, LOG_SOURCES, CUSTOM_PROPERTIES, REGEX_EXPRESSIONS, LEEF_EXPRESSIONS, CEF_EXPRESSIONS, JSON_EXPRESSIONS, GENERIC_LIST_EXPRESSIONS, NAME_VALUE_PAIR_EXPRESSIONS, XML_EXPRESSIONS, AQL_EXPRESSIONS, CALCULATED_EXPRESSIONS, AQL_PROPERTIES, CALCULATED_PROPERTIES, LOG_SOURCE_EXTENSIONS, QID_RECORDS, CUSTOM_RULES, REFERENCE_DATA, FGROUPS, SAVED_EVENT_FLOW_SEARCHES, REPORTS, INSTALLED_APPLICATIONS, CUSTOM_ACTIONS, CUSTOM_FUNCTIONS, TAGGED_FIELDS>", "filters": [ { "column": "String", "filter_name": "String <one of: CUSTOM, NONDELETED, NONCUSTOM>", "operator": "String <one of: LIKE, ILIKE, EQUAL, NOT_EQUAL, GREATER, LOWER, IN, NOT_IN, REGEX>", "values": [ "String" ] } ], "related_content": [ { "content_type": "String <one of: LOG_SOURCES, CUSTOM_PROPERTIES, REGEX_EXPRESSIONS, LEEF_EXPRESSIONS, CEF_EXPRESSIONS, JSON_EXPRESSIONS, GENERIC_LIST_EXPRESSIONS, NAME_VALUE_PAIR_EXPRESSIONS, XML_EXPRESSIONS, AQL_EXPRESSIONS, CALCULATED_EXPRESSIONS, AQL_PROPERTIES, CALCULATED_PROPERTIES, DSM_EVENT_MAPPINGS, LOG_SOURCE_EXTENSIONS, QID_RECORDS, REFERENCE_DATA_KEYS_AND_ELEMENTS, FGROUP_LINKS, CUSTOM_ACTION_PARAMETERS>", "filters": [ { "column": "String", "filter_name": "String <one of: CUSTOM, NONDELETED, NONCUSTOM>", "operator": "String <one of: LIKE, ILIKE, EQUAL, NOT_EQUAL, GREATER, LOWER, IN, NOT_IN, REGEX>", "values": [ "String" ] } ] } ] } ], "manifest": { "author": "String", "description": "String", "id": "String", "min_qradar_version": "String", "name": "String", "support_contact": "String", "version": "String" } }
Table 4: POST /config/extension_management/extension_export_tasks response codes:

POST /config/extension_management/extension_export_tasks response codes
HTTP Response Code Unique Code Description

201

The requested export task has been started.

422

1021

The export configuration is invalid.

422

1022

The related_content is invalid.

422

1023

The content_item_ids is invalid.

422

1024

The manifest is invalid.

422

1025

The parameter is invalid.

500

1020

An error has occurred while trying to export the extension.

Response Description

A JSON string depicting the accepted task for exporting an extension:
  • task_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