Update Risk Definitions

Updates the risk profile definitions of existing risks.

Note: If you modify a risk profile using this API but later reimport the profile from a spreadsheet and save it to the current profile, all your changes will be overwritten.

Resource Name: /api/v1/risks/profiles

Request Method: POST

Request URL Parameters:

Parameter

Type

Description
profileName

Mandatory

string The name of an existing risk profile.

Code

Mandatory

String Risk code
items array List of risks data.
Assessment String Detailed assessment of the risk.
Description String Description of risk.
Remedy String Remediation recommendation
Title String Title of risk

Request example json

{
  "items": [
    {
      "Assessment": "",
      "Code": "C00001",
      "Description": "",
      "Remedy": " ",
      "Title": ""From somewhere to Any allow Any service" rules"
    }
  ],
  "profileName": "AvishaiTest"
}

Request cURL examples 

curl -X POST "https://<localhost>/api/v1/risks/profiles" -H "Content-Type: application/json" -d '{
  "items": [
    {
      "Assessment": "",
      "Code": "C00001",
      "Description": "",
      "Remedy": "",
      "Title": ""From somewhere to Any allow Any service" rules"
    }
  ],
  "profileName": "AvishaiTest"
}

Response:

Response parameters

Element

Type

Description
message string

Response message.
status string Response status.

Status codes:

Code

Description
200

ActiveChange was triggered

401

Authentication failure

Response example for 200 

{
  "message": "Risk definitions updated successfully.",
  "status": "OK"
}

Response example for 400 

{
  "message": "Failed to update risk definitions.",
  "status": "BAD_REQUEST"
}