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.
Copy GET /api/ss/vulnerability/:id HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close
Identifier for the vulnerability.
Copy GET /api/ss/vulnerability/5e573d3ed1484a0c155f3732 HTTP/1.1
Returns custom fields and custom tags in alternative format.
Copy "vulnerability_custom_fields": {
"fields": {
"key": "value"
},
"tags": {
"key": "value"
}
}
Copy GET /api/ss/vulnerability/5e573d3ed1484a0c155f3732?altCustomFields=true HTTP/1.1
Return pending vulnerability.
Copy GET /api/ss/vulnerability/5e573d3ed1484a0c155f3732?pending=true HTTP/1.1
The following example is a cURL request to get a vulnerability by its identifier (Id).
Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
Copy curl -X GET 'https://demo.attackforge.com/api/ss/vulnerability/5e573d3ed1484a0c155f3732' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'
Response contains a vulnerability object.
Copy {
"vulnerability": {
"vulnerability_id": "...",
"vulnerability_alternate_id": "...",
"vulnerability_created": "...",
"vulnerability_modified": "...",
"vulnerability_title": "...",
"vulnerability_priority": "...",
"vulnerability_cvssv3_vector": "...",
"vulnerability_cvssv3_base_score": "...",
"vulnerability_cvssv3_temporal_score": "...",
"vulnerability_cvssv3_environmental_score": "...",
"vulnerability_status": "...",
"vulnerability_status_updated": "...",
"vulnerability_retest": "...",
"vulnerability_likelihood_of_exploitation": 10,
"vulnerability_steps_to_reproduce": "...",
"vulnerability_steps_to_reproduce_HTML": "...",
"vulnerability_tags": [
"..."
],
"vulnerability_is_zeroday": "...",
"vulnerability_notes": [
{
"note": "...",
"note_html": "...",
"type": "PLAINTEXT/RICHTEXT"
}
],
"vulnerability_description": "...",
"vulnerability_attack_scenario": "...",
"vulnerability_remediation_recommendation": "...",
"vulnerability_remediation_notes": [
{
"note": "...",
"note_html": "...",
"created": "...",
"created_by": "..."
}
],
"vulnerability_affected_asset_name": "...",
"vulnerability_affected_asset_id": "...",
"vulnerability_affected_asset_library_id": "...",
"vulnerability_affected_asset_library_external_id": "...",
"vulnerability_affected_assets": [
{
"asset": {
"id": "...",
"name": "...",
"library_id": "...",
"library_external_id": "...",
"custom_fields": [
{
"key": "...",
"value": "...",
"type": "Field"
}
],
},
"notes": [
"..."
],
"tags": [
"..."
],
"actioned": true,
"components": [
{
"name": "...",
"notes": [
"..."
],
"tags": [
"..."
]
}
]
}
],
"vulnerability_projects" : [
{
"code" : "...",
"custom_fields" : [
{
"key" : "...",
"type" : "Field/Tag",
"value" : "..."
}
],
"groups": [
{
"id": "...",
"name": "..."
}
],
"id" : "...",
"name" : "..."
}
],
"vulnerability_discovered_by": "...",
"vulnerability_evidence": [
{
"file_name": "...",
"file_name_custom": "...",
"storage_name": "...",
"file_type": "...",
"file_size_kb": "..."
}
],
"vulnerability_custom_fields": [
{
"key": "...",
"value": "...",
"type": "Tag/Field"
}
],
"vulnerability_library_custom_fields": [
{
"key": "...",
"value": "...",
"type": "Tag/Field"
}
],
"vulnerability_affected_asset_custom_fields": [
{
"key": "...",
"value": "..."
}
],
"vulnerability_sla": "...",
"vulnerability_release_date": "...",
"vulnerability_target_remediation_date": "...",
"vulnerability_user": {
"user_id": "...",
"first_name": "...",
"last_name": "..."
},
"vulnerability_testcases": ["..."]
}
}