Security Performance Management
Continuous Monitoring
Cyber Insurance
National Cybersecurity

Articles in this section

See more

GET: Portfolio API Filters

Avatar
Ingrid
Follow
  • November 2, 2020: ‘Alerts Only’ renamed to ‘Risk Monitoring.’
  • June 22, 2020: ‘Sovereign Security Ratings’ renamed to ‘National Cybersecurity.’

⇤ Portfolio
⇤ Portfolio for National Cybersecurity

https://api.bitsighttech.com/ratings/v1/portfolio/filters

This returns infections, open ports, and vulnerabilities in your portfolio, and also statistics on infections and vulnerabilities that are present.

This path does not currently have the capability to return companies that are affected by a specific botnet or vulnerability.

Parameters

Parameter Description Values 
exclude_alerts_only
Query		 Filter Risk Monitoring subscriptions. [boolean, query] true = Exclude Risk Monitoring subscriptions. 
fields
Query		 Include specific organization fields. [Array] Comma-delimited:
  • vulnerabilities
  • open_ports
  • botlist
 
folder
Query		 Show only companies in the specified folder. [String] Folder unique identifier [folder_guid]. See GET: Folder Details. 
format
Query		 Format of response data. [String] 
quarters_back
Query		 Get ratings from the last day of the quarter, set back by a selected number of quarters from today. [Integer] The number of quarters. 
rating_date
Query		   [String] The most recent rating date [YYYY-MM-DD]. 
show_event_evidence
Query		 Filter companies with enhanced event evidence. [Boolean] true = SHow only organizations that have enhanced event evidence enabled. 
show_ips
Query		 Filter organizations with visible IP addresses. [Boolean] true Show only organizations with visible IP addresses. 
tier
Query		 Show only companies that are tiered to the specified tiers. [Array] Comma-separated tier unique identifiers [tier_guid] or untiered for companies that are not present in any tier. See GET: Tiers.

Example Requests

To get all data, including vulnerabilities, botnets, and open ports affecting your portfolio:

curl https://api.bitsighttech.com/ratings/v1/portfolio/filters -u api_token:

Botnet infections of a single folder:

curl https://api.bitsighttech.com/ratings/v1/portfolio/filters?fields=infections&folder=folder_guid -u api_token:

Open ports and vulnerabilities (but not infections) of all companies in your portfolio:

curl https://api.bitsighttech.com/ratings/v1/portfolio/filters?fields=vulnerabilities,open_ports -u api_token:

Example Response

{
  "data": {
    "vulnerabilities": {
      "3c87e467-7474-42da-8369-c4c2573851d8": ["Logjam", "POODLE"]
    },
    "botlist": {
      "12345678-c3b0-a2d2-bb80-d5df44c3a2e5": ["Conficker", "Genieo", "RevMob", "SniperSpy"],
    },
    "open_ports": {
      "12345678-c3b0-a2d2-bb80-d5df44c3a2e5": ["HTTP", "HTTPS"],
    }
  },
  "initial_counts": {
    "vulnerabilities": {
      "POODLE": 2
    },
    "botlist": {
      "SniperSpy": 1
    },
    "open_ports": {
      "XMPP": 1
    }
  }
}

Response Attributes

Field Description 
data
Object		 Information about organizations in your portfolio.
  
vulnerabilities
Object		 Organizations with vulnerabilities.
  GUID [entity_guid]
Array		 Vulnerabilities in this organization.
Example:
["Logjam", "DROWN", "POODLE"]
 
botlist
Object		 Organizations with botnet infections.
  GUID [entity_guid]
Array		 Botnet infections in this organization. 
open_ports
Object		 Organizations with open ports.
  GUID [entity_guid]
Array		 Open ports in this organization. 
initial_counts
Object		 Statistical information about vulnerabilities, botnet infections, and open ports across your portfolio.
  
vulnerabilities
Object		 The type and number of vulnerabilities across your portfolio.
  Vulnerability Name
Integer		 The name of the vulnerability and the number of organizations in your portfolio that are affected by it.
Example: "Logjam": 1995,
 
botlist
Object		 The type and number of botnet infections across your portfolio.
  Botnet Name
Integer		 The name of the botnet and the number of organizations in your portfolio that are affected by it.
Example: "Port Scanner": 282,
 
open_ports
Object		 The type and number of open ports across your portfolio.
  Port Name
Integer		 The name of the port and the number of organizations in your portfolio that have the port open.
Example: "Distributed Hash Table": 135,

Related articles