v1

latestOpenAPI 3.1.12026-07-242899061.7 MB
Analyses

:: Legacy Route Please use getToeRatings :: This resource returns the most recent `Analysis` object by the TOE identifier. Trend data is only included if `include_trend` query param is added.

:: Legacy Route Please use getToeRatings :: This resource returns the most recent Analysis object by the TOE identifier. This includes the security domain and criteria ratings. Trend data is only included if include_trend query param is added.

get/v1/analysis/current/{toe_id}

Path parameters

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

Filter by the Toe ID.

Query parameters

include_trendboolean

This parameter gives the option to include trending data for current analysis request. Normally, this is only included when looking at the historical analyses.

Response

OK

analysis_tsstring

The date an analysis was updated.

analysis_idstring

The unique identifier for an analysis.

trendnumber nullable

Increase or decrease from the previous analysis rating.

rating_v2string

The rating label of an analysis or of some domain or criteria of the analysis.

rating_numericnumber

The numeric rating of an analysis or of some domain or criteria of the analysis.

ratingstring

The legacy Rating label of an analysis or of some domain or criteria of the analysis.

Example response

{
  "security_domain_ratings": {
    "web_encryption": {
      "trend": 1.9,
      "rating_v2": "a",
      "rating_numeric": 5,
      "rating": "proceed",
      "web_encryption_subject": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "web_encryption_protocol": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "web_encryption_key_length": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "web_encryption_hash": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "web_encryption_date_valid": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "web_encryption_date_expire": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      }
    },
    "web_app_security": {
      "trend": 1.9,
      "rating_v2": "a",
      "rating_numeric": 5,
      "rating": "proceed",
      "web_http_security_headers": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "threat_intel_alert_external": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "config_web_cms_authentication": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      }
    },
    "threat_intell": {
      "trend": 1.9,
      "rating_v2": "a",
      "rating_numeric": 5,
      "rating": "proceed",
      "threatintel_spamming_host": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "threatintel_phishing_site": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "threatintel_other": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "threatintel_hostile_host_scanning": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "threatintel_hostile_host_hacking": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "threatintel_cc_server": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "threatintel_botnet_host": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      }
    },
    "system_hosting": {
      "trend": 1.9,
      "rating_v2": "a",
      "rating_numeric": 5,
      "rating": "proceed",
      "hosting_countries": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "host_hosting_providers": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      }
    },
    "software_patching": {
      "trend": 1.9,
      "rating_v2": "a",
      "rating_numeric": 5,
      "rating": "proceed",
      "patching_web_server": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "patching_web_cms": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "patching_vuln_open_ssl": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "patching_app_server": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      }
    },
    "network_filtering": {
      "trend": 1.9,
      "rating_v2": "a",
      "rating_numeric": 5,
      "rating": "proceed",
      "unsafe_network_services": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "iot_devices": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      }
    },
    "governance": {
      "trend": 1.9,
      "rating_v2": "a",
      "rating_numeric": 5,
      "rating": "proceed",
      "governance_security_certifications": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "governance_regulatory_requirements": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "governance_customer_base": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      }
    },
    "email_security": {
      "trend": 1.9,
      "rating_v2": "a",
      "rating_numeric": 5,
      "rating": "proceed",
      "email_hosting_providers": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "email_encryption_enabled": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "email_authentication": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      }
    },
    "dns_security": {
      "trend": 1.9,
      "rating_v2": "a",
      "rating_numeric": 5,
      "rating": "proceed",
      "domain_hijacking_protection": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "dns_hosting_providers": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      }
    },
    "defensibility": {
      "trend": 1.9,
      "rating_v2": "a",
      "rating_numeric": 5,
      "rating": "proceed",
      "shared_hosting": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "defensibility_hosting_providers": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "attack_surface_web_ip": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "attack_surface_web_hostname": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      }
    },
    "data_loss": {
      "trend": 1.9,
      "rating_v2": "a",
      "rating_numeric": 5,
      "rating": "proceed",
      "data_loss_6": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "data_loss_36": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "data_loss_24": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      },
      "data_loss_12": {
        "trend": 1.9,
        "rating_v2": "a",
        "rating_numeric": 5,
        "rating": "proceed"
      }
    }
  },
  "analysis_ts": "2021-10-01T22:18:57+00:00",
  "analysis_id": "12345",
  "trend": 1.9,
  "rating_v2": "a",
  "rating_numeric": 5,
  "rating": "proceed"
}