PATCH: Update the Status or Assignee of a Finding

Manage the remediation status or user assigned to findings.

• Parameters for Multiple Findings
• Parameters for a Single Finding
• Example Requests

Update Multiple Findings

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

Parameters for Multiple Findings

* Required.

company_guid

* Required.

[Data] Identify your company.

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

evidence_key

* Required.

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

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

risk_vector

* Required.

[Data] Identify a risk vector to remediate.

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

rolledup_observation_id

* Required.

[Data] Identify a finding to remediate.

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

status

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

Value: [Object]

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

value

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

Value: [String] Remediation status:

• Open
• To Do
• Work In Progress
• Resolved
• Risk Accepted

public

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

Value: [Boolean] false

assignments

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

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

Update a Single Finding

https://api.bitsighttech.com/ratings/v1/remediations/{company_guid}

Parameters for a Single Finding

* Required.

evidence_key

* Required.

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

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

risk_vector

* Required.

[Data] Identify a risk vector to remediate.

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

rolledup_observation_id

* Required.

[Data] Identify a finding to remediate.

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

status

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

Value: [Object]

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

value

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

Value: [String] Remediation status:

• Open
• To Do
• Work In Progress
• Resolved
• Risk Accepted

public

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

Value: [Boolean] false

assignments

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

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

Example Requests

cURL to assign a user to remediate a finding:

curl -X PATCH --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 to assign a user to 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"
  ]
}

cURL to change the remediation status of a finding:

curl -X PATCH --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 to change the remediation status of 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",
  "status":{
    "value":"Risk Accepted",
    "public":false
  }
}