Raw schema
{
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"add",
"remove"
],
"maxLength": 8,
"description": "add or remove; leave out to list the items"
},
"endpoint": {
"type": "string",
"enum": [
"cve_lookup",
"kev_lookup",
"cve_exploit",
"product_exposure",
"cve_search",
"dns_lookup",
"ssl_check",
"whois_lookup",
"headers_check",
"cert_search",
"package_check",
"ip_lookup"
],
"maxLength": 16,
"description": "The tool the item watches"
},
"cve_id": {
"type": "string",
"maxLength": 24,
"description": "For a cve_lookup, kev_lookup or cve_exploit item, e.g. CVE-2021-44228"
},
"vendor": {
"type": "string",
"maxLength": 128,
"description": "Vendor, for a product_exposure or cve_search item"
},
"product": {
"type": "string",
"maxLength": 128,
"description": "Product, for a product_exposure or cve_search item"
},
"severity": {
"type": "string",
"enum": [
"CRITICAL",
"HIGH",
"MEDIUM",
"LOW",
"NONE"
],
"maxLength": 16,
"description": "cve_search items only"
},
"cwe_id": {
"type": "string",
"maxLength": 16,
"description": "cve_search items only, e.g. CWE-79"
},
"min_cvss": {
"type": "number",
"minimum": 0,
"maximum": 10,
"description": "CVSS v3, or v4 when a CVE has no v3; cve_search items only"
},
"min_epss": {
"type": "number",
"minimum": 0,
"maximum": 1,
"description": "At most three decimals; cve_search items only"
},
"in_kev": {
"type": "boolean",
"description": "cve_search items only"
},
"known_ransomware": {
"type": "boolean",
"const": true,
"description": "cve_search items only"
},
"has_nuclei_template": {
"type": "boolean",
"const": true,
"description": "cve_search items only"
},
"domain": {
"type": "string",
"maxLength": 253,
"description": "For a dns_lookup, ssl_check, whois_lookup, headers_check or cert_search item, such as example.com"
},
"ecosystem": {
"type": "string",
"maxLength": 16,
"description": "For a package_check item: npm, PyPI, Maven, Go, NuGet, RubyGems, crates.io, Packagist or SwiftURL"
},
"name": {
"type": "string",
"maxLength": 256,
"description": "Package name of a package_check item, e.g. lodash"
},
"version": {
"type": "string",
"maxLength": 128,
"description": "Exact version of a product_exposure or package_check item; leave out to watch every version"
},
"ip_address": {
"type": "string",
"maxLength": 45,
"description": "Public IPv4 or IPv6 address of an ip_lookup item, such as 8.8.8.8, no prefix"
},
"clear": {
"type": "boolean",
"const": true,
"description": "Deletes every item and the event cursor; takes no other argument"
},
"packages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ecosystem": {
"type": "string"
},
"name": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"ecosystem",
"name"
],
"additionalProperties": false
},
"minItems": 1,
"maxItems": 500,
"description": "package_check items, each with an ecosystem, a name and an optional version"
}
},
"additionalProperties": false
}