Schema Reference for Audit Configurations

The following table containers the top-level field reference for the audit configuration. For the full schema, refer to the POST /v1beta1/audit/configs endpoint on the Auditor API page.

Field	Description	Default Value
name	Specifies the name of the audit config. Names must be unique within a namespace. The maximum length is 250 characters.	None (Required)
namespace	Specifies the namespace for the audit config. The maximum length is 250 characters.	None (Required)
plugins	Specifies the options for the audit, such as the probes to run. A common customization is to specify the probes to run in the plugins.probe_spec field. Refer to Probe Reference Summary to view all the probes. By default, Auditor runs all the probes identified as default in the probe reference summary. An alternative to specifying probes or probe families is to specify a tag in the run.probe_tags field. Refer to Probe Tags Reference for more information. The model_type, model_name, and generator fields are ignored. These fields are populated by the audit target that you specify when you run the audit job.	None
reporting	Specifies the reporting options for the audit, such as show_100_pass_modules that controls whether to include entries that scored 100% in the report. Refer to Configuring garak in the garak documentation for the subfields.	None
run	Specifies the run-specific settings, such as the seed, for the scan. As an alternative to specifying probes, you can specify probe tags in the run.probe_tags field. Refer to Probe Tags Reference to view the tags and associated probes. If you specify plugins.probe_spec and run.probe_tags, the probes specified in the probe_spec are filtered to the probes that also match the tags. Refer to Configuring garak in the garak documentation for other subfields.	None
system	Specifies the settings related to how the system performs the scan, such as the max_workers. Refer to Configuring garak in the garak documentation for the subfields.	None

Tip

You can fetch the default configuration to view the subfields for each field.