Skip to content

Custom Attributes Commands

Interactive wizards for adding and removing custom attributes on vulnerability objects.

Custom attributes allow you to extend the vulnerability model with additional data attributes specific to your workflow. For more information, see the Custom Attributes documentation.

add-custom-field

Interactive wizard to create a new custom attribute on the vulnerability model.

faraday-manage add-custom-field

Options

None. This command is fully interactive.

Interactive Prompts

Prompt Type Values Description
Field name String Any unique name Internal field identifier
Display name String Any unique display name Human-readable label shown in the UI
Field type Choice int, str, list Data type for the field
Field order index Integer Must be unique among existing fields Display order position
Confirmation yes/no yes to create, no to cancel Final confirmation before creating

Behavior

  1. Prompts for attribute name and display name
  2. Checks for uniqueness — both field_name and field_display_name must be unique
  3. Prompts for attribute type (integer, string, or list)
  4. Displays current custom attributes and their order indices
  5. Prompts for the order index (must be unique)
  6. Shows a summary and asks for confirmation
  7. Creates the custom attribute in the CustomFieldsSchema table

Example Session

$ faraday-manage add-custom-field
This wizard will guide you to ADD custom field to the vulnerability model.
Field name: cvss_score
Display name: CVSS Score
Field type (int, str, list): int
Custom field current order
Field Severity Level, order 1
Field order index: 2
New CustomField will be added to vulnerability -> Order 2 (cvss_score, CVSS Score, int) <- confirm to continue (yes/no): yes

Common Errors

Error Cause Solution
Custom field already exists, skipping Field name or display name already in use Choose a different name
Field order already used or invalid value Order index conflicts or is not a number Choose an unused numeric order index

delete-custom-field

Interactive wizard to delete an existing custom attribute from the vulnerability model.

faraday-manage delete-custom-field

Options

None. This command is fully interactive.

Interactive Prompts

Prompt Type Description
Attribute name String The field_name of the custom attribute to delete

Behavior

  1. Lists all existing custom attributes
  2. Prompts for the attribute name to delete
  3. If found: deletes the attribute from the database
  4. If not found: prints an error message

Example Session

$ faraday-manage delete-custom-field
This wizard will guide you to DELETE custom field to the vulnerability model.
All available custom fields are:
* cvss_score
* risk_rating
End of custom fields
Field name: cvss_score

Common Errors

Error Cause Solution
Custom field not found The specified attribute name doesn't exist Check the listed attribute names and try again

Warning

Deleting a custom attribute removes the field definition. Existing vulnerability data that used this custom attribute may become orphaned. Consider backing up your data before deleting attributes.