API Reference

API Reference v2

DarkSight Intel Platform API v2

Base URL: https://platform-dev.omegablack.io/api/v1
Version: 2.0
Last Updated: January 2025

Complete API reference for the DarkSight Intel security intelligence platform.

💡 Try It Out! Click the "Try It!" button on any endpoint to test it directly from this documentation. See OpenAPI Specification below for setup instructions.

Authentication

All endpoints except /health require authentication using Bearer tokens.

Header Format:

Authorization: Bearer <your-token>

Getting Your Token:

  1. Log into the DarkSight Intel platform
  2. Open browser DevTools (F12) → Network tab
  3. Make any API request
  4. Find the request → Headers → Copy the Authorization: Bearer <token> value

For "Try It" Testing:

  • Enter your Bearer token in the authentication field when testing endpoints
  • The token will be automatically included in all API requests

Core

  • /api/v1
    • Get API informationget
  • /api/v1/status
    • Get API statusget
  • /api/v1/health
    • Health checkget

Dashboard

  • /api/v1/dashboard/metrics
    • Get dashboard metricsget
  • /api/v1/dashboard/trends
    • Get dashboard trendsget

Reports

  • /api/v1/reports
    • List reportsget
    • Create reportpost
  • /api/v1/reports/{id}
    • Get reportget
    • Update reportput
    • Delete reportdelete

Signals

  • /api/v1/signals
    • List signalsget
    • Create signalpost

Credentials

  • /api/v1/credentials
    • List credentialsget
    • Create credentialpost

Cyber Attacks

  • /api/v1/cyber-attacks
    • List cyber attacksget
    • Create attackpost
  • /api/v1/cyber-attacks/{id}
    • Get attack detailsget

Brand Intelligence

  • /api/v1/brand-intelligence
    • Analyze domainpost
  • /api/v1/brand-intelligence/{domain}
    • Get cached analysisget

Fraud Intelligence

  • /api/v1/fraud-intelligence/overview
    • Get fraud overviewget
  • /api/v1/fraud-intelligence/cards
    • Get fraud cardsget
  • /api/v1/fraud-intelligence/accounts
    • Get fraud accountsget

CVE Intelligence

  • /api/v1/cve-intelligence/vulnerabilities
    • List vulnerabilitiesget
  • /api/v1/cve-intelligence/vulnerabilities/{id}
    • Get vulnerability detailsget
  • /api/v1/cve-intelligence/trending
    • Get trending CVEsget

Vendors

  • /api/v1/vendors
    • List vendorsget
  • /api/v1/vendors/{vendorId}
    • Get vendor detailsget

Search

  • /api/v1/search
    • Cross-collection searchget

Organizations

  • /api/v1/organizations
    • List organizationsget
    • Create organizationpost
  • /api/v1/organizations/{id}
    • Get organizationget
    • Update organizationput
    • Delete organizationdelete

User

  • /api/v1/user
    • Get user profileget

External Integrations

  • /api/v1/feedly
    • Feedly integrationget
  • /api/v1/parseintel
    • ParseIntel integrationget

Get API information

get

https://platform-dev.omegablack.io/api/v1

Returns API information, available endpoints, and documentation links.

Authentication

Bearer

Response

{
  "name": "DarkSight Intel Platform API",
  "version": "1.0.0",
  "description": "Comprehensive API for DarkSight Intel security intelligence platform",
  "baseUrl": "https://platform-dev.omegablack.io/api/v1",
  "endpoints": {
    "health": "/api/v1/health",
    "dashboard": "/api/v1/dashboard",
    "reports": "/api/v1/reports",
    "signals": "/api/v1/signals",
    "credentials": "/api/v1/credentials",
    "cyberAttacks": "/api/v1/cyber-attacks",
    "brandIntelligence": "/api/v1/brand-intelligence",
    "fraudIntelligence": "/api/v1/fraud-intelligence",
    "cveIntelligence": "/api/v1/cve-intelligence",
    "vendors": "/api/v1/vendors",
    "search": "/api/v1/search",
    "feedly": "/api/v1/feedly",
    "parseintel": "/api/v1/parseintel"
  },
  "authentication": {
    "type": "Bearer Token",
    "header": "Authorization: Bearer <token>",
    "description": "All endpoints except /health require authentication"
  },
  "documentation": {
    "openapi": "/api/v1/openapi.json",
    "postman": "/api/v1/postman-collection.json"
  },
  "timestamp": "2025-01-26T12:00:00.000Z"
}

Get API status

get

https://platform-dev.omegablack.io/api/v1/status

Get detailed API status and service health.

Authentication

Bearer

Response

{
  "status": "operational",
  "version": "1.0.0",
  "timestamp": "2025-01-26T12:00:00.000Z",
  "services": {
    "api": "operational",
    "database": "operational",
    "auth": "operational"
  },
  "endpoints": {
    "total": 8,
    "operational": 8,
    "degraded": 0
  }
}

Health check

get

https://platform-dev.omegablack.io/api/v1/health

Check API health status. No authentication required.

Response

{
  "status": "healthy",
  "timestamp": "2025-01-26T12:00:00.000Z"
}

Get dashboard metrics

get

https://platform-dev.omegablack.io/api/v1/dashboard/metrics

Get aggregated metrics for the dashboard.

Authentication

Bearer

Query Parameters

ParameterTypeRequiredDescription
timeRangestringNoTime range: 24h, 7d, 30d, or 90d (default: 7d)

Response

{
  "timeRange": "7d",
  "period": {
    "start": "2025-01-19T12:00:00.000Z",
    "end": "2025-01-26T12:00:00.000Z"
  },
  "metrics": {
    "fraud": {
      "activeCases": 45,
      "highSeverity": 12,
      "uniqueSignals": 320
    },
    "credentials": {
      "total": 150,
      "uniqueServices": 25,
      "withMFA": 80,
      "withoutMFA": 70
    },
    "cyberAttacks": {
      "total": 12,
      "ransomware": 3,
      "phishing": 5,
      "uniqueThreatActors": 8
    },
    "reports": {
      "total": 150,
      "discovered": 45,
      "investigating": 30,
      "resolved": 75
    },
    "brandIntelligence": {
      "analyzedDomains": 25,
      "totalVariants": 450,
      "activeAnalyses": 15
    }
  },
  "timestamp": "2025-01-26T12:00:00.000Z"
}

Get dashboard trends

get

https://platform-dev.omegablack.io/api/v1/dashboard/trends

Get trend data for charts and visualizations.

Authentication

Bearer

Query Parameters

ParameterTypeRequiredDescription
timeRangestringNoTime range: 24h, 7d, 30d, or 90d
metricstringNoMetric type: all, fraud, attacks, or credentials

Response

{
  "timeRange": "7d",
  "interval": "1 day",
  "trends": {
    "fraud": [
      {
        "period": "2025-01-20T00:00:00.000Z",
        "count": 10,
        "high_severity": 2
      }
    ],
    "attacks": [
      {
        "period": "2025-01-20T00:00:00.000Z",
        "count": 1
      }
    ],
    "credentials": [
      {
        "period": "2025-01-20T00:00:00.000Z",
        "count": 15
      }
    ]
  },
  "timestamp": "2025-01-26T12:00:00.000Z"
}

List reports

get

https://platform-dev.omegablack.io/api/v1/reports

Get a list of security reports.

Authentication

Bearer

Query Parameters

ParameterTypeRequiredDescription
pagenumberNoPage number (default: 1)
limitnumberNoItems per page (default: 20, max: 100)
typestringNoFilter by report type
statusstringNoFilter by status
sortstringNoSort field (default: createdAt)
orderstringNoSort order: asc or desc (default: desc)

Response

{
  "reports": [
    {
      "id": "123",
      "title": "Phishing Campaign Detected",
      "type": "phishing",
      "status": "active",
      "severity": "high",
      "createdAt": "2025-01-26T10:00:00Z",
      "updatedAt": "2025-01-26T12:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "pages": 8
  }
}

Get report

get

https://platform-dev.omegablack.io/api/v1/reports/{id}

Get detailed information about a specific report.

Authentication

Bearer

Path Parameters

ParameterTypeRequiredDescription
idstringYesReport ID

Response

{
  "id": "123",
  "title": "Phishing Campaign Detected",
  "type": "phishing",
  "status": "active",
  "severity": "high",
  "description": "Detailed description...",
  "findings": [],
  "recommendations": [],
  "createdAt": "2025-01-26T10:00:00Z",
  "updatedAt": "2025-01-26T12:00:00Z"
}

Create report

post

https://platform-dev.omegablack.io/api/v1/reports

Create a new security report. Requires admin permissions.

Authentication

Bearer

Request Body

{
  "title": "New Security Report",
  "type": "phishing",
  "severity": "high",
  "description": "Report description",
  "findings": []
}

Response

{
  "id": "124",
  "title": "New Security Report",
  "status": "draft",
  "createdAt": "2025-01-26T12:00:00Z"
}

Update report

put

https://platform-dev.omegablack.io/api/v1/reports/{id}

Update an existing report. Requires admin permissions.

Authentication

Bearer

Path Parameters

ParameterTypeRequiredDescription
idstringYesReport ID

Request Body

{
  "title": "Updated Report Title",
  "status": "active"
}

Delete report

delete

https://platform-dev.omegablack.io/api/v1/reports/{id}

Delete a report. Requires admin permissions.

Authentication

Bearer

Path Parameters

ParameterTypeRequiredDescription
idstringYesReport ID

List signals

get

https://platform-dev.omegablack.io/api/v1/signals

Get a list of threat signals.

Authentication

Bearer

Query Parameters

ParameterTypeRequiredDescription
typestringNoFilter by signal type
limitnumberNoItems per page (default: 100, max: 1000)
offsetnumberNoOffset for pagination (default: 0)

Response

{
  "signals": [
    {
      "id": "sig-123",
      "signal_id": "SIG-001",
      "type": "malware",
      "severity": "high",
      "title": "Malware Detected",
      "description": "Signal description",
      "source": "external",
      "timestamp": "2025-01-26T10:00:00Z",
      "createdAt": "2025-01-26T10:00:00Z"
    }
  ],
  "total": 320,
  "limit": 100,
  "offset": 0
}

Create signal

post

https://platform-dev.omegablack.io/api/v1/signals

Create a new threat signal. Requires admin permissions.

Authentication

Bearer

Request Body

{
  "signal_id": "SIG-001",
  "type": "malware",
  "severity": "high",
  "title": "New Threat Signal",
  "description": "Signal description",
  "source": "external",
  "timestamp": "2025-01-26T10:00:00Z"
}

List credentials

get

https://platform-dev.omegablack.io/api/v1/credentials

Get a list of credential intelligence data.

Authentication

Bearer

Query Parameters

ParameterTypeRequiredDescription
pagenumberNoPage number
limitnumberNoItems per page
breachstringNoFilter by breach name
emailstringNoFilter by email domain

Response

{
  "credentials": [
    {
      "id": "cred-123",
      "email": "[email protected]",
      "breach": "Example Breach",
      "passwordHash": "hashed_value",
      "foundDate": "2025-01-20",
      "createdAt": "2025-01-26T10:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 45
  }
}

Create credential

post

https://platform-dev.omegablack.io/api/v1/credentials

Add credential intelligence data. Requires admin permissions.

Authentication

Bearer

List cyber attacks

get

https://platform-dev.omegablack.io/api/v1/cyber-attacks

Get a list of cyber attack records.

Authentication

Bearer

Query Parameters

ParameterTypeRequiredDescription
pagenumberNoPage number
limitnumberNoItems per page
typestringNoFilter by attack type
dateFromstringNoFilter from date (ISO 8601)
dateTostringNoFilter to date (ISO 8601)

Response

{
  "attacks": [
    {
      "id": "attack-123",
      "type": "ransomware",
      "target": "Organization Name",
      "date": "2025-01-25",
      "severity": "critical",
      "description": "Attack description",
      "createdAt": "2025-01-26T10:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 12
  }
}

Get attack details

get

https://platform-dev.omegablack.io/api/v1/cyber-attacks/{id}

Get detailed information about a specific attack.

Authentication

Bearer

Path Parameters

ParameterTypeRequiredDescription
idstringYesAttack ID

Create attack

post

https://platform-dev.omegablack.io/api/v1/cyber-attacks

Add a new cyber attack record. Requires admin permissions.

Authentication

Bearer

Analyze domain

post

https://platform-dev.omegablack.io/api/v1/brand-intelligence

Analyze a domain for brand abuse and typosquatting.

Authentication

Bearer

Request Body

{
  "domain": "example.com"
}

Response

{
  "domain": "example.com",
  "status": "completed",
  "results": {
    "suspiciousDomains": 15,
    "typosquatting": 8,
    "phishing": 2,
    "malware": 0
  },
  "domains": [
    {
      "domain": "examp1e.com",
      "type": "typosquatting",
      "risk": "high",
      "registered": true
    }
  ],
  "createdAt": "2025-01-26T12:00:00Z"
}

Get cached analysis

get

https://platform-dev.omegablack.io/api/v1/brand-intelligence/{domain}

Get cached domain analysis if available.

Authentication

Bearer

Path Parameters

ParameterTypeRequiredDescription
domainstringYesDomain to analyze

Get fraud overview

get

https://platform-dev.omegablack.io/api/v1/fraud-intelligence/overview

Get fraud intelligence overview statistics.

Authentication

Bearer

Response

{
  "totalFraudCases": 250,
  "activeCases": 45,
  "resolvedCases": 205,
  "totalLoss": 1250000,
  "trends": {
    "cases": "+12%",
    "loss": "+8%"
  }
}

Get fraud cards

get

https://platform-dev.omegablack.io/api/v1/fraud-intelligence/cards

Get fraud card intelligence data.

Authentication

Bearer

Query Parameters

ParameterTypeRequiredDescription
pagenumberNoPage number
limitnumberNoItems per page

Get fraud accounts

get

https://platform-dev.omegablack.io/api/v1/fraud-intelligence/accounts

Get fraud account intelligence data.

Authentication

Bearer

Query Parameters

ParameterTypeRequiredDescription
pagenumberNoPage number
limitnumberNoItems per page

List vulnerabilities

get

https://platform-dev.omegablack.io/api/v1/cve-intelligence/vulnerabilities

Get a list of CVE vulnerabilities.

Authentication

Bearer

Query Parameters

ParameterTypeRequiredDescription
pagenumberNoPage number
limitnumberNoItems per page
severitystringNoFilter by severity
vendorstringNoFilter by vendor
productstringNoFilter by product

Response

{
  "vulnerabilities": [
    {
      "id": "CVE-2025-1234",
      "title": "Critical Vulnerability",
      "severity": "critical",
      "cvss": 9.8,
      "vendor": "Example Vendor",
      "product": "Example Product",
      "published": "2025-01-20",
      "description": "Vulnerability description"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 500
  }
}

Get vulnerability details

get

https://platform-dev.omegablack.io/api/v1/cve-intelligence/vulnerabilities/{id}

Get detailed information about a specific CVE.

Authentication

Bearer

Path Parameters

ParameterTypeRequiredDescription
idstringYesCVE ID (e.g., "CVE-2025-1234")

Get trending CVEs

get

https://platform-dev.omegablack.io/api/v1/cve-intelligence/trending

Get trending CVE vulnerabilities.

Authentication

Bearer

List vendors

get

https://platform-dev.omegablack.io/api/v1/vendors

Get a list of vendors with their vulnerability counts.

Authentication

Bearer

Query Parameters

ParameterTypeRequiredDescription
pagenumberNoPage number
limitnumberNoItems per page
sortstringNoSort field

Response

{
  "vendors": [
    {
      "id": "vendor-123",
      "name": "Example Vendor",
      "vulnerabilityCount": 45,
      "criticalCount": 5,
      "highCount": 12
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50
  }
}

Get vendor details

get

https://platform-dev.omegablack.io/api/v1/vendors/{vendorId}

Get vendor details including associated CVEs.

Authentication

Bearer

Path Parameters

ParameterTypeRequiredDescription
vendorIdstringYesVendor ID

Cross-collection search

get

https://platform-dev.omegablack.io/api/v1/search

Search across all entities (reports, signals, credentials, attacks, etc.).

Authentication

Bearer

Query Parameters

ParameterTypeRequiredDescription
qstringYesSearch query
typesstringNoComma-separated list of types (reports,signals,credentials,attacks,vendors,cves)
limitnumberNoResults per type (default: 10)

Response

{
  "query": "phishing",
  "results": {
    "reports": [],
    "signals": [],
    "credentials": []
  },
  "total": 25
}

List organizations

get

https://platform-dev.omegablack.io/api/v1/organizations

Get a list of organizations. Requires admin permissions.

Authentication

Bearer

Query Parameters

ParameterTypeRequiredDescription
pagenumberNoPage number
limitnumberNoItems per page

Get organization

get

https://platform-dev.omegablack.io/api/v1/organizations/{id}

Get organization details. Requires admin permissions.

Authentication

Bearer

Path Parameters

ParameterTypeRequiredDescription
idstringYesOrganization ID

Create organization

post

https://platform-dev.omegablack.io/api/v1/organizations

Create a new organization. Requires admin permissions.

Authentication

Bearer

Request Body

{
  "name": "New Organization",
  "domain": "example.com"
}

Update organization

put

https://platform-dev.omegablack.io/api/v1/organizations/{id}

Update an organization. Requires admin permissions.

Authentication

Bearer

Path Parameters

ParameterTypeRequiredDescription
idstringYesOrganization ID

Delete organization

delete

https://platform-dev.omegablack.io/api/v1/organizations/{id}

Delete an organization. Requires admin permissions.

Authentication

Bearer

Path Parameters

ParameterTypeRequiredDescription
idstringYesOrganization ID

Get user profile

get

https://platform-dev.omegablack.io/api/v1/user

Get current user's profile and role information.

Authentication

Bearer

Response

{
  "id": "user-123",
  "email": "[email protected]",
  "name": "John Doe",
  "role": "admin",
  "organization": {
    "id": "org-123",
    "name": "Example Organization"
  },
  "permissions": ["read", "write", "admin"]
}

OpenAPI Specification

To enable interactive "Try It" testing in ReadMe:

  1. Access ReadMe Dashboard:

    • Go to: https://dash.readme.com/project/omegablack
    • Log in with your ReadMe account

  2. Import OpenAPI Spec:

    • Navigate to API Reference section in the sidebar
    • Click Import or Settings → Import OpenAPI
    • Choose import method:
      • URL Import: https://platform-dev.omegablack.io/api/v1/openapi.json
      • File Upload: Upload docs/openapi.json from this repository

  3. Enable API Explorer:

    • Go to API Reference → Settings
    • Enable "API Explorer" or "Try It" feature
    • This activates the "Try It!" button on each endpoint

  4. Configure Authentication:

    • Go to API Reference → Authentication
    • Add Bearer Token authentication: Authorization: Bearer {token}
    • Users can enter their token when testing endpoints

OpenAPI Spec Locations:

  • Live URL: https://platform-dev.omegablack.io/api/v1/openapi.json
  • Local File: docs/openapi.json
  • GitHub: Available in this repository

Once imported, all endpoints will have interactive "Try It!" buttons for testing directly from the documentation.

Last Updated: January 2025
API Version: v1 (Documented as v2 in ReadMe)