The /portfolio root API endpoint allows you to manage your portfolio, and also provides details about your portfolio and the organizations in your portfolio, including:
- A summary of your portfolio.
- Current security ratings.
- A 1-year trend line (sparkline) of historical ratings.
- Company statistics (vulnerabilities, infections, open ports).
- And more!
Use the /companies endpoint to get ratings histories and risk vector grades for individual companies.
Version 2 Paths
https://api.bitsighttech.com/ratings/v2/portfolio
| Path | Purpose | Description |
|---|---|---|
/v2/portfolio |
GET: Portfolio Details [v2] | Get information about the companies in your portfolio or your National Cybersecurity portfolio. |
/v2/portfolio/summaries |
GET: Portfolio Summary | Get a summary of your portfolio or your National Cybersecurity portfolio. This can be used to get a list of the possible values for querying GET: Portfolio Details. |
Version 1 Paths
https://api.bitsighttech.com/ratings/v1/portfolio
| Path | Purpose | Description |
|---|---|---|
/v1/portfolio |
GET: Portfolio Details [v1] | Get information about the organizations in your portfolio. |
| GET: National Cybersecurity Portfolio Details [v1] | Information regarding your National Cybersecurity portfolio. | |
/v1/portfolio/breaches |
GET: Security Incidents in Your Portfolio | Get Security Incident details of companies in your portfolio. |
/v1/portfolio/contacts |
GET: Portfolio Contacts | Get a list of contacts in your portfolio. |
/v1/portfolio/contacts |
POST: Assign a Point of Contact | This is a prerequisite for sending Client/Vendor Access Program requests in bulk. Use this to tag companies in your portfolio with the contact information of a primary recipient (contact). |
/v1/portfolio/contacts/user_guid
|
PATCH: Edit Portfolio Contacts | Edit the contacts of companies in your portfolio that already have a point-of-contact. |
/v1/portfolio/countries |
GET: Geographic IP Address Space | Get an understanding of the geographic IP address space of your portfolio. This can be used to determine which vendors need to comply with data residency requirements. |
/v1/portfolio/entity-custom-ids |
GET: Custom Company Identifiers | Get custom company identifiers (custom company ID), which maps your identifiers with Bitsight data, making it easier to associate data with the rest of your third party-related information. |
/v1/portfolio/entity-custom-ids |
POST: Customize a Company's ID | Create or update a company's ID (custom company ID). |
/v1/portfolio/entity-custom-ids/bulk |
POST: Custom ID in Bulk | Assign, edit, or delete up to 1000 company IDs. |
/v1/portfolio/filters |
GET: Portfolio Filters | Returns infections, open ports, vulnerabilities affecting each company in your portfolio, and statistics for all infections and vulnerabilities present. |
/v1/portfolio/guids |
GET: Portfolio Unique Identifier (GUID) | Returns a simple list of every unique identifier in your portfolio, without any names or additional information attached. |
/v1/portfolio/monitored-assets/summaries |
GET: Monitored Assets Summaries | Returns a summary of the critical assets you monitor. |
/v1/portfolio/products |
GET: Provided Products in Your Portfolio | Get the enterprise service provider products used by companies in your portfolio. Note that products can be installed on the premises, Infrastructure-as-a-Service (IaaS) products, or other Software-as-a-Service (SaaS) offerings; Product types are broader categories that encompass many types of products. |
/v1/portfolio/products/product_guid/companies
|
GET: Product Usage of Companies in Your Portfolio | List the third parties in your portfolio that use a particular service provider product. |
/v1/portfolio/product-types |
GET: Product Types in Your Portfolio | List the product types used by third parties in your portfolio. |
/v1/portfolio/providers |
GET: Service Providers | Get all service providers for the companies in your portfolio. |
/v1/portfolio/providers/company_guid/companies
|
GET: Portfolio Companies Dependent on a Specific Service Provider | Get the companies in your portfolio that depend on a specific service provider. |
/v1/portfolio/providers/company_guid/products
|
GET: Service Provider Products in Your Portfolio | Get the products provided by a specific service provider in your portfolio. |
/v1/portfolio/ratings |
GET, POST: Security Rating Details of Companies in Your Portfolio | Get security rating details of the companies in your portfolio. |
| GET, POST: Security Rating Details of Your National Cybersecurity Portfolio | Get security rating details of your National Cybersecurity portfolio. | |
/v1/portfolio/risk-vectors/grades |
GET: Portfolio Risk Vector Grades | Get risk vector grades of organizations in your portfolio.. |
/v1/portfolio/statistics |
GET: Portfolio Statistics |
Get portfolio statistics, including:
|
-
October 1, 2024: Added GET: Monitored Assets Summaries (
/v1/portfolio/monitored-assets/summaries). -
January 28, 2022: Added POST: Custom ID in Bulk (
/v1/portfolio/entity-custom-ids/bulk). -
October 15, 2021: Added GET: Industry Risk Vector Grades (
/v1/portfolio/risk-vectors/grades).
Feedback
0 comments
Please sign in to leave a comment.