Skip to main content
POST
security.vuln.search

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
keyword
string

Words in the advisory description.

Required string length: 1 - 256
exact
boolean
default:false

Require an exact phrase; requires keyword.

severity
enum<string>

Severity band for the selected scoring version.

Available options:
low,
medium,
high,
critical
cvssVersion
enum<string>
default:3

Scoring version for severity and vector filters.

Available options:
2,
3,
4
vector
string

Score vector filter, encoded field by field.

Required string length: 1 - 256
Pattern: ^[A-Za-z0-9:./_-]+$
weakness
string

Public weakness id.

Required string length: 1 - 32
Pattern: ^CWE-(?:\d+|noinfo|Other)$
cpeName
string

Exact public CPE product name; cannot combine with matchCriteria.

Required string length: 1 - 1024
Pattern: ^cpe:2\.3:[aho]:[^\s]+$
matchCriteria
string

Public CPE match criteria; required for version ranges.

Required string length: 1 - 1024
Pattern: ^cpe:2\.3:[aho*]:[^\s]+$
versionStart
string

Version range start.

Required string length: 1 - 64
versionStartType
enum<string>

Whether to include the start version.

Available options:
including,
excluding
versionEnd
string

Version range end.

Required string length: 1 - 64
versionEndType
enum<string>

Whether to include the end version.

Available options:
including,
excluding
publishedFrom
string<date-time>

Publication range start, up to 120 days.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
publishedTo
string<date-time>

Publication range end.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
modifiedFrom
string<date-time>

Modification range start, up to 120 days.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
modifiedTo
string<date-time>

Modification range end.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
knownExploited
boolean
default:false

Return known exploited records only.

noRejected
boolean
default:false

Exclude rejected records.

limit
integer
default:10

Maximum advisories, 1 to 50.

Required range: 1 <= x <= 50
cursor
string

Continuation for this same search.

Required string length: 1 - 4096

Response

The result

vulns
object[]
required

Matching advisories and up to 100 affected product conditions per advisory.

Maximum array length: 50
nextCursor
string

Next page continuation.