API
Documentation

Comprehensive API documentation for integrating CyberXprt's AI-powered cybersecurity intelligence into your applications.

Quick Start

Get Started in Minutes

1

Get Your API Key

Sign up for a free account and generate your API key from the dashboard.

2

Make Your First Request

Use our REST API to start scanning targets and retrieving threat intelligence.

3

Integrate & Scale

Build powerful security applications with our comprehensive API endpoints.

Example: Start a Scan

curl -X POST "https://api.cyberxprt.com/v1/scans" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "example.com",
    "scan_type": "comprehensive",
    "modules": ["dns", "whois", "ssl", "ports"]
  }'

API Endpoints

Scans

Core
POST/v1/scans
Start a new security scan
GET/v1/scans/{id}
Get scan details and results
GET/v1/scans
List all scans
DELETE/v1/scans/{id}
Cancel or delete a scan

Vulnerabilities

Management
GET/v1/vulnerabilities
List vulnerabilities
GET/v1/vulnerabilities/{id}
Get vulnerability details
PATCH/v1/vulnerabilities/{id}
Update vulnerability status

Threat Intelligence

Intelligence
GET/v1/threats/ip/{ip}
Get IP threat intelligence
GET/v1/threats/domain/{domain}
Get domain threat intelligence
GET/v1/threats/hash/{hash}
Get file hash intelligence

Reports

Reporting
GET/v1/reports/{id}
Get scan report
GET/v1/reports/{id}/pdf
Download PDF report
GET/v1/reports/{id}/json
Get JSON report data

SDKs & Libraries

Python SDK

Official Python SDK for easy integration with CyberXprt APIs.

pip install cyberxprt-sdk

Python 3.7+

Node.js SDK

JavaScript/TypeScript SDK for Node.js applications.

npm install @cyberxprt/sdk

Node.js 14+

Go SDK

Go SDK for building high-performance security applications.

go get github.com/cyberxprt/sdk-go

Go 1.18+

Java SDK

Java SDK for enterprise applications and microservices.

implementation 'com.cyberxprt:sdk'

Java 8+

PHP SDK

PHP SDK for web applications and WordPress plugins.

composer require cyberxprt/sdk

PHP 7.4+

REST API

Direct REST API access for any programming language.

https://api.cyberxprt.com

HTTP/HTTPS

Code Examples

Python Example

from cyberxprt import CyberXprt

# Initialize client
client = CyberXprt(api_key="your_api_key")

# Start a scan
scan = client.scans.create(
    target="example.com",
    scan_type="comprehensive"
)

# Wait for completion
scan.wait_for_completion()

# Get results
results = scan.get_results()
print(f"Found {len(results.vulnerabilities)} vulnerabilities")

JavaScript Example

const CyberXprt = require('@cyberxprt/sdk');

// Initialize client
const client = new CyberXprt({
  apiKey: 'your_api_key'
});

// Start a scan
const scan = await client.scans.create({
  target: 'example.com',
  scanType: 'comprehensive'
});

// Get results
const results = await scan.getResults();
console.log(`Found ${results.vulnerabilities.length} vulnerabilities`);

Ready to Get Started?

Start building with our comprehensive API documentation and SDKs. Get your free API key today.

Get API KeyFull Documentation