GET: Remediation Tracking

Ingrid

https://api.bitsighttech.com/ratings/v1/remediations

Track your remediation efforts with Issue Tracking.

Parameters

Parameter Values 
company_guid

[Query] Identify the company to track remediation.

 [String]Company unique identifier [entity_guid]. See GET: Portfolio Details. 
created_time_gte

[Query] Filter findings by when they were tracked for remediation starting on and after the specified datetime.

 [String] The datetime [YYYY‑MM‑DDTHH:MM:SSZ]. 
created_time_lte

[Query] Filter findings by when they were tracked for remediation starting on and prior to the specified datetime.

 [String] The datetime [YYYY‑MM‑DDTHH:MM:SSZ]. 
creator

[Query] Filter by the user assigned to the finding.

 [String] User unique identifier [user_guid]. See GET: Users. 
evidence_key

[Query] Filter by the company’s asset (domain or IP address) that’s attributed to the finding.

[String]

  • Domain
  • IP Address
 
risk_vector

[Query] Filter by risk vector.

 [String] Comma-separated risk vector slug names. See risk types. 
rolledup_observation_id

[Query] Filter by finding.

 [String] Finding identifier. See GET: Finding Details. 
status

[Query] Filter by remediation status.

[String] Remediation status:

  • OPEN
  • TODO
  • WORK_IN_PROGRESS
  • RESOLVED
  • RISK_ACCEPTED

Example Request

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

Example Response

{
  "links":{
    "previous":null,
    "next":null
  },
  "count":1,
  "results":[
    {
      "company_guid":"1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
      "company_name":"Actors Films",
      "risk_vector":"open_ports",
      "evidence_key":"11.111.111.111:23",
      "rolledup_observation_id":"_aAAa1AA_a1aAA1A1aaAAa==",
      "status":{

        "value":"Open",
        "public":false
      },
      "comment":{
        "value":null,
        "public":false,
        "guid":"ad7e13b0-b2d7-4fc6-b014-18fdffaa2114"
      },
      "assignments":[
        {
          "guid":"11111111-aaaa-1111-aaaa-111111111111",
          "friendly_name":"Arnold Brown",
          "formal_name":"Arnold Brown",
          "email":"arnold@actorsfilms.us",
          "phone_number":" ",
          "is_active":true,
          "last_login_date":"2020-08-18T19:29:46.955518Z",
          "joined_date":"2020-02-02T20:20:20Z",
          "status":"Activated"
        }
      ],
      "created_time":"2020-08-18T18:28:28.986465Z",
      "creator":{
        "guid":"11111111-aaaa-1111-aaaa-111111111111",
        "friendly_name":"Arnold Brown",
        "formal_name":"Arnold Brown",
        "email":"arnold@actorsfilms.us",
        "phone_number":" ",
        "is_active":true,
        "last_login_date":"2020-08-18T19:29:46.955518Z",
        "joined_date":"2020-02-02T20:20:20Z",
        "status":"Activated"
      }
    }
  ]
}

Response Attributes

Field Description 
links
Object 		Navigation for multiple pages of results. See pagination.
  
previous
String 		The URL to navigate to the previous page of results. 
next
String 		The URL to navigate to the next page of results. 
count

Integer

 The number of tracked findings for remediation. 
results

Array

 Tracked findings for remediation.
  
company_guid

String [entity_guid]

 The queried company. 
company_name

String

 The name of the company. 
risk_vector
String		 The slug name of the risk vector associated with this finding. 
evidence_key
String		 The company’s asset (domain or IP address) that’s attributed to the finding. 
rolledup_observation_id

String

 A stable and randomized identifier for findings. It is assigned to a finding when one or more observations with largely similar key properties occur in close succession. 
status

Object

 Remediation status details.
  
value

String

 The current remediation status of this finding. 
public

Boolean

 This value is always false. 
comment
Object 		Finding comment details.
  
value

String

 For internal Bitsight use. This value is always null. 
public

Boolean

 true = Comments on this finding are public. 
guid

String [comment_guid]

 The unique identifier of the finding comment. 
assignments

Array

 User details of those who are assigned to remediate this finding.
  
guid

String [user_guid]

 The assigned user’s unique identifier. 
friendly_name
String 		The assigned user’s full name. 
formal_name
String 		The assigned user’s full name. 
email
String 		The assigned user’s email address. 
phone_number
String 		The assigned user’s phone number. 
is_active
Boolean 		true = The assigned user has access to the Bitsight platform. 
last_login_date
String [YYYY‑MM‑DDTHH:MM:SSZ]		 The datetime when the user last logged in to the Bitsight platform. 
joined_date
String [YYYY‑MM‑DDTHH:MM:SSZ]		 The datetime when the assigned user’s account was created in the Bitsight platform. 
status
String 		The status of the user’s account. 
created_time
String [YYYY‑MM‑DDTHH:MM:SSZ]		 The datetime when remediation tracking began for this finding. 
creator
Object 		User details of who started tracking the remediation of this finding.
  
guid
String [user_guid]		 The remediation creator’s unique identifier. 
friendly_name
String 		The remediation creator’s full name. 
formal_name
String 		The remediation creator’s full name. 
email
String 		The remediation creator’s email address. 
phone_number
String 		The remediation creator’s phone number. 
is_active
Boolean 		true = The remediation creator has access to the Bitsight platform. 
last_login_date
String [YYYY‑MM‑DDTHH:MM:SSZ]		 The datetime when the remediation creator last logged in to the Bitsight platform. 
joined_date
String [YYYY‑MM‑DDTHH:MM:SSZ]		 The datetime when the remediation creator’s account was created in the Bitsight platform. 
status
String 		The status of the remediation creator’s account.
  • April 7, 2025: company_name & comment_guid.
  • August 20, 2020: Published.
Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.