Meta Fields can store additional data which doesnt fit into the usual field of the security test data model. It basically a string to string map / object / dictionary or howerver you would call it.

We have encountered some data values which we found paticulary usefull and standardized their format to be used in multiple places. These values can then be used by standerdized components e.g. by the DefectDojo persistence, pefilling engagment details with information about the build server and test environment

Note: None of these values are mandatory.

Here's a example of a SecurityTest (see the PUT /box/securityTests endpoint) which Metadata Field set:

[
  {
    "name": "nmap",
    "context": "exampleCompoanyNetworkScan",
    "tenant": "exampleCompoany",
    "metaData": {
      "location": "office-gotham-city",
      "vlan": "vm-network"
    },
    "target": {
      "name": "gotham-city-offices",
      "location": "192.168.42.0/24",
      "attributes": {
        "NMAP_PARAMETER": ""
      }
    }
  }
]

In this example the meta data fields are used to identify the context of the scan more directly than using the string context field. When also using the elasticsearch persistence proivder these fields can be extremly helpfull to easily filter for the sub results you want to have. E.g. only show ports in the office-gotham-city or in particular vlans. How you end up using the metadata fields is up to you.