Skip to main content

cyjax-cti provides a Python library to use Cyjax platform API.

Project description

Introduction

cyjax-cti is a Python library to use Cyjax platform API. You can access different resources (incident reports, threat actors, indicators of compromise, etc.) from a Python script.

The library is available on Python Package Index.

Install

You can install the cyjax-cti library with pip:

pip install cyjax-cti

Supported resources

Resource class Methods
Dashboard list, list_widgets, get_table_widget, get_mitre_widget, get_metric_widget, get_map_widget, get_counter_widget
DataBreach one, list
IncidentReport one, list
IndicatorOfCompromise list, enrichment
LeakedEmail one, list, search
MaliciousDomain list
Paste one, list
SocialMedia one, list
Supplier create, delete, one, list, update
TailoredReport one, list
ThreatActor list
Tier list
TorExitNode one, list
Tweet list

Examples

Set the API key

import cyjax

# set a global API key
cyjax.api_key = "346568ecf85f0b5ca98f389908e8b803"

# set a resource API key
cyjax.IndicatorOfCompromise(api_key="346568ecf85f0b5ca98f389908e8b803")

Get indicators of compromise in the last 5 minutes

import cyjax
from datetime import timedelta

cyjax.api_key = "346568ecf85f0b5ca98f389908e8b803"

indicators = cyjax.IndicatorOfCompromise().list(since=timedelta(minutes=5))
for indicator in indicators:
    print(indicator)

Get APT activity in last 6 months

import cyjax
from datetime import timedelta

cyjax.api_key = "346568ecf85f0b5ca98f389908e8b803"

reports = cyjax.IncidentReport().list(query="APT", since=timedelta(days=30*6))
for report in reports:
    print("Title: {}" % report['title'])
    print("Severity: {}" % report['severity'])
    print("Timestamp: {}" % report['last_update'])

Get leaked emails in the last 30 days

import cyjax
from datetime import timedelta

cyjax.api_key = "346568ecf85f0b5ca98f389908e8b803"

for leaked_email in cyjax.LeakedEmail().list(since=timedelta(days=30)):
    print("Email: {}" % leaked_email['email'])
    print("Source: {}" % leaked_email['source'])
    print("Timestamp: {}" % leaked_email['discovered_at'])

Get incident report by ID

import cyjax

cyjax.api_key = "346568ecf85f0b5ca98f389908e8b803"

incident_report = cyjax.IncidentReport().one(10)

print("Report title: {}" % incident_report.get('title'))
print("Report severity: {}" % incident_report.get('severity'))
print("Report content: {}" % incident_report.get('content'))

Project details


Download files

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

Source Distribution

cyjax-cti-2.0.2.tar.gz (46.3 kB view details)

Uploaded Source

Built Distribution

cyjax_cti-2.0.2-py3-none-any.whl (86.7 kB view details)

Uploaded Python 3

File details

Details for the file cyjax-cti-2.0.2.tar.gz.

File metadata

  • Download URL: cyjax-cti-2.0.2.tar.gz
  • Upload date:
  • Size: 46.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.10.0 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/1.0.0 urllib3/1.26.20 tqdm/4.64.1 importlib-metadata/4.2.0 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.15

File hashes

Hashes for cyjax-cti-2.0.2.tar.gz
Algorithm Hash digest
SHA256 51114205ccefc1aa22a5e0f9131b082c9c9a4fa76d0d75e059b98a00bfc3706d
MD5 143c728d80a842da37412dab9993a888
BLAKE2b-256 0c746e4fc2707d7cf5aedc586153d6076308ec9b381b074dd2518f81c3efd0e3

See more details on using hashes here.

File details

Details for the file cyjax_cti-2.0.2-py3-none-any.whl.

File metadata

  • Download URL: cyjax_cti-2.0.2-py3-none-any.whl
  • Upload date:
  • Size: 86.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.10.0 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/1.0.0 urllib3/1.26.20 tqdm/4.64.1 importlib-metadata/4.2.0 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.15

File hashes

Hashes for cyjax_cti-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 156332701e3f9880ebb8fdc37bdd5482d553c46f16ee242af2e517f760d5fe3a
MD5 d1655b9f182de7113188b341b92f2d20
BLAKE2b-256 9a4cf016a50d40b3d2af3a767b7fc079d3705ea810e74e1028b62cc923692a38

See more details on using hashes here.

Supported by

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