QRadar v3
IBM QRadar SIEM helps security teams accurately detect and prioritize threats across the enterprise, supports API versions 10.1 and above. Provides intelligent insights that enable teams to respond quickly to reduce the impact of incidents.
Analytics & SIEM · IBM QRadar
Configuration parameters
server— Server URL (required)credentials— Username (required)api_version— QRadar API Version (required)incident_type— Incident Typefirst_fetch— First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)fetch_mode— Fetch moderetry_events_fetch— Retry events fetchevents_limit— Maximum number of events per incident.offenses_per_fetch— Number of offenses to pull per API call (max 50)query— Query to fetch offenses.enrichment— Incidents Enrichmentlimit_assets— Maximum number of assets to fetchevents_columns— Event fields to return from the events query (WARNING: This parameter is correlated to the incoming mapper and changing the values may adversely affect mapping).mirror_options— Mirroring Optionsclose_incident— Close Mirrored XSOAR Incidentmirror_limit— The number of incoming incidents to mirror each timeadv_params— Advanced Parametersinsecure— Trust any certificate (not secure)proxy— Use system proxy settingstimeout— Timeout for http-requestsfetch_interval— Fetch Incidents Interval
Commands (69)
-
get-mapping-fieldsReturns the list of fields for an incident type. This command should be used for debugging purposes.
-
get-modified-remote-dataReturns the list of incidents IDs that were modified since the last update time. Note that this method is for debugging purposes. The get-modified-remote-data command is used as part of the mirroring feature, which is available from version 6.1.
-
get-remote-dataGets remote data from a remote incident. This method does not update the current incident, and should be used for debugging purposes.
-
qradar-assets-listRetrieves assets list.
-
qradar-closing-reasonsRetrieves a list of offense closing reasons.
-
qradar-create-noteDeprecatedCreate a note on an offense. Deprecated, Use qradar-offense-note-create instead.
-
qradar-create-reference-setDeprecatedCreates a new reference set. If the provided name is already in use, this command will fail. Deprecated, Use qradar-reference-set-create instead.
-
qradar-create-reference-set-valueDeprecatedAdd or update a value in a reference set. Deprecated, Use qradar-reference-set-value-upsert instead.
-
qradar-delete-reference-setDeprecatedDeletes a reference set corresponding to the name provided. Deprecated, Use qradar-reference-set-delete instead.
-
qradar-delete-reference-set-valueDeprecatedDeletes a value in a reference set. Deprecated, Use qradar-reference-set-value-delete instead.
-
qradar-disconnected-log-collectors-listRetrieves a list of disconnected log collectors.
-
qradar-domains-listGets the list of domains. You must have System Administrator or Security Administrator permissions to call this endpoint if you are trying to retrieve the details of all domains. You can retrieve details of domains that are assigned to your Security Profile without having the System Administrator or Security Administrator permissions. If you do not have the System Administrator or Security Administrator permissions, then for each domain assigned to your security profile you can only view the values for the ID and name fields. All other values return null.
-
qradar-event-collectors-listRetrieves a list of event collectors.
-
qradar-geolocations-for-ipRetrieves the MaxMind GeoIP data for the specified IP address.
-
qradar-get-asset-by-idDeprecatedRetrieves the asset by id. Deprecated, Use qradar-assets-list instead.
-
qradar-get-assetsDeprecatedList all assets found in the model. Deprecated, Use qradar-assets-list instead.
-
qradar-get-closing-reasonsDeprecatedGet closing reasons. Deprecated, Use qradar-closing-reasons instead.
-
qradar-get-custom-propertiesRetrieves a list of event regex properties.
-
qradar-get-domain-by-idDeprecatedRetrieves Domain information By ID. Deprecated, Use qradar-domains-list instead.
-
qradar-get-domainsDeprecatedRetrieve all Domains. Deprecated, Use qradar-domains-list instead.
-
qradar-get-noteDeprecatedRetrieve a note for an offense. Deprecated, Use qradar-offense-notes-list instead.
-
qradar-get-reference-by-nameDeprecatedInformation about the reference set that had data added or updated. This returns the information set, but not the contained data. This feature is supported from version 8.1 and upward. Deprecated, Use qradar-reference-sets-list instead.
-
qradar-get-searchDeprecatedGets a specific search ID and status. Deprecated, Use qradar-search-status-get instead.
-
qradar-get-search-resultsDeprecatedGets search results. Deprecated, Use qradar-search-results-get instead.
-
qradar-indicators-uploadUploads indicators to QRadar.
-
qradar-ips-local-destination-getGet Source IPs.
-
qradar-ips-source-getGet Source IPs.
-
qradar-log-source-createCreates a new log source.
-
qradar-log-source-deleteDeletes a log source by ID or name. One of the arguments must be provided.
-
qradar-log-source-extensions-listRetrieves a list of log source extensions.
-
qradar-log-source-groups-listRetrieves a list of log source languages.
-
qradar-log-source-languages-listRetrieves a list of log source languages.
-
qradar-log-source-protocol-types-listRetrieves the list of protocol types.
-
qradar-log-source-types-listRetrieves a list of log sources types.
-
qradar-log-source-updateUpdates an exising log source.
-
qradar-log-sources-listRetrieves a list of log sources.
-
qradar-offense-by-idDeprecatedGets offense with matching offense ID from qradar.Deprecated, Use qradar-offense-list instead.
-
qradar-offense-note-createCreates a note on an offense.
-
qradar-offense-notes-listRetrieves a list of notes for an offense.
-
qradar-offense-updateUpdates an offense.
-
qradar-offensesDeprecatedGets offenses from QRadar. Deprecated, Use qradar-offenses-list instead.
-
qradar-offenses-listGets offenses from QRadar.
-
qradar-print-contextReturns a redacted snapshot of integration context metrics (queued, in-progress, finished, meta sizes, concurrent active, samples count). This command is intended for debugging purposes and may return sensitive data.
-
qradar-reference-set-createCreates a new reference set.
-
qradar-reference-set-deleteRemoves a reference set or purges its contents.
-
qradar-reference-set-value-deleteRemoves a value from a reference set.
-
qradar-reference-set-value-upsertAdds or updates an element in a reference set.
-
qradar-reference-sets-listRetrieves a list of reference sets.
-
qradar-remote-network-cidr-createCreate remote network CIDRs.
-
qradar-remote-network-cidr-deleteDeletes an existing staged remote network.
-
qradar-remote-network-cidr-listRetrieves the list of staged remote networks.
-
qradar-remote-network-cidr-updateUpdates an existing staged remote network.
-
qradar-remote-network-deploy-executionExecutes a deployment. Potentially harmful: This API command executes any waiting system deployments in QRadar within the same deployment type and hosts defined.
-
qradar-reset-last-runResets the fetch incidents last run value, which resets the fetch to its initial fetch state. (Will try to fetch the first available offense).
-
qradar-rule-groups-listRetrieves a list of the rule groups.
-
qradar-rules-listRetrieves a list of rules.
-
qradar-saved-searches-listRetrieves a list of Ariel saved searches.
-
qradar-search-cancelCancels the search in QRadar.
-
qradar-search-createCreates a new asynchronous Ariel search. Returns the search ID. Search status and results can be polled by sending the search ID to the 'qradar-search-status-get' and 'qradar-search-results-get' commands. Accepts SELECT query expressions only.
-
qradar-search-deleteDeletes the search from Qradar.
-
qradar-search-results-getRetrieves search results.
-
qradar-search-retrieve-eventsPolling command to search for events of a specific offense.
-
qradar-search-status-getRetrieves status information for a search, based on the search ID.
-
qradar-searchesDeprecatedSearches in QRadar using AQL. It is highly recommended to use the playbook 'QRadarFullSearch' instead of this command - it will execute the search, and will return the result. Deprecated, Use qradar-search-create instead.
-
qradar-searches-listRetrieves the list of Ariel searches IDs. Search status and results can be polled by sending the search ID to the 'qradar-search-status-get' and 'qradar-search-results-get' commands.
-
qradar-update-offenseDeprecatedUpdate an offense. Deprecated, Use qradar-offense-update instead.
-
qradar-update-reference-set-valueDeprecatedAdds or updates a value in a reference set. Deprecated, Use qradar-reference-set-value-upsert instead.
-
qradar-upload-indicatorsUploads indicators from Demisto to QRadar.
-
qradar-wincollect-destinations-listRetrieves a list of WinCollect destinations. In order to get wincollect_internal_destination_ids - filter internal=true needs to be used In order to get wincollect_external_destination_ids - filter internal=false needs to be used.