1. Home
  2. Docs
  3. API Documentation
  4. Vulnerabilities
  5. GetVulnByName

GetVulnByName

Route: https://api.cytrix.io/GetVulnByName

Using this feature will allow you to view a certain Vulnerability.

Note : deleting a certain scan will also delete the vulnerabilities from the database which prevents you from viewing them.

Roles Required: Admin and User. Private Users can only View Vulnerabilities from Scans they created.

Request Syntax

{
    "apiKey": "String",
    "vulnName": "String"
}

Request Parameters

Parameters being used in the Request

Parameter Name :

apiKey

Parameter Usage and Options :

Your CYTRIX given API Key.

How do I get it ? :

Located in the “Profile” section.

Note : by default, the “API Status” is enabled, unless, the Admin has disabled it in the “Server Settings” section.

Type :

String

Is it Optional ? :

No.


Parameter Name :
vulnName

Parameter Usage and Options :

Name of the requested vulnerability.

Type :

String

Is it Optional ? :

No.


Successful Response



{
    "Error": 0,
    "Function": "GetVulnById",
    "Data": {
        "id": 92456,
        "id_connection": "123456",
        "url": "https://example.com/",
        "action": "https://example.com/",
        "vuln_name": "CSP header not implemented",
        "severity": "Low",
        "request": "GET /...",
        "response": "HTTP/1.1 200 OK\...",
        "key": "https://example.com/",
        "payload": "",
        "method": "GET",
        "params": "",
        "cookies": "None",
        "headers": "Headers({'...",
        "status_code": "123",
        "content_type": "",
        "fixed": "0",
        "token": "String",
        "img": "/",
        "version": "",
        "description": "During the scan, CYTRIX managed to find ...",
        "recommendation": "...",
        "links": "...",
        "more_details": ""
    }
}

Errors and their Possible Causes

For more information, please refer to the General Errors section.