Custom Fields

Custom Fields


Custom Fields allow you to extend the Vulnerability's model with more fields. Custom fields type can be int, str, list, and choice.

You can also use Custom Fields with your Executive Report templates.

If you want to learn more about the usage of Custom Fields through Faraday's API, follow this link.

How to create Custom Fields

From Web UI

You can create/edit/delete a Custom Field from Settings. 

From Terminal

Step 1: Add Custom Field

$ faraday-manage add-custom-field

Step 2: After the command execution, you will be prompted by a wizard where you must input the following information:

  • Field name: the name of the field.

  • Display name: the display name that you will see on the Vulnerability form.

  • Type: data type of the field, it can be: int, str, list or choice.

  • Order: the order shown on the vulnerability form.

The following example will add the CVSS field to the vulnerability model:

Step 3:
After successfully creating the custom field, you will see it on the Vulnerability form:

    Still looking for answers? You can try opening a ticket.
      • Related Articles

      • Settings

        In order to make Faraday's usage smoother, we have created the Settings section. Here, you can create new Custom Fields and edit Ticketing Tools configuration. To go into Settings, click on User's menu and then click on Settings: As you can see, for ...
      • Import CSV using faraday_csv Plugin

        With faraday_csv Plugin, you can upload data to Faraday by using CSV files.  Main header: The main headers for faraday_csv Plugin are target or ip. Both columns contain the same information (host's IP). Without any of them, Faraday won't recognize ...
      • Build your own Report template

        Available Variables The data available to the Report template is: General Variables conclusions - contains the text loaded when creating the report date - the date when the Report was created, as the name of the month and four digits for the year ...
      • Faraday Manage

        Faraday Manage is a backend tool that helps us administrate Faraday's configuration. To use Faraday Manage, you can run it as follow: $ faraday-manage COMMAND If you run faraday-manage, it will list all the available commands. Available Commands ...
      • JIRA

        [This feature is only available for Corporate version users] This is a feature that allows you to send vulnerabilities from Faraday to JIRA. Send vulnerability to JIRA To send vulnerabilities to JIRA, go into the Status Report section, select the ...