AttackForge Enterprise & AttackForge Core
Powered By GitBook
UpdateVulnerabilityById
This method can be used for the following functionality: Update a vulnerability this user has access to, by vulnerability identifier (Id).

Parameters

The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.

Headers

1
PUT /api/ss/vulnerability/:id HTTP/1.1
2
Host: demo.attackforge.com
3
X-SSAPI-KEY: APIKey
4
Content-Type: application/json
5
Connection: close
Copied!

Query

id (string)
Identifier for the vulnerability.
Example:
1
PUT /api/ss/vulnerability/5e7afb0be7aa1b0f20eb62fe HTTP/1.1
Copied!
title (string) (optional)
Title for the vulnerability.
Example:
1
{
2
"title": "..."
3
}
Copied!
priority (string) (optional)
Priority for the vulnerability. Must be one of the following: Critical, High, Medium, Low, Info
Example:
1
{
2
"priority": "Critical"
3
}
Copied!
status (string) (optional)
Status for the vulnerability. Must be one of the following: Open, Closed, Retest
Example:
1
{
2
"status": "Closed"
3
}
Copied!
likelihood_of_exploitation (number) (optional)
Likelihood of Exploitation for the vulnerability. Must be a number between 1 to 10.
Example:
1
{
2
"likelihood_of_exploitation": 10
3
}
Copied!
description (string) (optional)
Description of the vulnerability.
Example:
1
{
2
"description": "..."
3
}
Copied!
attack_scenario (string) (optional)
Attack Scenario for the vulnerability.
Example:
1
{
2
"attack_scenario": "..."
3
}
Copied!
remediation_recommendation (string) (optional)
Remediation Recommendation for the vulnerability.
Example:
1
{
2
"remediation_recommendation": "..."
3
}
Copied!
steps_to_reproduce (string) (optional)
Steps to Reproduce the vulnerability (POC).
Example:
1
{
2
"steps_to_reproduce": "..."
3
}
Copied!
tags (array of strings) (optional)
Tags for the vulnerability.
Example:
1
{
2
"tags": ["...", "...", "..."]
3
}
Copied!
notes (array of strings) (optional)
Notes for the vulnerability.
Example:
1
{
2
"notes": ["...", "...", "..."]
3
}
Copied!
is_zeroday (boolean) (optional)
Whether vulnerability is a zeroday (0-day) or not.
Example:
1
{
2
"is_zeroday": true
3
}
Copied!
is_visible (boolean) (optional)
Whether vulnerability is visible to the project team (true) or only team members with Edit access (false).
Example:
1
{
2
"is_visible": true
3
}
Copied!
is_deleted (boolean) (optional)
Whether vulnerability is deleted or not.
Example:
1
{
2
"is_deleted": false
3
}
Copied!

Example

The following example is a cURL request to update a vulnerability by its identifier (Id).

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
1
curl -X PUT 'https://demo.attackforge.com/api/ss/vulnerability/5e7afb0be7aa1b0f20eb62fe' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
2
"title": "SQL Injection",
3
"priority": "Critical",
4
"status": "Open",
5
"likelihood_of_exploitation": 10,
6
"description": "Lorem Ipsum...",
7
"attack_scenario": "Lorem Ipsum...",
8
"remediation_recommendation": "Lorem Ipsum...",
9
"steps_to_reproduce": "Lorem Ipsum...",
10
"tags": ["CWE-89", "Injection"],
11
"notes": ["Lorem Ipsum...", "Lorem Ipsum..."],
12
"is_zeroday": false,
13
"is_visible": true,
14
"is_deleted": false
15
}'
Copied!

Response

Response contains a result object.
1
{
2
"result": {
3
"result": "Vulnerability Updated"
4
}
5
}
Copied!
Last modified 1yr ago