VulnIQ API Documentation
- Constants
- API responses
- Interactive API documentation (Swagger UI)
Constants
VulnIQ uses integer constants for various enum values. Data returned by API endpoints may contain these numerical constants instead of more user friendly strings.Data Type Constants
| 1 | CVE |
| 10 | CPE |
| 20 | CWE |
| 21 | CAPEC |
| 30 | CVRF |
| 50 | OVAL |
| 100 | URL |
| 200 | Git Commit |
| 300 | |
| 400 | RSS Feed |
| 500 | Tweet |
| 600 | Other Stix Type |
| 601 | Attack Pattern (Stix) |
| 602 | Campaign (Stix) |
| 603 | Course Of Action (Stix) |
| 604 | Identity (Stix) |
| 605 | Indicator (Stix) |
| 606 | Intrusion Set (Stix) |
| 607 | Malware (Stix) |
| 608 | Observed Data (Stix) |
| 609 | Report (Stix) |
| 610 | Threat Actor (Stix) |
| 611 | Tool (Stix) |
| 612 | Vulnerability (Stix) |
| 620 | Relationship (Stix) |
| 621 | Sighting (Stix) |
| 651 | Tactic (Mitre Stix) |
| 652 | Matrix (Mitre Stix) |
| 721 | Red Hat CVE |
| 725 | Red Hat RPM CVE Mapping |
| 751 | Youtube Video |
| 1100 | Microsoft KB Article |
| 1110 | Microsoft CVE Article |
| 1200 | Metasploit Module |
| 1201 | Metasploit Exploit |
| 1202 | Metasploit Auxillary Module |
| 1203 | Metasploit Payload |
| 1204 | Metasploit Encoder |
| 1250 | Nessus Plugin |
| 1301 | Github Issue |
| 1302 | Github Pull Request |
| 1310 | Github Advisory |
Data Source Type Constants
| 1 | CVE feed in NVD JSON format |
| 10 | Gmail Account |
| 20 | Git Repository |
| 101 | Red Hat Feeds (in CVRF format ) |
| 102 | Oracle Feed (in CVRF format) |
| 103 | SUSE Feed (in CVRF format) |
| 104 | Cisco Feed (in CVRF format) |
| 105 | Microsoft Feeds (in CVRF format) |
| 200 | Mitre CWE XMLs |
| 201 | Mitre CAPEC XMLs |
| 250 | OVAL - CIS |
| 251 | OVAL - Debian |
| 252 | OVAL - Red Hat |
| 253 | OVAL - Oracle EL |
| 254 | OVAL - Suse |
| 255 | OVAL - Ubuntu |
| 500 | Github Issues and Pull Requests |
| 550 | Github Advisories |
| 700 | Metasploit Modules |
| 600 | Mitre Cyber Threat Intelligence Repository |
| 850 | Microsoft SUG |
| 2500 | Nessus Plugins |
| 801 | NVD CPE Feed |
| 720 | Red Hat CVE Advisories |
| 725 | Red Hat RPM-CVE Mappings |
| 2000 | RSS/Atom feed |
| 1000 | Webpage/website |
| 30 | |
| 780 | Youtube |
VulnIQ Score Constants
| 0 | Unknown |
| 1 | None |
| 2 | Low |
| 3 | Medium |
| 4 | High |
| 5 | Critical |
Author Type Constants
| 0 | Generic |
| 1 | |
| 2 | |
| 3 | URL |
API Responses
Most VulnIQ APIs return json objects. Typically responses for */list methods has one of the following structures:Lists with totalNumberOfResults
These lists return the total number of results in the response and typically have the following fields in the response.
- limit: Max number of results per response, limit as in an sql query.
- offset: The index for the first result in the response. offset as in an sql query.
- orderBy: Order by field
- sort: Sort direction
- totalNumberOfResults: Total number of matches/results
- results: An array of entries as json objects
Lists with hasMore
These lists does not return the total number of results in the response, but they contain a hasMore field in the response.
When true, hasMore indicates that there are more results for the query than returned in the current response.
- limit: Max number of results per response, limit as in an sql query.
- offset: The index for the first result in the response. offset as in an sql query.
- orderBy: Order by field
- sort: Sort direction
- results: An array of entries as json objects
- hasMore: If there are more results or not