Basic Parameters
| Parameter | Description |
|---|---|
| Company ID | The ID of the company. |
| End Date | The date to filter vulnerabilities to. |
| Group By | Select the field to group results by. |
| Limit | The maximum number of results to return per page. Maximum value is 1000. |
| Page | The page number to return. Starts at 1. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Sort By | Select the field to sort results by. |
| Sort Desc | Select to sort results in descending order. |
| Start Date | The date to filter vulnerabilities from. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Affected Software | A comma-separated list of affected software to filter results by. |
| Alarm ID | A comma-separated list of alarm IDs to filter results by. |
| Asset | A comma-separated list of assets to filter results by. |
| Product Type | Select the product types to filter results by. |
| Scan Type | Select the scan types to filter results by. |
| Search Text | A comma-separated list of free-text terms to filter results by. |
| Vuln Type | Select the vulnerability types to filter results by. |
| Vulnerability | A comma-separated list of vulnerabilities to filter results by. |
| Vulnerability Severity | Select the vulnerability severities to filter results by. |
| Vulnerability Status | Select the vulnerability statuses to filter results by. |
| Vulnerability Status Reason | Select the vulnerability status reasons to filter results by. |
Example Output
{
"data": {
"pagination": {
"current_page": 1,
"total_count": 3142,
"total_pages": 1571
},
"records": [
{
"affected_software": "string",
"alarm_comments": [
{}
],
"alarm_id": 75695390,
"alarm_status": "OPEN",
"asset": "194.233.68.76",
"asset_id": 9526219,
"cvss": 2.2,
"extra_info": {
"cve_product": {
"config_number": 0,
"cpe": "cpe:2.3:a:oracle:mysql:-:*:*:*:*:*:*:*",
"cpe_for_fulltext": "cpe:2.3:a:oracle:mysql: :*:*:*:*:*:*:*",
"icon_path": "string",
"product": "mysql",
"vendor": "oracle",
"version": "-"
},
"history": [
{
"action": "OPEN",
"date": "2025-11-06 09:23",
"description": "Company Vulnerability Finding was discovered.",
"note": "string",
"reason": "OPEN",
"user": "test.user@testcompany.com"
}
],
"port": "3306",
"severity": "LOW"
},
"id": 8082453,
"scan_result": {
"Asset": "194.233.68.76",
"CVE": "CVE-2024-21232, CVE-2024-21243, CVE-2024-21244",
"CVSS3 Score": "2.2",
"CVSS3 Vector": "CVSS:3.1/AV:N/AC:H/PR:H/UI:N/S:U/C:L/I:N/A:N",
"Ports": "3306"
},
"scan_type": "ACTIVE",
"vulnerability": "CVE-2024-21243",
"vulnerability_date": "Thu, 06 Nov 2025 08:55:57 GMT",
"vulnerability_status": "OPEN"
}
]
},
"is_success": true,
"message": "Success",
"response_code": 200
}
Workflow Library Example
List Vulnerabilities with Socradar and Send Results Via Email