{"openapi":"3.1.0","info":{"title":"VulnCheck (BYOK) API","version":"0.1.0","description":"VulnCheck (BYOK) lets an AI assistant read your own VulnCheck data through the VulnCheck API with a key you supply (VulnCheck API token). Read-only: 10 tools (list_indexes, search_vulncheck_kev, search_cisa_kev, get_epss_scores, search_exploit_intelligence, search_ransomware_families, search_botnets, search_threat_actors, search_cves, list_cves_for_cpe). The BYOK key travels with each request, is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-vulncheck.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-vulncheck/docs"},"termsOfService":"https://connectorbay.com/byok-vulncheck/terms"},"servers":[{"url":"https://byok-vulncheck.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-vulncheck/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_indexes":{"post":{"operationId":"list_indexes","summary":"List the VulnCheck data indexes (KEV, EPSS, exploits, advisories and more) with a short description of each. Use for \"Wh","description":"List the VulnCheck data indexes (KEV, EPSS, exploits, advisories and more) with a short description of each. Use for \"Which datasets does VulnCheck offer\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_indexesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_vulncheck_kev":{"post":{"operationId":"search_vulncheck_kev","summary":"Search the VulnCheck Known Exploited Vulnerabilities catalog by CVE, threat actor, ransomware family or botnet. Use for ","description":"Search the VulnCheck Known Exploited Vulnerabilities catalog by CVE, threat actor, ransomware family or botnet. Use for \"Is CVE-2021-44228 in the VulnCheck KEV catalog\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cve":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"CVE id to look up, for example CVE-2021-44228.","title":"Cve"},"threat_actor":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Threat actor name, for example Lazarus.","title":"Threat Actor"},"ransomware":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Ransomware family name, for example LockBit.","title":"Ransomware"},"botnet":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Botnet name, for example Mirai.","title":"Botnet"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc or desc.","title":"Order"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records per page (1 to 100).","title":"Limit"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"search_vulncheck_kevArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_cisa_kev":{"post":{"operationId":"search_cisa_kev","summary":"Search the CISA Known Exploited Vulnerabilities catalog as mirrored by VulnCheck, by CVE, threat actor, ransomware famil","description":"Search the CISA Known Exploited Vulnerabilities catalog as mirrored by VulnCheck, by CVE, threat actor, ransomware family or botnet. Use for \"When was CVE-2024-3094 added to the CISA KEV catalog\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cve":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"CVE id to look up, for example CVE-2021-44228.","title":"Cve"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc or desc.","title":"Order"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records per page (1 to 100).","title":"Limit"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"search_cisa_kevArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_epss_scores":{"post":{"operationId":"get_epss_scores","summary":"Get EPSS exploit probability scores and percentiles for a CVE, or page through recent scores. Use for \"What is the EPSS ","description":"Get EPSS exploit probability scores and percentiles for a CVE, or page through recent scores. Use for \"What is the EPSS score of CVE-2023-4863\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cve":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"CVE id to look up, for example CVE-2021-44228.","title":"Cve"},"order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort direction: asc or desc.","title":"Order"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records per page (1 to 100).","title":"Limit"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"get_epss_scoresArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_exploit_intelligence":{"post":{"operationId":"search_exploit_intelligence","summary":"Search VulnCheck exploit intelligence by CVE: exploit maturity, whether public or weaponized exploits exist and whether ","description":"Search VulnCheck exploit intelligence by CVE: exploit maturity, whether public or weaponized exploits exist and whether exploitation was reported. Use for \"Is there a weaponized public exploit for CVE-2024-3400\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cve":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"CVE id to look up, for example CVE-2021-44228.","title":"Cve"},"in_kev":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for only CVEs listed in the CISA KEV catalog, false for those not listed.","title":"In Kev"},"in_vckev":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True for only CVEs listed in the VulnCheck KEV catalog, false for those not listed.","title":"In Vckev"},"max_exploit_maturity":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Highest exploit maturity reached, for example POC or WEAPONIZED.","title":"Max Exploit Maturity"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records per page (1 to 100).","title":"Limit"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"search_exploit_intelligenceArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_ransomware_families":{"post":{"operationId":"search_ransomware_families","summary":"Search ransomware families and the CVEs they are known to exploit, by family name or CVE. Use for \"Which CVEs does LockB","description":"Search ransomware families and the CVEs they are known to exploit, by family name or CVE. Use for \"Which CVEs does LockBit exploit\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ransomware":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Ransomware family name, for example LockBit.","title":"Ransomware"},"cve":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"CVE id to look up, for example CVE-2021-44228.","title":"Cve"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records per page (1 to 100).","title":"Limit"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"search_ransomware_familiesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_botnets":{"post":{"operationId":"search_botnets","summary":"Search botnets and the CVEs they are known to exploit, by botnet name or CVE. Use for \"Which vulnerabilities does Mirai ","description":"Search botnets and the CVEs they are known to exploit, by botnet name or CVE. Use for \"Which vulnerabilities does Mirai exploit\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"botnet":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Botnet name, for example Mirai.","title":"Botnet"},"cve":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"CVE id to look up, for example CVE-2021-44228.","title":"Cve"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records per page (1 to 100).","title":"Limit"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"search_botnetsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_threat_actors":{"post":{"operationId":"search_threat_actors","summary":"Search threat actor groups with country, MITRE and MISP ids and the CVEs attributed to them, by actor name or CVE. Use f","description":"Search threat actor groups with country, MITRE and MISP ids and the CVEs attributed to them, by actor name or CVE. Use for \"Which CVEs does Lazarus exploit\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"threat_actor":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Threat actor name, for example Lazarus.","title":"Threat Actor"},"cve":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"CVE id to look up, for example CVE-2021-44228.","title":"Cve"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many records per page (1 to 100).","title":"Limit"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"title":"search_threat_actorsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/search_cves":{"post":{"operationId":"search_cves","summary":"Search CVE records in the NVD 2.0 format with VulnCheck additions. Filter by CVE id, affected CPE name or presence in a ","description":"Search CVE records in the NVD 2.0 format with VulnCheck additions. Filter by CVE id, affected CPE name or presence in a KEV catalog. Use for \"Show the CVE record for CVE-2021-44228 with its status and description\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cve_id":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"A single CVE id, for example CVE-2021-44228.","title":"Cve Id"},"cpe_name":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"A full CPE 2.3 name; returns CVEs whose configuration matches it.","title":"Cpe Name"},"has_kev":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to return only CVEs that are in the CISA KEV catalog.","title":"Has Kev"},"no_rejected":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to leave out rejected CVEs.","title":"No Rejected"},"results_per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many CVEs per page (1 to 100).","title":"Results Per Page"},"start_index":{"anyOf":[{"maximum":1000000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Zero-based offset of the first result, for paging.","title":"Start Index"}},"title":"search_cvesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_cves_for_cpe":{"post":{"operationId":"list_cves_for_cpe","summary":"List the CVE ids associated with a CPE name such as cpe:2.3:a:apache:log4j:2.14.1:*:*:*:*:*:*:*. Use for \"Which CVEs aff","description":"List the CVE ids associated with a CPE name such as cpe:2.3:a:apache:log4j:2.14.1:*:*:*:*:*:*:*. Use for \"Which CVEs affect Apache Log4j 2.14.1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"cpe":{"description":"CPE 2.3 name to look up.","maxLength":300,"title":"Cpe","type":"string"},"is_vulnerable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null,"description":"True to return only CVEs where the CPE is marked vulnerable.","title":"Is Vulnerable"}},"required":["cpe"],"title":"list_cves_for_cpeArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}