IBM QRadar 7.4.0 Application Framework Guide

This document describes the IBM QRadar 7.4.0 Application Framework Guide.


IBM QRadar 7.4.0 Application Framework Guide - cover page
Brand
IBM
Category
Programming
Document type
Programming Manual
Language
English
Pages
149
File format
PDF
File size
1.9 MB
Published
29 November, 2023
Updated
29 November, 2023
MD5 checksum
23D72DBE523B2F11B457C85234F6E326

About this manual

IBM QRadar 7.4.0 Application Framework Guide describes how to develop QRadar apps that extend a QRadar deployment with new data and functionality. Apps are Python Flask applications that serve endpoints from a secure container and inject content such as tabs, dashboard items, toolbar buttons, and configuration pages into the QRadar user interface. The document covers the app file and manifest structure, the QRadar App Editor, SDK installation and development environment, packaging and deployment, OAuth authorization, multitenancy, sample apps, logging, globalization, custom actions, and custom AQL functions.

It is for maintaining apps built with CentOS, Python 2, and QRadar App Framework version 1; newer apps built using Red Hat Universal Base Image (UBI) 8 and Python 3 use App Framework version 2 documentation. The guide also notes that IBM X-Force Exchange no longer accepts new apps that use App Framework version 1.

What's inside

  • QRadar apps
  • QRadar app development overview
  • GUI application framework fundamentals
  • Application manifest structure
  • QRadar App Editor
  • Software development kit overview
  • Packaging and deploying your app
  • OAuth app authorization with QRadar
  • Multitenancy support for apps
  • Custom AQL functions

Specifications

App framework versionversion 1
App programming languagePython
Web frameworkFlask
App packaging formatCompressed archive (.zip)
Combined app memory limit10 per cent of total available memory

Frequently asked questions

What is a QRadar app?

A QRadar app is a small plug-in module to the GUI Application Framework that serves endpoints from within a secure container and injects content into the QRadar web interface.

How are QRadar apps packaged?

Apps are packaged as compressed archives (.zip) within the extension archive.

What is the memory limit for installed QRadar apps?

The combined memory requirements of all apps on a QRadar Console cannot exceed 10 per cent of the total available memory; an app that causes this limit to be exceeded does not work.

Can a QRadar app use QRadar's built-in proxy support for internet access?

No. Apps cannot use the proxy support built into QRadar; if an app requires internet access, it must implement proxy support itself.

Download PDF (1.9 MB)

More IBM Manuals


View all IBM manuals →