Skip to main content

Intezer Platform SDK

Project description

PyPI Build Documentation Status

Intezer SDK

The SDK wraps the Intezer Platform API 2.0 (full HTTP API documentation).

📖 Full documentation: https://intezer-python-sdk.readthedocs.io/

What you can do with the SDK:

  • Analyze files, URLs and endpoint scans
  • Send and retrieve alerts (raw and phishing emails)
  • Inspect incidents and cases (devices, users, TTPs)
  • Search analyses, alerts, incidents, cases and devices history
  • Index files as trusted or malicious and look up genetic families
  • Get code reuse, metadata, IOCs, dynamic TTPs, capabilities and related samples

Installation

pip install intezer-sdk

The SDK requires CPython 3.10 or newer.

Quick start

Configure the global API once, then use any SDK class:

from intezer_sdk import api
from intezer_sdk.analysis import FileAnalysis

api.set_global_api('<api_key>')

analysis = FileAnalysis(file_path='/path/to/sample')
analysis.send(wait=True)
print(analysis.result())

The API key can also be read from the INTEZER_ANALYZE_API_KEY environment variable. See the Getting started guide for US region, on-premise, and multi-tenant setups.

A taste of the SDK

# Analyze a URL
from intezer_sdk.analysis import UrlAnalysis
analysis = UrlAnalysis(url='https://example.com/suspicious')
analysis.send(wait=True)

# Fetch an alert and its scans
from intezer_sdk.alerts import Alert
alert = Alert.from_id(alert_id='<alert_id>', wait=True, fetch_scans=True)
print(alert.verdict, alert.family_name)

# Look up a case
from intezer_sdk.cases import Case
case = Case.from_id(case_id='<case_id>')
print(case.case_title, case.case_status, case.case_priority)

For the full set of examples — wait patterns, sub-analyses, alert ingestion, incident and case search, indexing, history queries, on-premise setup — see the hosted documentation.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

intezer_sdk-1.27.5.tar.gz (54.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

intezer_sdk-1.27.5-py3-none-any.whl (65.7 kB view details)

Uploaded Python 3

File details

Details for the file intezer_sdk-1.27.5.tar.gz.

File metadata

  • Download URL: intezer_sdk-1.27.5.tar.gz
  • Upload date:
  • Size: 54.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for intezer_sdk-1.27.5.tar.gz
Algorithm Hash digest
SHA256 6acdf64b42924eddffdea4b25371016a1824db1bd62c95a413da6d26ea30f85f
MD5 8611cbf35f82660c2123e3294edfb2db
BLAKE2b-256 db46a68ebcf9af20f5e67ec1cbe5450f353df8d44d25353835383c6cb71ed3f5

See more details on using hashes here.

File details

Details for the file intezer_sdk-1.27.5-py3-none-any.whl.

File metadata

  • Download URL: intezer_sdk-1.27.5-py3-none-any.whl
  • Upload date:
  • Size: 65.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for intezer_sdk-1.27.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d2a5d9b6b084de95451d613977d2013d3f8bb394c7fd7f38368e92b294d83549
MD5 2da4e2cdfd53cb54b0e1c934372ce529
BLAKE2b-256 cf981e2cf79d556b4949045537c7126d7de6cb471c222ed29eeb984daf87b259

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page