mlab docs

API Reference

The vuln.mlab.sh API - CVE search, CERT advisories, dependency scanning, feeds and exports.

GET
/api/v1/cve

Query Parameters

q?string

Keywords, a CVE id, or a package coordinate.

Default""
vendor?string

More keywords, ANDed with q (a keyword match, not a CPE vendor match).

exact?integer

1: match q as one literal phrase.

Default0

Value in

  • 0
  • 1
severity?string

Exact CVSS v3 severity. A trailing + (HIGH+) means this severity or worse.

Value in

  • "CRITICAL"
  • "HIGH"
  • "MEDIUM"
  • "LOW"
  • "CRITICAL+"
  • "HIGH+"
  • "MEDIUM+"
  • "LOW+"
minSeverity?string

This severity or worse. Ignored when severity is set; unscored CVEs never match.

Value in

  • "CRITICAL"
  • "HIGH"
  • "MEDIUM"
  • "LOW"
minCvss?number

Minimum CVSS base score (0 to 10).

Range0 <= value <= 10
kevOnly?string

1 or true: only CVEs in the CISA KEV catalogue.

Value in

  • "1"
  • "true"
cwe?string

A weakness id.

cpe?string

A CPE 2.3 name. A versioned CPE is matched against the NVD configurations' version ranges, the way NVD's virtualMatchString does. An invalid value is ignored.

dateStart?string

Lower bound on published (YYYY-MM-DD). The range can span at most 366 days.

dateEnd?string

Upper bound on published (YYYY-MM-DD).

sort?string

Default: newest first, with up to limit/2 CISA-KEV matches promoted to the top of page 0. recent: strictly newest first. severity: worst first (unscored CVEs excluded).

Default""

Value in

  • ""
  • "recent"
  • "severity"
page?integer

0-based page index.

Default0
limit?integer

Results per page, capped at 100.

Rangevalue <= 100
Default20

Response Body

application/json

curl -X GET "https://example.com/api/v1/cve"
{  "total_results": 140,  "results_per_page": 1,  "start_index": 0,  "cves": [    {      "id": "CVE-2024-3094",      "cvss_score": 10,      "cvss_severity": "CRITICAL"    }  ]}
GET
/api/v1/cve/latest

Response Body

application/json

curl -X GET "https://example.com/api/v1/cve/latest"
{  "total_results": 140,  "results_per_page": 1,  "start_index": 0,  "cves": [    {      "id": "CVE-2024-3094",      "cvss_score": 10,      "cvss_severity": "CRITICAL"    }  ]}
GET
/api/v1/cve/dump

Query Parameters

dateStart*string

Inclusive lower bound on published (YYYY-MM-DD).

dateEnd*string

Inclusive upper bound (YYYY-MM-DD), at most 31 days after dateStart.

minCvss?number

Minimum CVSS base score.

Range0 <= value <= 10
Default0

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/cve/dump?dateStart=2024-01-01&dateEnd=2024-01-31"
{  "error": "Date range too wide: 365 days requested, 31 is the maximum. Split the export into consecutive ranges."}
{  "error": "Too many requests. Please wait 14 seconds before trying again.",  "retry_after": 14}
GET
/api/v1/cve/{id}

Path Parameters

id*string

A CVE identifier (CVE-YYYY-NNNN+), uppercase.

Response Body

application/json

curl -X GET "https://example.com/api/v1/cve/CVE-2021-44228"
{  "id": "CVE-2024-3094",  "description": "Malicious code was discovered in the upstream tarballs of xz, starting with version 5.6.0...",  "published": "2024-03-29T17:15:21.150",  "last_modified": "2026-06-17T07:43:17.830",  "status": "Modified",  "cvss_score": 10,  "cvss_severity": "CRITICAL",  "cvss_vector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:C/C:H/I:H/A:H",  "cvss_breakdown": [    {      "code": "AV",      "name": "Attack Vector",      "value_code": "N",      "value": "Network"    }  ],  "references": [    {      "url": "https://access.redhat.com/security/cve/CVE-2024-3094",      "source": "[email protected]",      "tags": [        "Vendor Advisory"      ]    }  ],  "weaknesses": [    "CWE-506"  ],  "affected_products": [    "Tukaani Xz 5.6.0",    "Tukaani Xz 5.6.1"  ],  "epss_score": null,  "epss_percentile": null,  "in_kev": false,  "kev_date_added": null,  "kev_due_date": null,  "in_eu_kev": false,  "euvd_id": "EUVD-2024-0002",  "risk_score": 80}
GET
/api/v1/cve/{id}/osv

Path Parameters

id*string

Response Body

application/json

curl -X GET "https://example.com/api/v1/cve/CVE-2021-44228/osv"
{  "cve": "string",  "advisories": [    {      "id": "GHSA-jfh8-c2jp-5v3q",      "url": "string",      "summary": "string",      "severity": "string",      "published": "string",      "aliases": [        "string"      ],      "packages": [        {          "ecosystem": "Maven",          "name": "org.apache.logging.log4j:log4j-core",          "purl": "string",          "affected": [            ">= 2.13.0, < 2.15.0"          ],          "fixed": [            "2.15.0"          ]        }      ]    }  ],  "related": [    "string"  ]}
GET
/api/v1/cve/{id}/pocs

Path Parameters

id*string

Response Body

application/json

curl -X GET "https://example.com/api/v1/cve/CVE-2021-44228/pocs"
{  "cve": "string",  "fetched_at": "string",  "total": 0,  "counts": {    "exploit": 0,    "poc": 0,    "reference": 0,    "mention": 0  },  "sources": [    {      "source": "string",      "count": 0,      "ok": true,      "error": "string"    }  ],  "items": [    {      "kind": "exploit",      "title": "string",      "url": "string",      "author": "string",      "published": "string",      "description": "string",      "stars": 0,      "sources": [        "string"      ]    }  ]}
GET
/api/v1/advisories

Query Parameters

cve?string

A CVE id (case-insensitive).

country?string

ISO 3166-1 alpha-2 code of the issuing country (latest stream only).

limit?integer

Items in the latest stream, clamped to 1..500.

Range1 <= value <= 500
Default60

Response Body

application/json

curl -X GET "https://example.com/api/v1/advisories"
{  "total": 0,  "advisories": [    {      "country": "FR",      "team": "CERT-FR",      "feed_type": "string",      "title": "string",      "link": "string",      "summary": "string",      "lang": "fr",      "published": "string",      "cve_ids": [        "string"      ]    }  ]}
GET
/api/v1/vendor/{name}/months

Path Parameters

name*string

Query Parameters

year*integer
Range1999 <= value

Response Body

application/json

curl -X GET "https://example.com/api/v1/vendor/microsoft/months?year=2025"
{  "vendor": "microsoft",  "year": 2025,  "months": [    44,    30,    51,    38,    47,    40,    62,    35,    49,    41,    37,    29  ]}
GET
/api/v1/sources

Response Body

application/json

curl -X GET "https://example.com/api/v1/sources"
{  "sources": [    {      "name": "nvd",      "last_ok_at": "2026-10-11T18:30:02Z",      "last_run_at": "2026-10-11T18:30:02Z",      "ok": true,      "error": null    }  ],  "cert_feeds": {    "total": 70,    "ok": 64,    "via_proxy": 3,    "failing": []  }}
GET
/api/v1/stats

Response Body

application/json

curl -X GET "https://example.com/api/v1/stats"
{  "critical": 30743,  "high": 76894,  "medium": 83930,  "low": 3306,  "total": 404317,  "generated_at": 1791736675,  "kev_total": 1751,  "kev_ransomware": 361,  "kev_added_30d": 35,  "published_24h": 433,  "epss_scored": 385386,  "epss_gte_10": 17300,  "epss_gte_50": 4323,  "epss_gte_90": 797}
GET
/rss

Query Parameters

q?string
vendor?string
severity?string

Value in

  • "CRITICAL"
  • "HIGH"
  • "MEDIUM"
  • "LOW"
minCvss?number
kevOnly?string

Value in

  • "1"
  • "true"
dateStart?string
dateEnd?string
cwe?string
cpe?string

Response Body

application/rss+xml

curl -X GET "https://example.com/rss"
"<item>\n  <title>[CRITICAL] CVE-2021-44228 (10.0)</title>\n  <link>https://vuln.mlab.sh/cve/CVE-2021-44228</link>\n  <description>...</description>\n  <pubDate>Fri, 10 Dec 2021 00:00:00 GMT</pubDate>\n  <guid>https://vuln.mlab.sh/cve/CVE-2021-44228</guid>\n</item>\n"
GET
/export/csv

Query Parameters

q?string

Keywords or a package coordinate.

Response Body

text/csv

curl -X GET "https://example.com/export/csv"
"CVE ID,CVSS Score,Severity,Published,Status,Description\nCVE-2021-44228,10.0,CRITICAL,2021-12-10,Analyzed,\"Apache Log4j2 ...\"\n"
GET
/badge/sbom/{file}

Path Parameters

file*string

Query Parameters

style?string

SVG only.

Default"flat"

Value in

  • "flat"
  • "flat-square"
  • "for-the-badge"
  • "mini"
  • "detailed"
label?string

Left-hand text, at most 32 characters.

Default"vulns"

Response Body

curl -X GET "https://example.com/badge/sbom/0123456789abcdef0123456789abcdef.svg"
{  "schemaVersion": 1,  "label": "vulns",  "message": "3 (1 critical) · 1 KEV",  "color": "#e05d44"}
Empty
POST
/api/v2/query

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Either package.purl, or package.ecosystem + package.name (with optional top-level version). Free-text queries are rejected.

Response Body

application/json

curl -X POST "https://example.com/api/v2/query" \  -H "Content-Type: application/json" \  -d '{    "package": {      "purl": "pkg:cargo/[email protected]"    }  }'
{  "vulns": [    {      "id": "GHSA-wcg3-cvx6-7396",      "summary": "Potential segfault in the time crate",      "severity": [        {          "type": "CVSS_V3",          "score": "CVSS:3.1/AV:N/AC:H/PR:N/UI:N/S:U/C:N/I:N/A:L"        }      ],      "affected": [        {          "package": {            "ecosystem": "crates.io",            "name": "time",            "purl": "pkg:cargo/time"          },          "ranges": [            {              "type": "SEMVER",              "events": [                {                  "introduced": "0.1.0"                },                {                  "fixed": "0.2.23"                }              ]            }          ]        }      ]    }  ]}
Empty
Empty
GET
/api/v2/scan

Authorization

AuthorizationBearer <token>

Personal API token as Authorization: Bearer <token>. Generate one at /me/tokens. On /api/v2/scan it applies your account's limits (free account: 1024 packages, 5 s cooldown; paid plan: 4096 packages, no cooldown) instead of the anonymous ones, and files the scan in your history.

In: header

Query Parameters

url*string

URL of a lockfile or SBOM.

Formaturi
format?string

Force the parser; auto detects from the file name (or URL), then the content. poetry, uv and pdm are the same parser; maven reads both pom.xml and gradle.lockfile.

Default"auto"

Value in

  • "auto"
  • "npm"
  • "yarn"
  • "pnpm"
  • "cargo"
  • "pip"
  • "poetry"
  • "uv"
  • "pdm"
  • "pipfile"
  • "composer"
  • "gem"
  • "go"
  • "maven"
  • "nuget"
  • "pub"
  • "hex"
  • "mise"
  • "cyclonedx"
  • "spdx"
filename?string

Label for your scan history (defaults to the URL's basename).

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v2/scan?url=https%3A%2F%2Fraw.githubusercontent.com%2Frust-lang%2Fcargo%2Fmaster%2FCargo.lock"
{  "hash": "8a1564f1d99d2afa",  "cached": false,  "count": 2,  "tier": "anonymous",  "limits": {    "max_packages": 512,    "cooldown_secs": 10,    "max_body_bytes": 4194304  },  "truncated": false,  "outage": false,  "logged_in": false,  "ttl": 10800,  "packages": [    {      "ecosystem": "crates.io",      "name": "time",      "version": "0.1.44"    },    {      "ecosystem": "crates.io",      "name": "serde",      "version": "1.0.100"    }  ],  "results": [    {      "ok": true,      "vulns": [        {          "id": "GHSA-wcg3-cvx6-7396",          "aliases": [            "CVE-2020-26235",            "RUSTSEC-2020-0071"          ]        }      ]    },    {      "ok": true,      "vulns": []    }  ]}
Empty
Empty
{  "error": "payload_too_large",  "message": "The request body is larger than 4 MiB, the anonymous limit. Send the lockfile instead of a full SBOM export, or a pre-parsed {\"packages\": [...]} list.",  "tier": "anonymous",  "limits": {    "max_packages": 512,    "cooldown_secs": 10,    "max_body_bytes": 4194304  },  "account_required": true,  "signup": "https://vuln.mlab.sh/sso/login?next=/scan",  "upgrade": {    "tier": "free",    "max_packages": 1024,    "cooldown_secs": 5,    "max_body_bytes": 8388608,    "message": "Create a free account to scan up to 1024 packages per scan (8 MiB per request), with a 5 second cooldown.",    "url": "https://vuln.mlab.sh/sso/login?next=/scan"  }}
{  "error": "no_dependencies",  "message": "string",  "hint": "string",  "unscanned": [    "string"  ]}
{  "error": "cooldown",  "message": "Anonymous scans are limited to one every 10 seconds. Retry in 7 seconds.",  "retry_after_secs": 7,  "tier": "anonymous",  "limits": {    "max_packages": 512,    "cooldown_secs": 10,    "max_body_bytes": 4194304  },  "account_required": true,  "signup": "https://vuln.mlab.sh/sso/login?next=/scan",  "upgrade": {    "tier": "free",    "max_packages": 1024,    "cooldown_secs": 5,    "max_body_bytes": 8388608,    "message": "Create a free account to scan up to 1024 packages per scan (8 MiB per request), with a 5 second cooldown.",    "url": "https://vuln.mlab.sh/sso/login?next=/scan"  }}
POST
/api/v2/scan

Authorization

AuthorizationBearer <token>

Personal API token as Authorization: Bearer <token>. Generate one at /me/tokens. On /api/v2/scan it applies your account's limits (free account: 1024 packages, 5 s cooldown; paid plan: 4096 packages, no cooldown) instead of the anonymous ones, and files the scan in your history.

In: header

Query Parameters

url?string

Fetch this lockfile instead of reading the body (wins over a body url).

Formaturi
format?string

Force the parser; auto detects from the file name (or URL), then the content. poetry, uv and pdm are the same parser; maven reads both pom.xml and gradle.lockfile.

Default"auto"

Value in

  • "auto"
  • "npm"
  • "yarn"
  • "pnpm"
  • "cargo"
  • "pip"
  • "poetry"
  • "uv"
  • "pdm"
  • "pipfile"
  • "composer"
  • "gem"
  • "go"
  • "maven"
  • "nuget"
  • "pub"
  • "hex"
  • "mise"
  • "cyclonedx"
  • "spdx"
filename?string

Name hint for format detection of a raw body (for example Cargo.lock), and the label in your scan history.

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v2/scan" \  -H "Content-Type: application/json" \  -d '{    "packages": [      {        "ecosystem": "crates.io",        "name": "time",        "version": "0.1.44"      },      {        "purl": "pkg:npm/[email protected]"      },      {        "cpe": "cpe:2.3:a:openssl:openssl:3.0.1:*:*:*:*:*:*:*"      }    ]  }'
{  "hash": "8a1564f1d99d2afa",  "cached": false,  "count": 2,  "tier": "anonymous",  "limits": {    "max_packages": 512,    "cooldown_secs": 10,    "max_body_bytes": 4194304  },  "truncated": false,  "outage": false,  "logged_in": false,  "ttl": 10800,  "packages": [    {      "ecosystem": "crates.io",      "name": "time",      "version": "0.1.44"    },    {      "ecosystem": "crates.io",      "name": "serde",      "version": "1.0.100"    }  ],  "results": [    {      "ok": true,      "vulns": [        {          "id": "GHSA-wcg3-cvx6-7396",          "aliases": [            "CVE-2020-26235",            "RUSTSEC-2020-0071"          ]        }      ]    },    {      "ok": true,      "vulns": []    }  ]}
Empty
Empty
{  "error": "payload_too_large",  "message": "The request body is larger than 4 MiB, the anonymous limit. Send the lockfile instead of a full SBOM export, or a pre-parsed {\"packages\": [...]} list.",  "tier": "anonymous",  "limits": {    "max_packages": 512,    "cooldown_secs": 10,    "max_body_bytes": 4194304  },  "account_required": true,  "signup": "https://vuln.mlab.sh/sso/login?next=/scan",  "upgrade": {    "tier": "free",    "max_packages": 1024,    "cooldown_secs": 5,    "max_body_bytes": 8388608,    "message": "Create a free account to scan up to 1024 packages per scan (8 MiB per request), with a 5 second cooldown.",    "url": "https://vuln.mlab.sh/sso/login?next=/scan"  }}
{  "error": "no_dependencies",  "message": "string",  "hint": "string",  "unscanned": [    "string"  ]}
{  "error": "cooldown",  "message": "Anonymous scans are limited to one every 10 seconds. Retry in 7 seconds.",  "retry_after_secs": 7,  "tier": "anonymous",  "limits": {    "max_packages": 512,    "cooldown_secs": 10,    "max_body_bytes": 4194304  },  "account_required": true,  "signup": "https://vuln.mlab.sh/sso/login?next=/scan",  "upgrade": {    "tier": "free",    "max_packages": 1024,    "cooldown_secs": 5,    "max_body_bytes": 8388608,    "message": "Create a free account to scan up to 1024 packages per scan (8 MiB per request), with a 5 second cooldown.",    "url": "https://vuln.mlab.sh/sso/login?next=/scan"  }}