Security Performance Management
Continuous Monitoring
Cyber Insurance
National Cybersecurity

Articles in this section

POST: Get Rating & Subscribe If Necessary

Avatar
Ingrid
Follow
Publication Date – October 5, 2023

⇤ Current Ratings

https://api.bitsighttech.com/ratings/v1/current-ratings

Get an entity’s current rating and subscribe if necessary.

Parameters

*Required.

Data Description Values 
guids*
Data 		Identify the company to query. [Array:String] Company unique identifier [entity_guid]. See GET: Portfolio Details. 
use_license
Data 		Use a license/subscription. [Boolean] true = Use license/subscription.

Example Request

curl -H "Content-Type: application/json" -X POST -i https://api.bitsighttech.com/ratings/v1/current-ratings -u api_token: -d '{
"guids": ["9ecd7b7e-42b4-4d32-99e8-1b65e59b0774"],
"use_license": true}'

Example Response

{
  "results":[
    {
      "guid":"9ecd7b7e-42b4-4d32-99e8-1b65e59b0774",
      "name":"Frontstore, Inc.",
      "rating":690,
      "rating_category":"intermediate"
    }
  ],
  "rating_as_of":"2023-10-04",
  "rating_licenses_used":0,
  "total_rating_licenses_used":0,
  "total_rating_licenses_remaining":0
}

Response Attributes

Field Description 
results
Array 		The entity’s rating and details.
  Object Rating details.
  
guid
String [entity_guid]		 The unique identifier of this entity in your portfolio. 
name
String 		The name of this entity. 
rating
Integer 		The current Bitsight Security Rating of this entity. 
rating_category
String 		The rating category. 
rating_as_of
String [YYYY-MM-DD]		 When the rating was calculated. 
rating_licenses_used
Integer 		The number of used subscriptions. 
total_rating_licenses_used
Integer 		The total number of used subscriptions. 
total_rating_licenses_remaining
Integer 		The remaining number of available subscriptions.

Response Codes

Code Description
200 – Okay Everything worked as expected.
400 – Bad Data The request was incorrect. This can often be due to missing a required parameter.
401 – Unauthorized No valid API token was provided.
403 – Permission Denied You do not have permission to access this resource.
404 – Not Found The specified resource could not be found.
default Unexpected error.

Related articles