v1

latestOpenAPI 3.1.12026-07-242899061.7 MB
Findings

:: Legacy Route :: This resource returns a list of findings for latest analysis for a given TOE.

::Legacy Route please use findings_paginated:: This use case describes how the Findings API is used to retrieve a list of findings for the latest analysis for a TOE. The toe_id is passed in the API request. In this scenario, all findings for that TOE are returned in the response. To limit or filter the data returned in the response, you can use various parameters in the API request:

  • Filter by an asset value: You can use the asset_value parameter to search for findings with high, medium, or low asset value.
  • Filter by severity: You can use the severity parameter to search for findings with high, medium, or low severity.
  • Filter by asset value and severity: You can use asset_value and severity parameters to search for findings with high, medium, or low asset value and severity.
  • Filter by multiple asset values: You can use the asset_value parameter multiple times to search for findings with multiple asset values.
get/v1/findings/{toe_id}

Path parameters

toe_idstring required
Example:5976423a-ee35-11e3-8569-14109ff1a304

Filter by the Toe ID.

Query parameters

risk_policyboolean
Example:true

Filter findings based on customer risk policy. This can be setup at https://portal.riskrecon.com/portal/risk-policy.

security_domainstring
Example:software_patching

Filter results by the Security Domain.

security_criteriastring
Example:patching_app_server

Filter results by the Security Criteria.

asset_value[]string[]

This parameter filters finding results by asset_values. An example of a query string with multiple asset_values would look like:

?asset_value[]=high&asset_value[]=low

[
  "high"
]
asset_value_numeric[]string[]

Filter results by asset_value_numeric. An example of a query string with multiple asset_value_numeric values would look like ?asset_value_numeric[]=1&asset_value_numeric[]=3

[
  "1"
]
priority[]integer[]

Filter results by priority. An example of a query string with multiple priority values would look like ?priority[]=1&priority[]=3.

[
  1
]
severity[]string[]

Filter results by severity. An example of a query string with multiple severities would look like ?severity[]=low&severity[]=medium&severity[]=high.

[
  "high"
]

Response

OK

country_iso_codestring
first_seenstring
tech_countrystring
shared_ipstring
registrant_streetstring
security_criteriastring
continent_codestring
registrar_expire_datestring
registrar_abuse_phonestring
tech_streetstring
state_namestring
finding_extra_data_valuestring
toe_idstring
finding_data_valuestring
servicestring
is_webstring
admin_orgstring
industrystring
longitudestring
registrarstring
severitystring
hosting_typestring
admin_phone_extstring
admin_countrystring
registrant_emailstring
record_load_timestampstring
admin_namestring
asset_valuestring
admin_zipstring
auto_statusstring
finding_contextstring
tech_zipstring
form_field_types_detectedstring
admin_citystring
finding_idstring
registrant_countrystring
analysis_idstring
host_namestring
registrar_ianastring
findingstring
registrar_abuse_emailstring
expires_onstring
registrar_idstring
tech_orgstring
analyst_statusstring
ip_addressstring
tech_emailstring
finding_detailstring
state_abbrevstring
admin_phonestring
domain_namestring
postal_codestring
vendorstring
security_domainstring
registrant_phonestring
registrant_namestring
finding_typestring
latitudestring
hosting_providerstring
prioritystring
last_seenstring
country_namestring
false_positivestring
registrant_orgstring
registrant_phone_extstring
finding_auto_commentsstring
scanstring
tech_phonestring
name_serverstring
tech_citystring
tech_namestring
admin_streetstring
auth_detectedstring
admin_emailstring
continent_namestring
finding_subtypestring
finding_data_descriptionstring
severity_numericstring
registry_tech_idstring
metro_codestring
asset_value_numericstring
registrant_zipstring
city_namestring
registrant_citystring
who_should_fix_itstring
support_sitestring
how_to_fix_itstring