API Reference
Last updated
Last updated
If you're looking to simply browse the API, you're in the right place, all supported endpoints can be found on this page.
Alternatively, if you have a specific use case in mind, please see the API Guides on the left hand side to see if one of the guides fits your needs.
This is an alphabetical listing of all supported endpoints. If you're looking for a specific endpoint, you can use the search bar to find it.
Endpoint to browse for threat actors, with filters on some criteria.
A string used to filter threat actors. It can start with specific prefixes to indicate the type of filter:
name:: Filter by Name.uuid:: Filter by UUID.The number of items to skip before starting to collect the result set.
0Field to sort by - either name, created_at or updated_at
created_atPattern: ^(name|created_at|updated_at)$Sort order - either asc or desc
descPattern: ^(asc|desc)$The maximum number of items to return.
100Endpoint to retrieve a list of bulletins.
The number of items to skip before starting to collect the result set.
0The maximum number of items to return.
7A string used to filter content chunks. The filter will be conducted within the content chunk embeddings.
The number of items to skip before starting to collect the result set.
0The maximum number of items to return.
100Retrieve a reference by its identifier.
This endpoint returns the reference object associated with the given URL hash. If no reference is found, a 404 error is returned.
The unique hash of the URL or UUID to retrieve the reference for
Endpoint to browse for detection signatures, with filters on some criteria.
The number of items to skip before starting to collect the result set.
0The maximum number of items to return.
100Field to sort by - either name, created_at or updated_at
created_atPattern: ^(name|created_at|updated_at)$Sort order - either asc or desc
descPattern: ^(asc|desc)$Endpoint to browse for exploitations.
The number of items to skip before starting to collect the result set.
0The maximum number of items to return.
100Field to sort by - either count, created_at or updated_at
created_atPattern: ^(count|created_at|updated_at)$Sort order - either asc or desc
descPattern: ^(asc|desc)$Endpoint to browse exploits, with filters on some criteria.
A string used to filter exploits. It can start with specific prefixes to indicate the type of filter:
uuid:: Filter by UUID.url:: Filter by url.authors:: Filter by authors.maturity:: Filter by maturity.The number of items to skip before starting to collect the result set.
0Field to sort by - either url, authors, maturity, created_at or updated_at
created_atPattern: ^(url|authors|maturity|created_at|updated_at)$Sort order - either asc or desc
descPattern: ^(asc|desc)$The maximum number of items to return.
100The number of items to skip before starting to collect the result set.
0The maximum number of items to return.
100Field to sort by - either created_at, updated_at, published_at, or collected_at
published_atPattern: ^(created_at|updated_at|published_at|collected_at)$Sort order - either asc or desc
descThe number of items to skip before starting to collect the result set.
0The maximum number of items to return.
100Field to sort by - either created_at, updated_at, published_at, or collected_at
published_atPattern: ^(created_at|updated_at|published_at|collected_at)$Sort order - either asc or desc
descPattern: ^(asc|desc)$Endpoint to browse for products.
Filter the products by name
""The number of items to skip before starting to collect the result set.
0The maximum number of items to return.
100Field to sort by - either name, created_at or updated_at
created_atPattern: ^(name|created_at|updated_at)$Sort order - either asc or desc
descPattern: ^(asc|desc)$A string used to filter references. Allowed filter terms:
source:: filter by source. (exact match - lowercase)domain:: filter by domain. (case insensitive substring filter)url:: filter by url. (case insensitive substring filter)title:: filter the title for a string. (case insensitive substring filter)embedding:: filter by content chunk embeddingField to sort by - either created_at, updated_at, published_at, or collected_at
published_atPattern: ^(published_at|collected_at|created_at|updated_at)$Sort order - either asc or desc
descPattern: ^(asc|desc)$The number of items to skip before starting to collect the result set.
0Whether to include user-generated content in the response.
falseThe maximum number of items to return.
100Retrieve a reference by its identifier.
This endpoint returns the reference object associated with the given URL hash. If no reference is found, a 404 error is returned.
The unique hash of the URL or UUID to retrieve the reference for
Endpoint to browse vendors based on various criteria.
Filter the vendors by name
""The number of items to skip before starting to collect the result set.
0The maximum number of items to return.
100Field to sort by - either name, created_at or updated_at
created_atPattern: ^(name|created_at|updated_at)$Sort order - either asc or desc
descPattern: ^(asc|desc)$Endpoint to browse vulnerabilities, with filters on some criteria.
A string used to filter vulnerabilities. It can start with specific prefixes to indicate the type of filter:
cve:: Filter by CVE ID.uuid:: Filter by UUID.desc:: Filter by description.gen_description:: Filter by gen_description.gen_name:: Filter by gen_name.CVE- or a UUID pattern, it will be treated as a specific filter.Field to sort by - either cve_id, created_at, updated_at, cvss_3_base_score, epss_score, epss_percentile
created_atPattern: ^(cve_id|created_at|updated_at|cvss_3_base_score|epss_score|epss_percentile)$Sort order - either asc or desc
descPattern: ^(asc|desc)$The number of items to skip before starting to collect the result set.
0The maximum number of items to return.
100Endpoint to search for products based on search criteria.
The number of items to skip before starting to collect the result set.
0The maximum number of items to return.
100Field to sort by - either name, created_at or updated_at
created_atPattern: ^(name|created_at|updated_at)$Sort order - either asc or desc
descPattern: ^(asc|desc)$The search criteria for products
Common Platform Enumeration (CPE) 2.3 string. Overrides type, vendor, and product if provided.
The name of the product.
The type of search to perform. Options are: 'standard', 'did_you_mean'. Defaults to 'standard'.
standardExample: ["standard","did_you_mean"]The type of the product (e.g., application, operating system). Defaults to 'application'.
The vendor of the product.
Create new references from a list of URLs.
This endpoint creates new references from the provided URLs. If any reference already exists, returns the existing reference for that URL. Returns an array of created/existing references.
{"urls":["https://example1.com/blog/post","https://example2.com/blog/post"]}