Kaze DaaS API Documentation

Welcome to Kaze's Daas API Documentation.

Getting Started

Once you have subscribed and obtained your API key from an email sent to you by Kaze (Please contact hello@kaze-consulting if you are having issues getting your API key), you can begin requesting data from our API endpoint.

To request the basic CVE dataset from the API, use your API key in a request as follows:

www.api.cveshield.com/api/cve_fundamental?[your-api-key]

You can make this request using a program like CURL:

curl www.api.cveshield.com/api/cve_fundamental?key=[your-api-key]

Or a programming language like Python:

request.get(api.cveshield.com/api/cve_fundamental?key=[your-api-key])

Available API's

  • cve_fundamental
  • malware_cveshield

Filters

The dataset is considerably large, therefore the API offers a number of different filters to request only the relevant data that you need:

  • Provide single or list of CVEs to search for and return the details of:

    www.api.cveshield.com/api?cve_fundamental=[your-api-key]&cve=CVE-XXXX-YYYY

  • Search for keyword in description:

    www.cveshield.com/api?cve_fundamental=[your-api-key]&keywordSearch=Microsoft

  • Filter based on published date range:

    www.cveshield.com/api?cve_fundamental=[your-api-key]&pubStartDate=2023-10-01T00:00:00.000&pubEndDate=2023-10-10T00:00:00.000

    Values must be entered in the extended ISO-8601 date/time format:

    [YYYY][“-”][MM][“-”][DD][“T”][HH][“:”][MM][“:”][SS][Z]

    The "T" is a literal to separate the date from the time. The Z indicates an optional offset-from-UTC. Please note, if a positive Z value is used (such as +01:00 for Central European Time) then the "+" should be encoded in the request as "%2B". The user agent may handle this encoding automatically.

  • Filter based on last modified date range:

    www.api.cveshield.com/api?cve_fundamental=[your-api-key]&lastModStartDate=2023-10-01T00:00:00.000&lastModEndDate=2023-10-10T00:00:00.000

    Values must be entered in the extended ISO-8601 date/time format:

    [YYYY][“-”][MM][“-”][DD][“T”][HH][“:”][MM][“:”][SS][Z]

    The "T" is a literal to separate the date from the time. The Z indicates an optional offset-from-UTC. Please note, if a positive Z value is used (such as +01:00 for Central European Time) then the "+" should be encoded in the request as "%2B". The user agent may handle this encoding automatically.

  • Search malware sha256:

    www.api.cveshield.com/api/malware_cveshield?key=[your-api-key]&top=10&is_exploit=True&hash=02b8eb6ff991fc2a66d3acf3975ddff204bee4755b1488a3ff0d606fd47dd740

    The hash search currently works for 1 or more software hashes in a list. If there are more than one sha256 then the search functionality looks for records that are a complete match.

Troubleshooting

The API can offer a number of different responses that are usually self-explanatory, but some further solutions are given in this section.

Error 404 - The end-point does not exist, check that the url correctly addresses the API endpoint www.cveshield.com/api

Getting Help

If you are experiencing any issues that you can not resolve following the troubleshooting options, get in touch at our email: hello@kaze-consulting.com