Sign in

v1

latestOpenAPI 3.1.12026-07-242899061.7 MB
Action Plans

This resource returns a list of finding details from an action plan of a TOE.

This API returns a list of findings for a given action plan of a TOE. The end-user needs to input the TOE ID (toe_id) for a given action plan in the API request.

get/v1/action_plan/findings/{toe_id}

Path parameters

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

Filter by the Toe ID.

Query parameters

pageinteger
Example:1

This parameter is the page number in routes that have pagination.

per_pageinteger
Example:20

This parameter sets the results limit per page. This defaults to 20 and currently has a max of 250.

sort_attribute'days_open' | 'security_criteria' | 'asset_value' | 'severity' | 'priority'
Example:priority

This parameter is optional but allows the user to sort results of alerting issues by available sort attributes.

sort_method'ASC' | 'DESC'
Example:DESC

Sort results by ascending or descending order.

severity'critical' | 'high' | 'medium' | 'low'
Example:high

Filter finding results by severity.

asset_value'high' | 'medium' | 'low' | 'idle' | 'key'

This parameter filters finding results by asset_value.

security_domainstring
Example:software_patching

Filter results by the Security Domain.

security_criteriastring
Example:patching_app_server

Filter results by the Security Criteria.

cve_ids[]string[]

This parameter filters finding results by array of Common Vulnerabilities and Exposures (CVE). An example of a query string with multiple cves would look like:

?cve_ids[]=CVE-1999-0001&cve_ids[]=CVE-1999-0002

[
  "CVE-1999-0001"
]

Response

OK

Example response

{
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_count": 52,
    "total_pages": 10
  },
  "data": [
    {
      "attributes": {
        "analysis_id": "12345",
        "asset_value": "4",
        "cve_ids": [
          "CVE-1999-0001"
        ],
        "domain_name": "riskrecon.com",
        "finding_data_description": "Missing Security Headers",
        "finding_data_value": "shared_hosting",
        "finding_detail": "shared_hosting",
        "finding_extra_data_value": "shared_hosting",
        "finding_id": "5976423a-ee35-11e3-8569-14109ff1a304",
        "finding_short_description": "Missing Security Headers",
        "first_seen": "2020-10-10",
        "host_name": "riskrecon.com",
        "hosting_provider": "Riskrecon, Co.",
        "how_to_fix_it": "Update the software",
        "ip_address": "127.0.0.1",
        "last_seen": "2020-10-10",
        "privacy_criteria": "privacy_unencrypted_sensitive_systems",
        "security_criteria": "software_patching",
        "security_domain": "patching_app_server",
        "severity": "4",
        "priority": 5,
        "support_site": "https://support.riskrecon.com",
        "who_should_fix_it": "The system administrator"
      },
      "id": "12345",
      "type": "finding"
    }
  ]
}