-
May 26, 2021: Added GET: Ratings Tree (
/v1/companies/{company_guid}/company-tree) to related endpoints. - November 25, 2020: Published.
To best manage risk, using the Bitsight-curated version in your portfolio rather than the self-published rating is suggested. However, your approach may vary depending on your relationships with the companies in your portfolio.
Bitsight Curated
Bitsight-curated is the default designation.
| Path | Purpose | Field | Value |
|---|---|---|---|
/v1/companies/company_guid/company-tree
|
GET: Ratings Tree | rating_type |
CURATED |
/v2/portfolio |
GET: Portfolio Details | type |
CURATED |
/v1/portfolio |
GET: Portfolio Details [V1] | type |
CURATED |
/v1/subscriptions/expired |
GET: Expired Subscriptions | type |
CURATED |
Self-Published
Self-published ratings have their own Bitsight Security Rating reports, which consist of CIDR blocks, IP addresses, and domains that are specifically selected by the company itself, rather than curated by Bitsight.
| Path | Purpose | Field | Value |
|---|---|---|---|
/v1/companies/company_guid/company-tree
|
GET: Ratings Tree | rating_type |
SELF_PUBLISHED |
/v2/portfolio |
GET: Portfolio Details | type |
SELF_PUBLISHED |
/v1/portfolio |
GET: Portfolio Details [V1] | type |
SELF_PUBLISHED |
/v1/subscriptions/expired |
GET: Expired Subscriptions | type |
SELF_PUBLISHED |
Privately Published
Privately published ratings are created by an organization for internal use and are not available for other organizations to monitor and do not appear in searches by other organizations.
| Path | Purpose | Field | Value |
|---|---|---|---|
/v1/companies/company_guid/company-tree
|
GET: Ratings Tree | rating_type |
PRIVATE |
/v2/portfolio |
GET: Portfolio Details | type |
PRIVATE |
/v1/portfolio |
GET: Portfolio Details [V1] | type |
PRIVATE |
/v1/subscriptions/expired |
GET: Expired Subscriptions | type |
PRIVATE |