API GUIDE

SecBuzzer REST API


Introduction

SecBuzzer REST API is a threat intelligence platform which offers the latest cyber security threat intelligence integrated from various sources.

You can use SecBuzzer REST API to retrieve different types of threat profiles, and to get the newly-published threat intelligence with in-depth security analytic features.

We provide the following APIs:

Vulnerability API

Vulnerability API provides the integrated features of software vulnerabilities from various sources such as NVD, CVE detail, VulDB, Twitter, and CERT. You can type in CVE number to retrieve the associated information or get the default information about the latest/popular/critical CVEs.

Interactive Documentation

Our Documentation uses the open source Swagger Tools which provides interactive API Documentation.

Authentication

To use Our APIs, you have to sign up first to get your personal API key. As soon as you completed and submitted the sign up form with correct email address, the individual API key will be sent to your email account directly.

If your individual API key got stolen and abused, please contact our support team immediately.

Access Rate Limiting

The API access is limited by the amount of requests you made within a certain period of time. The maximum number of requests you can make is 30 requests per minute, and 100 requests per month.

The moment you have reached the request limitation for your API access, further access is denied until the counter is reset.

Response

After you made a request, the API will response you with the results as JSON structure.

Moreover, every response contains HTTP status code of the processed request. The HTTP status code consists of a 3-digit number that shows the status of the response of your HTTP request. The most commonly used API status codes are:

Http code Definition
200 OK
204 No content
400 Parameter Validation Error
401 Unauthorized Access
429 Rate Limiting exceeded

Example

Here is a sample Python script that using Python Request library to connect with SecBuzzer REST API.

						
    import sys
    import json
    import requests
    
    API_URL = "https://api.secbuzzer.co"
    APIKEY = "Your API key"
    auth_header = {"authorization": APIKEY}
    res = requests.get(API_URL + "/openapi/vulnerability", headers = auth_header)
    
    if res.status_code != 200:
        print "error code: %s" % res.status_code
        sys.exit(1)
    
    res_json = res.json()
    for key in res_json:
        print key, ":", res_json[key]