Skip to content

Spotlight Vulnerabilities

The Spotlight Vulnerabilities service collection provides operations for querying and retrieving vulnerability data across your environment. Search for vulnerabilities using FQL filters, retrieve details on specific vulnerabilities and remediations, and use continuous pagination for large result sets.

LanguageLast Update
Pythonv1.6.5
PowerShellv2.2.9
Gov0.22.0
TypeScriptv0.6.0
Rustv0.7.1
Rubyv1.4.0

This service collection has code examples posted to the repository.



OperationDescription
combinedQueryVulnerabilities
query_vulnerabilities_combined
Search for Vulnerabilities in your environment by providing an FQL filter and paging details.
getRemediations
get_remediations
Get details on remediations by providing one or more IDs
getRemediationsV2
get_remediations_v2
Get details on remediation by providing one or more IDs
getVulnerabilities
get_vulnerabilities
Get details on vulnerabilities by providing one or more IDs
queryVulnerabilities
query_vulnerabilities
Search for Vulnerabilities in your environment by providing an FQL filter and paging details.

Search for Vulnerabilities in your environment by providing an FQL filter and paging details.

Method GET
Route /spotlight/combined/vulnerabilities/v1
Scope Vulnerabilities: READ
PEP 8 query_vulnerabilities_combined
after query · string
A pagination token used with the limit parameter to manage pagination of results. On your first request, don’t provide an after token. On subsequent requests, provide the after token from the previous response to continue from that place in the results.
limit query · integer
The number of items to return in this response (default: 100, max: 5000). Use with the after parameter to manage pagination of results.
sort query · string
FQL Syntax formatted sort filter.
filter query · string
Filter items using a query in Falcon Query Language (FQL). Wildcards * and empty filter values are unsupported. Available filter fields:
Available values (24)
cidlast_seen_withinstatus
cve.idcve.is_cisa_kevcve.remediation_level
cve.cps_ratingcve.exprt_ratingcve.exploit_status_to_include
cve.severitycve.base_scorecve.types
host_info.asset_criticalityhost_info.asset_roleshost_info.internet_exposure
host_info.tagshost_info.groupshost_info.product_type_desc
host_info.platform_namesuppression_info.is_suppressedsuppression_info.reason
closed_timestampupdated_timestampcve.base_score
facet query · string or list of strings
Select various details blocks to be returned for each vulnerability entity. Supported values:
Available values (4)
host_inforemediationcve
evaluation_logic
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import SpotlightVulnerabilities
falcon = SpotlightVulnerabilities(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.query_vulnerabilities_combined(after="string",
facet=id_list,
filter="string",
limit=integer,
sort="string")
print(response)
[
{
"aid": "string",
"app": {},
"apps": [],
"cid": "string",
"closed_timestamp": "string",
"confidence": "string",
"created_timestamp": "string",
"cve": {},
"data_providers": [],
"exploitability": "string",
"has_exploitability_prerequisites": "string",
"host_info": {},
"id": "string",
"remediation": {},
"risk_score": 0.0,
"services": [],
"status": "string",
"suppression_info": {},
"updated_timestamp": "string",
"vulnerability_id": "string",
"vulnerability_metadata_id": "string"
}
]


Get details on remediations by providing one or more IDs

Method GET
Route /spotlight/entities/remediations/v2
Scope Vulnerabilities: READ
PEP 8 get_remediations
ids query · string or list of strings
One or more remediation IDs (max: 400).
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import SpotlightVulnerabilities
falcon = SpotlightVulnerabilities(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_remediations(ids=id_list)
print(response)


Get details on remediation by providing one or more IDs

Method GET
Route /spotlight/entities/remediations/v2
Scope Vulnerabilities: READ
PEP 8 get_remediations_v2
ids query · string or list of strings
One or more remediation IDs
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import SpotlightVulnerabilities
falcon = SpotlightVulnerabilities(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_remediations_v2(ids=id_list)
print(response)
[
{
"action": "string",
"created_timestamp": "string",
"id": "string",
"link": "string",
"patch_publication_date": "string",
"provider": "string",
"recommendation_type": "string",
"reference": "string",
"title": "string",
"type": "string",
"updated_timestamp": "string",
"vendor_url": "string"
}
]


Get details on vulnerabilities by providing one or more IDs

Method GET
Route /spotlight/entities/vulnerabilities/v2
Scope Vulnerabilities: READ
PEP 8 get_vulnerabilities
ids query · string or list of strings
One or more vulnerability IDs (max: 400). Find vulnerability IDs with GET /spotlight/queries/vulnerabilities/v1
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import SpotlightVulnerabilities
falcon = SpotlightVulnerabilities(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_vulnerabilities(ids=id_list)
print(response)
[
{
"aid": "string",
"app": {},
"apps": [],
"cid": "string",
"closed_timestamp": "string",
"confidence": "string",
"created_timestamp": "string",
"cve": {},
"data_providers": [],
"exploitability": "string",
"has_exploitability_prerequisites": "string",
"host_info": {},
"id": "string",
"network_scan": [],
"remediation": {},
"risk_score": 0.0,
"services": [],
"status": "string",
"suppression_info": {},
"updated_timestamp": "string",
"vulnerability_id": "string",
"vulnerability_metadata_id": "string"
}
]


Search for Vulnerabilities in your environment by providing an FQL filter and paging details.

Method GET
Route /spotlight/queries/vulnerabilities/v1
Scope Vulnerabilities: READ
PEP 8 query_vulnerabilities
after query · string
A pagination token used with the limit parameter to manage pagination of results. On your first request, don’t provide an after token. On subsequent requests, provide the after token from the previous response to continue from that place in the results.
limit query · integer
The number of items to return in this response (default: 100, max: 400). Use with the after parameter to manage pagination of results.
sort query · string
Sort vulnerabilities by their properties.
filter query · string
Filter items using a query in Falcon Query Language (FQL). Wildcards * and empty filter values are unsupported. Available filter fields:
Available values (24)
cidlast_seen_withinstatus
cve.idcve.is_cisa_kevcve.remediation_level
cve.cps_ratingcve.exprt_ratingcve.exploit_status_to_include
cve.severitycve.base_scorecve.types
host_info.asset_criticalityhost_info.asset_roleshost_info.internet_exposure
host_info.tagshost_info.groupshost_info.product_type_desc
host_info.platform_namesuppression_info.is_suppressedsuppression_info.reason
closed_timestampupdated_timestampcve.base_score
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import SpotlightVulnerabilities
falcon = SpotlightVulnerabilities(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_vulnerabilities(after="string",
filter="string",
limit=integer,
sort="string")
print(response)
[
"string"
]