v1

latestOpenAPI 3.1.12026-07-242899061.7 MB

Target Of Evaluation TOE

Get the current or historical overall, domain and criteria ratings for a given TOE and a given risk dimension.

Get the current or historical overall, domain and criteria ratings for a given TOE and a given risk dimension. Privacy can only be returned if privacy is enabled for your customer and you have a privacy license for the given TOE.

get/v1/toes/{toe_id}/ratings

Path parameters

toe_idstring required

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

Filter by the Toe ID.

Query parameters

risk_dimensions[]string[]

This parameter filters results by array of RiskDimensions. Defaults to cyber. privacy is a new option for customers with privacy licenses. ?risk_dimensions[]=privacy&risk_dimensions[]=cyber

[
  "cyber"
]

current_rating_onlyboolean

Option to return only the current most recent rating. Pretty much another way to set per_page to 1.

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.

Response

Example response

{
  "meta": {
    "current_page": 2,
    "next_page": 3,
    "prev_page": 1,
    "total_count": 52,
    "total_pages": 10
  },
  "data": [
    {
      "attributes": {
        "analysis_id": "12345",
        "updated_at": "2021-10-01T22:18:57+00:00",
        "cyber_rating": "a",
        "cyber_rating_numeric": 9,
        "cyber_trend": 1.9,
        "privacy_rating": "a",
        "privacy_rating_numeric": 9,
        "privacy_trend": 1.9,
        "security_domain_ratings": [
          {
            "security_domain": "patching_app_server",
            "rating": "a",
            "rating_numeric": 9,
            "risk_dimension": "cyber",
            "display_name": "OpenSSL Patching",
            "rated": true,
            "trend": 1.9
          }
        ],
        "security_criteria_ratings": [
          {
            "security_domain": "patching_app_server",
            "security_criteria": "patching_openssl",
            "rating": "a",
            "rating_numeric": 9,
            "risk_dimension": "cyber",
            "display_name": "OpenSSL Patching",
            "rated": true,
            "trend": 1.9
          }
        ]
      },
      "id": "12345",
      "type": "analysis"
    }
  ]
}