Skip to main content

Cloudflare URL Scanner SDK

Project description

Cloudflare URL Scanner PY-SDK

Python SDK for the Cloudflare URL Scanner API. It provides a simple way to interact with the API and scan URLs for malware, phishing, and more. Read more about the Cloudflare URL Scanner API here.

[!NOTE] This SDK is not an official Cloudflare product.

Installation

You can install the SDK using pip:

pip install cloudflare-url-scanner

or from github:

python -m pip install -U git+https://github.com/alexraskin/cloudflare-url-scan

or from source:

git clone
cd cloudflare-url-scan
python -m pip install .

Usage

from cloudflare_scan import UrlScannerClient


cf_client = UrlScannerClient(
    cloudflare_api_key="", #or set the environment variable CLOUDFLARE_API_KEY
    cloudflare_account_id="", #or set the environment variable CLOUDFLARE_ACCOUNT_ID
)

# Scan a URL
scan = cf_client.scan("example.com")

# Get the scan result
result = scan.result

# Get the UUID of the scan
uuid = scan.uuid

# Get the screenshot of the scan
screenshot = cf_client.get_screen_shots(uuid, resolution="desktop")

# Get the HAR file of the scan
har = cf_client.get_har(uuid)

# Get the scan by UUID
scan = cf_client.get_scan(uuid)

# Search for a scan by hostname
scan = cf_client.search("example.com")

# Get the scan result
result = scan.result

# Get the json response
json = scan.json

# Get the text response
text = scan.text

# Get the status code
status_code = scan.status_code

License

MIT

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

cloudflarescan-0.1.0.tar.gz (5.8 kB view hashes)

Uploaded Source

Built Distribution

cloudflarescan-0.1.0-py3-none-any.whl (6.9 kB view hashes)

Uploaded Python 3

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