REST API v1 Documentation

OpenAPI/Swagger-powered REST API for Sentinel Security Platform

Open Interactive Swagger Docs

Overview

The Sentinel Security Platform offers a complete REST API v1 based on Django REST Framework and documented with OpenAPI 3 (Swagger). This API allows you to programmatically access all vulnerability data that is also available via the web interface.

Base URL: /api/v1/

Schema: /api/v1/schema/

Swagger UI: /api/v1/docs/

Authentication: Basic Auth or Session (cookie)

Required Tier: Professional or Enterprise

Authentication

API access requires an active Professional or Enterprise subscription. Free-tier users cannot access the API endpoints.

Browser / Swagger UI

When using the interactive Swagger UI, you are already authenticated via your Django session (login cookie). Simply click Authorize in Swagger and leave the fields empty, or use any dummy value — session auth takes precedence.

Programmatic Access — Basic Authentication

For scripts and external tools, authenticate with your Sentinel account credentials using Basic Auth. 

Authorization: Basic BASE64(username:password)

Example with curl

curl -X GET "https://sentinel-security.tech/api/v1/vulnerabilities/?q=CVE-2024-1234&severity=CRITICAL" \
  -u "your-email@example.com:your-password" \
  -H "Accept: application/json"

Tier Requirement: Only Professional and Enterprise subscribers can call the API. Free users will receive a 403 Forbidden response.

Endpoints

Method Endpoint Description
GET /api/v1/vulnerabilities/ List & search vulnerabilities (paginated)
GET /api/v1/vulnerabilities/{id}/ Retrieve a single vulnerability by CVE-ID
GET /api/v1/vulnerabilities/{id}/history/ Change history for a vulnerability
GET /api/v1/vulnerabilities/{id}/news/ News articles related to a CVE
GET /api/v1/stats/ Aggregate vulnerability statistics
GET /api/v1/health/ Health check (no auth required)

Query Parameters

The GET /api/v1/vulnerabilities/ endpoint supports the following filters:

  • q — Free-text search or CVE-ID
  • severity — CRITICAL, HIGH, MEDIUM, LOW
  • product — Product name (case-insensitive)
  • source — nist, mitre, cisa, euvd, osv, ghsa
  • date_from / date_to — YYYY-MM-DD range
  • sort — date_desc, date_asc, cvss_desc, cvss_asc
  • limit — Results per page (1–100, default 25)
  • cursor — Keyset pagination token

Tier Access & Rate Limits

API access is gated by your subscription tier:

  • Free: No API access (403 Forbidden)
  • Professional: Full API access — 120 requests / minute
  • Enterprise: Full API access — 120 requests / minute

Rate-limit headers are included in every response:

X-RateLimit-Limit: 120
X-RateLimit-Remaining: 118
X-RateLimit-Reset: 1714400000

Interactive Documentation

Explore the full schema, try requests directly in the browser, and download the OpenAPI spec via the Swagger UI:

Open Swagger UI (/api/v1/docs/)

Further Resources