REST APIs for 24.5

Risk summary APIs are the following:

This API is added under specific app_groups to represent the name and os_platforms of the ransomware service.

This API is referencing the schema workloads_by_exposure:

The schema workloads_by_exposure describes the number of workloads with one or more critically risky services as its highest risk. It is also used by the API risk_summary_get.

This API, added under app_groups, returns a ransomware risk summary for each app group.

This API is referencing the common schema workload_exposure_severity:

The common schema workload_exposure_severity describes exposed ransomware severity for a workload.

This Public Stable API was changed to support the Ransomware Dashboard in the following way:

One new object was added: risk_summary, which explains the risk summary for the workload. This object includes a required object ransomware, which supplies these properties:

This API, which supplies the risk details, you can see in action on the Workloads page, tab Ransomware Protection.

In addition to the organization admin, the users with access to the workload can view the ransomware protection details for that workload or how many risky ports are protected and how many risky ports are not protected.

This schema is referenced from workloads_risk_details_get to supply the required service data:

Information about the operating systems has been added for the ransomware service: Windows and Linux.

This Public Stable API now includes two new properties: num_assets_requiring_ransomware_protection and cloud_secure_tenant_id.

},
    "num_assets_requiring_ransomware_protection": {
      "description": "number of assets that need ransomware protection for this org",
      "type": [
        "integer",
        "null"
      ]
    },
================

    },
    "cloud_secure_tenant_id": {
      "description": "Cloud Secure tenant id corresponding to this organization",
      "type": "string"
    }
  }
}

This Public Stable API was changed to include the new property num_assets_requiring_ransomware_protection, which provides a number of assets that need ransomware protection in a specific organization (1 - 9999999). Number of assets is between one and 9999999.

"properties": {
    "num_assets_requiring_ransomware_protection": {
      "description": "number of assets that need ransomware protection for this org",
      "type": "integer",
      "minimum": 1,
      "maximum": 9999999
    },
================
},
    "cloud_secure_tenant_id": {
      "description": "Cloud Secure tenant id corresponding to this organization",
      "type": "string"
    }
  }

The new widget for the Ransomware Dashboard displays risky services and their protection coverage scores.

The API now contains the property average_protection_percent, which is the average amount of ransomware protection percentages for all service ports in the service.

To include the needed data in the response to this request from the UI, the query parameter include_ransomware_protection_percent is used and set to true to include the average percentage data.

The APIs used to generate summary reports are:

This API is used to show the time series data:

Data is presented with the granularity of day, week, month, and quarter, where the default is day.

Payloads for this API can be such as the following:

[{"property":"num_workloads_by_exposure","resolution":"day"}]

[{"property":"ransomware_protection_coverage_percent","resolution":"day"}]

This API gives the start and end date of the time period.

Security administrators use this API to view how many workloads are ransomware protection-ready and then assess the degree of protection in their whole system. This schema supplies the required information to run the Ransomware Dashboard:

The property risky_ports_by_category was added to support the widget "Risky ports by type" in the UI.

Four required properties are added for the ransomware objects:

This schema is referenced from reports_risk_summary_get.schema.json to supply the number of protected and unprotected ports for a specified risk level.

Other APIs that support Summary Reports