API Reference

Quick Reference v2

API Quick Reference

Quick reference guide for all available API endpoints.

Base URL

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

Authentication

Authorization: Bearer <token>

Endpoints Summary

Core

MethodEndpointDescriptionAuth
GET/api/v1API informationNo
GET/api/v1/statusAPI statusNo
GET/api/v1/healthHealth checkNo

Dashboard

MethodEndpointDescriptionAuth
GET/api/v1/dashboard/metricsDashboard metricsYes
GET/api/v1/dashboard/trendsTrend dataYes

Reports

MethodEndpointDescriptionAuth
GET/api/v1/reportsList reportsYes
GET/api/v1/reports/:idGet reportYes
POST/api/v1/reportsCreate reportAdmin
PUT/api/v1/reports/:idUpdate reportYes
DELETE/api/v1/reports/:idDelete reportAdmin

Signals

MethodEndpointDescriptionAuth
GET/api/v1/signalsList signalsYes
POST/api/v1/signalsCreate signalAdmin

Credentials

MethodEndpointDescriptionAuth
GET/api/v1/credentialsList credentialsYes
POST/api/v1/credentialsCreate credentialAdmin

Cyber Attacks

MethodEndpointDescriptionAuth
GET/api/v1/cyber-attacksList attacksYes
POST/api/v1/cyber-attacksCreate attackAdmin

Brand Intelligence

MethodEndpointDescriptionAuth
GET/api/v1/brand-intelligence/:domainGet cached analysisYes
POST/api/v1/brand-intelligenceAnalyze domainYes
POST/api/v1/brand-intelligence/uploadUpload resultsYes

*Yum! Brands organization only

Fraud Intelligence

MethodEndpointDescriptionAuth
GET/api/v1/fraud-intelligence/overviewFraud overviewYes
GET/api/v1/fraud-intelligence/cardsFraud cardsYes
GET/api/v1/fraud-intelligence/accountsFraud accountsYes

CVE Intelligence

MethodEndpointDescriptionAuth
GET/api/v1/cve-intelligence/vulnerabilitiesList CVEsYes
GET/api/v1/cve-intelligence/vulnerabilities/:idGet CVEYes
GET/api/v1/cve-intelligence/trendingTrending CVEsYes

Vendors

MethodEndpointDescriptionAuth
GET/api/v1/vendorsList vendorsYes
GET/api/v1/vendors/:vendorIdGet vendorYes

Search

MethodEndpointDescriptionAuth
GET/api/v1/searchUnified searchYes

Organizations

MethodEndpointDescriptionAuth
GET/api/v1/organizationsList organizationsYes*
GET/api/v1/organizations/:idGet organizationYes*
POST/api/v1/organizationsCreate organizationAdmin*
PATCH/api/v1/organizations/:idUpdate organizationAdmin*
DELETE/api/v1/organizations/:idDelete organizationAdmin*

*Requires read:organizations or write:organizations permission

User

MethodEndpointDescriptionAuth
GET/api/v1/user/profileGet profileYes
GET/api/v1/user/rolesGet rolesYes

Report Types

MethodEndpointDescriptionAuth
GET/api/v1/report-typesList report typesYes
GET/api/v1/report-types/:idGet report typeYes

External Integrations

MethodEndpointDescriptionAuth
GET/POST/api/v1/feedly/*Feedly proxyYes
GET/POST/api/v1/parseintel/*ParseIntel proxyYes

Common Query Parameters

Pagination

  • limit (number): Number of results (default varies by endpoint)
  • offset (number): Pagination offset (default: 0)

Filtering

  • status (string): Filter by status
  • type (string): Filter by type
  • severity (string): Filter by severity
  • timeRange (string): Time range (24h, 7d, 30d, 90d)

Search

  • q (string): Search query
  • search (string): Search term
  • types (string): Comma-separated entity types

Response Codes

CodeMeaning
200Success
201Created
204No Content
400Bad Request
401Unauthorized
403Forbidden
404Not Found
429Rate Limited
500Server Error

Rate Limits

  • Standard: 100 requests / 15 minutes
  • External APIs: 20 requests / 15 minutes
  • Health: 10 requests / minute

Postman Access

✅ All APIs can be accessed via Postman!

  • Quick Setup: See POSTMAN_GUIDE.md
  • Collection: Import docs/postman-collection-enterprise.json
  • Auto Token: Collection includes automatic token management

For detailed documentation, see API_REFERENCE.md