Skip to main content

QRadar API Client written in Python

This is a wrapper around the REST-API of QRadar. This includes some undocumented endpoints, that may not work as expected.
All the information for the various endpoints were pulled from version 13.1.
If you find any bugs please open an issue or a pull request.

A word of warning

qradar4py is work in progress and should be treated as a software in beta, especially regarding the "undocumented" API endpoints.

Installation

sudo pip3 install qradar4py
# OR
cd qradar4py && sudo python3 setup.py install

Usage

Just a very basic sample on how to get the IDs of up to 10 offenses that are not closed.

from qradar4py.api import QRadarApi

# Initalize the API with the URL, your API token and whether the certificate should be checked.
api = QRadarApi("<URL>", "<API_TOKEN>", version='13.1', verify=True)
# Get all offenses
status_code, response = api.siem.get_offenses(filter='status != CLOSED', 
                                              Range='items=0-50', 
                                              fields='id')

print(status_code, response)
# 200 [{'id': 1}, {'id': 2}, {'id': 3}, {'id': 4}, {'id': 5}]

Mapping

Check the "Interactive API" on QRadar to see what endpoints are available in your version.
Check the documentation to get a mapping from endpoint to method.

Disclaimer

I am in no way affiliated with IBM.
QRadar is a registered trademark by IBM.

Release files for qradar4py 3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qradar4py 3.0
File Size Uploaded
qradar4py-3.0.tar.gz 47.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for qradar4py 3.0
File Interpreter ABI Platform
qradar4py-3.0-py3-none-any.whl Python 3 none any Details

Total release size: 114.8 kB

Release files / qradar4py-3.0.tar.gz

Download URL qradar4py-3.0.tar.gz
Size 47.0 kB
Tags Source
SHA-256 checksum
How to use checksums
3e1734c1820fabc2134d6fde8c185649d64c6cc8c66c4906cbee3d8ba32580ee
BLAKE2b-256 checksum
How to use checksums
7d0b586ffd4a194190e121971d9427ecb700a7902ceeaf1e966835a01891b26a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.5

Release files / qradar4py-3.0-py3-none-any.whl

Download URL qradar4py-3.0-py3-none-any.whl
Size 67.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5b93ecb894df307a4f496f36e400385c3fe9ad26962bdbedc97d384ab3f6c305
BLAKE2b-256 checksum
How to use checksums
701368c3624b0fc697847817d7e8f59f6d66170c952fdbafb78fbf71735ab232
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.5

Release history Release notifications | RSS feed

This release

3.0 This release

2 release files

2.0

2 release files

1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page