WELCOME
Introduction
Elevate your security applications with firmware API offerings – your gateway to enhanced security, safeguarding beneath the OS. Azgaurd API is available for you to try out as endpoints are released. Use this API when you find endpoints that correspond to your needs according to your own workflow.
Base URL
The base URL is the starting point for all API requests. It specifies the root domain and version of the API.
Authentication
To use this API, you must get your API token from Azgaurd. When using the API directly, provide the API token in an Authorization header.
Firmware
Firmware is permanent software in hardware devices, connecting high-level firmware and hardware functions for proper operation. It handles tasks like initialization and communication, and updates can enhance features and fix issues.
GET AFFESTED CVEs
This endpoint retrieves a list of Common Vulnerabilities and Exposures (CVEs) that are affecting a given firmware product. The company name, firmware name, and version need to be provided in the request parameters.
- Endpoint: firmware/affected_cves
- Method: GET
- Parameters
| Parameter | Type | Description |
|---|---|---|
| company | String | Name of the manufacturer |
| firmware | String | Name of the firmware. |
| version | String | Version of the firmware. |
GET AFFECTED FIRMWARES
This endpoint retrieves a list of firmware products affected by a specific CVE. It provides information about the products and vendors impacted by the CVE.
- Endpoint: firmware/affected_firmwares
- Method: GET
- Parameters
| Parameter | Type | Description |
|---|---|---|
| cve | String | CVE identifier |
GET FIXED VERSION
This endpoint retrieves the minimum fixed version of a firmware product for given company, firmware and CVE. It provides the version number that addresses the vulnerability.
- Endpoint: firmware/fixed_version
- Method: GET
- Parameters
| Parameter | Type | Description |
|---|---|---|
| company | String | Name of the manufacturer |
| firmware | String | Name of the firmware. |
| cve | String | CVE identifier |
GET TARGET FIX DATE
This endpoint retrieves the target availability date for a fix related to a given firmware and CVE combination. It provides information about when the patch is expected to be available.
- Endpoint: firmware/target_fix_date
- Method: GET
- Parameters
| Parameter | Type | Description |
|---|---|---|
| firmware | String | Name of the firmware. |
| cve | String | CVE identifier |
cURL
https://api.azgaurd.com/api/v1
cURL
curl -H "Authorization:YOUR_API_KEY" https://api.azgaurd.com/api/v1/endpoint
cURL
curl --location 'https://api.azgaurd.com/api/v1/ firmware/affected_cves?company=dell &firmware=Alienware%2520m15%2520R7&version=01.17.00'
cURL
curl --location 'https://api.azgaurd.com/api/v1/firmware/affected_firmwares?cve=CVE-2023-0286'
cURL
curl --location 'https://api.azgaurd.com/api/v1/firmware/fixed_version?company=dell&firmware=Alienware%2520m15%2520R7&cve=CVE-2023-0286'
cURL
curl --location 'https://api.azgaurd.com/api/v1/firmware/target_fix_date?company=dell&firmware=Alienware%2520m15%2520R7&version=01.17.00'