POST /api/nvd/cpes/search
Price: 1 credit
Search the NVD CPE (Common Platform Enumeration) product catalog
Search the NVD CPE (Common Platform Enumeration) catalog of products and platforms. Filter by a free-text keyword, a partial CPE 2.3 match string, an exact CPE name id, or a match-criteria id, and optionally a last-modified date range. Each result is a CPE record with its CPE 2.3 name, name id, title, deprecation flag and replacements, reference links, and created / last-modified timestamps.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)keyword string nullable — Free-text query across CPE product titles (examples: "apache log4j")keyword_exact_match boolean — Match the keyword as an exact phrase rather than individual words (default: false)cpe_match_string string nullable — Partial CPE 2.3 string to match products against (examples: "cpe:2.3:a:apache:log4j")cpe_name_id string nullable — Exact CPE name id (UUID) (examples: "82F877C8-FC1D-4790-A6AC-FC89556011C5")match_criteria_id string nullable — Return CPE names tied to this match-criteria id (UUID)last_mod_start_date string nullable — Last modified from (ISO-8601); requires last_mod_end_date (examples: "2024-01-01")last_mod_end_date string nullable — Last modified to (ISO-8601); requires last_mod_start_date (examples: "2024-03-01")count integer required — Number of CPE products to return (min: 1)@type string (default: "NvdCpe")id string requiredcpe_name string requireddeprecated boolean (default: false)created_at string nullablelast_modified_at string nullablerefs array (default: [])@type string (default: "NvdCpeRef")url string requiredtype string nullabledeprecated_by array (default: [])422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.X-Error — Error message text (present only on error)X-Request-ID — Unique request identifierX-Execution-Time — Execution time in secondsX-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.X-Retry-After — Seconds to wait before retrying. Present only on 429.