National Cybersecurity API Guide

Ingrid

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.

Endpoints

Companies
Industries
Portfolio
Sovereign

Companies

Path	Purpose	Description
/v1/companies/country_guid	GET: Country Details	Retrieve National Cybersecurity information during the past 1 year.

Industries

Path	Purpose	Description
/v1/industries/countries	GET: Industry and Country Ratings	The most recent rating information of industry/country combinations in your portfolio.

Portfolio

Path	Purpose	Description
/v2/portfolio	GET: Portfolio Details	Information regarding your National Cybersecurity portfolio.
/v2/portfolio/summaries	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.
/v1/portfolio/countries	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.
/v1/portfolio/filters	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.
/v1/portfolio/guids	GET: Portfolio Unique Identifiers (GUID)	Returns a simple list of unique identifiers (GUID) in your portfolio.

Sovereign

Path	Purpose	Description
/sovereign/network-resources/ips/ip_address	GET: National Cybersecurity Network Resources	Determine if a specific IP address belongs to the address space of one of your subscribed countries.
/sovereign/observations	GET: National Cybersecurity Observations	Retrieve the most recent 1,000 observations within the primary country of your National Cybersecurity portfolio.
/sovereign/observations/companies/kpis/	GET: National Cybersecurity Companies KPI	See observation distinct company counts for each supported filter.
/sovereign/observations/counts	GET: National Cybersecurity Observation Counts	Retrieve the total count of all observed findings throughout all risk vectors, that have been observed in companies attributed to a country.
/sovereign/observations/kpis	GET: KPI for National Cybersecurity Observations	Retrieve top infections, top vulnerabilities, and the most common open ports for companies in your National Cybersecurity 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.

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 and /v2/portfolio/summaries now available.

API-National-Cybersecurity-20211109.pdf
(600 KB)