POST: Track the Remediation of a Finding – Bitsight Knowledge Base

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

Manage your findings for issue tracking and assign users to remediate.

Parameters
Example Request: Remediate a Finding
Example Request: Change the Remediation Status

Parameters

* Required.

Parameter Values

company_guid

* [Data] Identify your company.

[String] Your company’s unique identifier [entity_guid]. See GET: Portfolio Details.

evidence_key

* [Data] Identify the asset (domain or IP address) associated with the finding to remediate.

[String] The asset [evidence_key]. See GET: Issue Tracking.

risk_vector

* [Data] Identify a risk vector to remediate.

[String] The risk vector slug name. See risk types.

rolledup_observation_id

* [Data] Identify a finding to remediate.

[String] Finding identifier. See GET: Issue Tracking.

status

[Data] Edit the finding to remediate. Requires value and public.

[Object]

{"value":"Risk Accepted","public":false}

value

[Data] Change the remediation status of the finding. Required if status is included.

[String] Remediation status:

Open
To Do
Work In Progress
Resolved
Risk Accepted

public

[Data] For internal Bitsight use. Required if status is included.

[Boolean] false

assignments

[Data] Assign a user to remediate the specified findings.

[Array] Comma-separated user unique identifiers [user_guid]. See GET: Users.

Example Request: Remediate a Finding

cURL Example: Remediate a Finding

curl -X POST --data-ascii '{
  "company_guid":"1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
  "rolledup_observation_id":"_aAAa1AA_a1aAA1A1aaAAa==",
  "evidence_key":"11.1.111.11:80",
  "risk_vector":"open_ports",
  "assignments":[
    "11111111-aaaa-1111-aaaa-111111111111"
  ]
}' https://api.bitsighttech.com/ratings/v1/remediations -u api_token: --header "Content-Type:application/json"

JSON Example: Remediate a Finding

{
  "company_guid":"1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
  "rolledup_observation_id":"_aAAa1AA_a1aAA1A1aaAAa==",
  "evidence_key":"11.1.111.11:80",
  "risk_vector":"open_ports",
  "assignments":[
    "11111111-aaaa-1111-aaaa-111111111111"
  ]
}

Example Request: Change the Remediation Status

cURL Example: Change the Remediation Status

curl -X POST --data-ascii '{
  "company_guid":"1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
  "rolledup_observation_id":"_aAAa1AA_a1aAA1A1aaAAa==",
  "evidence_key":"11.1.111.11:80",
  "risk_vector":"open_ports",
  "status":{
    "value":"Risk Accepted",
    "public":false
  }
}' https://api.bitsighttech.com/ratings/v1/remediations -u api_token: --header "Content-Type:application/json"

JSON Example: Change the Remediation Status

{
  "company_guid":"1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9",
  "rolledup_observation_id":"_aAAa1AA_a1aAA1A1aaAAa==",
  "evidence_key":"11.1.111.11:80",
  "risk_vector":"open_ports",
  "status":{
    "value":"Risk Accepted",
    "public":false
  }
}

August 20, 2020: Published.