# Vulners docs

> Developer documentation for Vulners — a vulnerability-intelligence platform offering fast, reliable access to CVEs, advisories, exploits and package metadata through a single REST API, an official Python SDK and an MCP server.

These docs cover authentication and API keys, the full REST API (search, audit, collections, alerts, reporting), the data model and search syntax, every product, and ready-made integrations (Nmap, Ansible, Trivy, Burp, Splunk, Zabbix and more). Data is normalized from 220+ sources (NVD/CVE, vendor and Linux-distro advisories, CISA KEV, Exploit-DB, Metasploit, GitHub PoCs) and enriched with CVSS, EPSS, CWE, CPE and the Vulners AI Risk score.

## Quickstart

- [Documentation home](https://docs.vulners.com/docs/): Platform overview, core concepts and entry points.
- [Quickstart](https://docs.vulners.com/docs/quickstart/): Get an API key and make your first request.
- [Getting an API key](https://docs.vulners.com/docs/quickstart/authentication/): Create an account and authenticate requests with the X-Api-Key header.
- [Python SDK](https://docs.vulners.com/docs/quickstart/api_key/): Install and use the official Python SDK for search, audit and archive methods.

## API reference

- [API overview](https://docs.vulners.com/docs/api/): REST API overview — authentication, response formats and the method index.
- [Search](https://docs.vulners.com/docs/api/search/): Lucene-style full-text and fielded queries across advisories, CVEs and package metadata.
- [Audit](https://docs.vulners.com/docs/api/audit/): Detect known vulnerabilities in a software inventory or host via package/CPE matching.
- [Collections](https://docs.vulners.com/docs/api/collections/): Build and manage shareable vulnerability collections.
- [Alerts](https://docs.vulners.com/docs/api/alerts/): Subscribe to real-time vulnerability notifications.
- [Reporting](https://docs.vulners.com/docs/api/reporting/): Generate vulnerability reports.
- [API methods](https://docs.vulners.com/docs/api/api_methods/): Full list of REST API methods.
- [OpenAPI spec (Redoc)](https://docs.vulners.com/docs/api/openapi/): Machine-readable OpenAPI specification.
- [Swagger UI](https://docs.vulners.com/docs/api/swagger/): Interactive API explorer.

## Data model

- [Data model](https://docs.vulners.com/docs/data_model/): How Vulners records, collections and search work.
- [Field glossary](https://docs.vulners.com/docs/data_model/database_model/): Reference for every document field.
- [Search model](https://docs.vulners.com/docs/data_model/search_strategies/): Search strategies and query syntax.

## Products

- [Products overview](https://docs.vulners.com/docs/products/): What each Vulners product does and which API it uses.
- [Vulnerability Intelligence](https://docs.vulners.com/docs/products/intelligence/): Enriched per-CVE context (CVSS, EPSS, CISA KEV, CWE, exploits, AI Risk) for prioritization.
- [Assessment](https://docs.vulners.com/docs/products/assessment/): Turn a software inventory or host data into a vulnerability report.
- [Datasets](https://docs.vulners.com/docs/products/datasets/): Full vulnerability feeds in JSON/CSV for offline analysis and SIEM/SOAR.
- [Alerts](https://docs.vulners.com/docs/products/alerts/): Email and webhook notifications for new critical vulnerabilities.
- [Exploits](https://docs.vulners.com/docs/products/exploits/): Curated exploits and PoCs to validate detections and prioritize.
- [MCP](https://docs.vulners.com/docs/products/mcp/): Model Context Protocol server delivering sourced vulnerability answers to AI agents.

## Guides and integrations

- [Integrations index](https://docs.vulners.com/docs/guides/): All plugins and integration guides.
- [Perimeter scanner](https://docs.vulners.com/docs/guides/vscanner/): Vulners perimeter scanner.
- [Vulners agent for Linux](https://docs.vulners.com/docs/guides/vulners_agent/): Audit Linux hosts with the Vulners agent.
- [Vulners agent for Windows](https://docs.vulners.com/docs/guides/vulners_windows_agent/): Audit Windows hosts.
- [Nmap plugin](https://docs.vulners.com/docs/guides/nmap_vulners/): Vulners Nmap NSE script and http-vulners-regex.
- [Ansible plugin](https://docs.vulners.com/docs/guides/ansible/): Audit hosts via Ansible.
- [Trivy plugin](https://docs.vulners.com/docs/guides/trivy/): Vulners Trivy integration.
- [Burp Suite plugin](https://docs.vulners.com/docs/guides/burp-vulners-scanner/): Vulners Burp Suite scanner.
- [Splunk plugin](https://docs.vulners.com/docs/guides/splunk/): Vulners Splunk app.
- [Zabbix plugin](https://docs.vulners.com/docs/guides/zabbix_threat_control/): Zabbix threat control.
- [DefectDojo plugin](https://docs.vulners.com/docs/guides/defectdojo/): Vulners DefectDojo integration.
- [Getsploit](https://docs.vulners.com/docs/guides/getsploit/): Command-line exploit search utility.
- [Changelog](https://docs.vulners.com/docs/changelog/): API and platform updates.

## Optional

- [Vulners website](https://vulners.com/): Product pages and the web UI.
- [Vulnerability search (web UI)](https://vulners.com/search/): Search the Vulners database in the browser.
- [Python SDK on PyPI](https://pypi.org/project/vulners/): `pip install -U vulners`.
- [GitHub](https://github.com/vulnerscom/): Open-source SDKs, integrations and tools.