- July 10, 2023: Removed PDF.
- November 9, 2021: New paths GET: National Cybersecurity Companies KPI (
/sovereign/observations/companies/kpis/) & GET: National Cybersecurity Network Resources (
/sovereign/network-resources/ips/ip_address) now available.
- September 23, 2020:
/v2/portfolio/summaries now available.
National Cybersecurity takes advantage of existing endpoints, along with
/sovereign API endpoint paths to maximize the integration of National Cybersecurity data with risk management systems and solutions.
|GET: Country Details
|Retrieve National Cybersecurity information during the past 1 year.
|GET: Industry and Country Ratings
|The most recent rating information of industry/country combinations in your portfolio.
|GET: Portfolio Details
|Information regarding your National Cybersecurity portfolio.
|GET: Portfolio Summary
|Get a summary of your portfolio. This can be used to get a list of the possible values for querying GET: Portfolio Details.
|GET: Geographic IP Address Space
|Retrieve information about the geographic IP address space of your National Cybersecurity portfolio. This can be used to determine which companies needs to comply with data residency requirements.
|GET: Portfolio Filters
|This is a powerful system that returns findings (infections, open ports, and vulnerabilities) affecting each country in your portfolio, as well as statistics for all infections and vulnerabilities that are present.
|GET: Portfolio Unique Identifiers (GUID)
|Returns a simple list of unique identifiers (GUID) in your portfolio.
Make API responses more readable with JQ
JQ is a command-line processor that can neatly display JSON, and should make troubleshooting and testing API calls easier.
In the cURL examples in this document, some of them end with jq. Visit the JQ website for installation instructions. Put | jq at the end of any cURL request to make the response easier to read.