compliance

Compliance audits and policies.

• Toolset name: compliance

• Enabled by default: yes

• Tools: 13 (4 read-only)

Tools

openvas_create_audit

Create audit · mutating

Create a compliance audit binding a target, a policy (as scan_config_id) and a scanner. Returns the new audit’s UUID.

Parameter	Type	Required	Description
agent_group_id	string	no	UUID of the agent group (agentGroup tasks)
alert_ids	array	no	Optional alert UUIDs to attach
alterable	boolean	no	Whether the task stays modifiable after the first run
comment	string	no	Optional comment
name	string	yes	Task name
observers	array	no	Login names of users allowed to observe the task
oci_image_target_id	string	no	UUID of the OCI image target (ociImage tasks)
preferences	object<string, string>	no	Key-value scan preferences, e.g. {“max_checks”: “4”}
scan_config_id	string	no	UUID of the scan config (required for classic tasks, rejected for other variants)
scanner_id	string	no	UUID of the scanner (required for every non-import task)
schedule_id	string	no	Optional schedule UUID
schedule_periods	integer	no	Number of schedule periods to run (0 = unlimited)
target_id	string	no	UUID of the scan target (classic tasks)
type	string	no	Task variant: “classic” (default; host target + scan config), “agentGroup”, “ociImage”, “webApplication” or “import” (a container task for openvas_import_report that accepts only name/comment). Non-classic variants are inferred from their selector when omitted.
web_application_target_id	string	no	UUID of the web application target (webApplication tasks)

openvas_create_policy

Create policy · mutating

Create a compliance policy as a copy of an existing one. Not idempotent.

Parameter	Type	Required	Description
base_policy_id	string	yes	UUID of the active policy to copy from (see openvas_list_policies)
comment	string	no	Optional comment
name	string	yes	Policy name

openvas_delete_audit

Delete audit · destructive

Delete a compliance audit.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_delete_policy

Delete policy · destructive

Delete a compliance policy. Fails with 409 if an audit still uses it.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_get_audit

Get audit · read-only

Get one compliance audit by UUID.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_get_policy

Get policy · read-only

Get one compliance policy by UUID.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_list_audits

List audits · read-only

List compliance audits with status and progress.

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)

openvas_list_policies

List policies · read-only

List compliance policies (audit scan configurations).

Parameter	Type	Required	Description
filter	string	no	GMP filter expression, e.g. name~webserver and severity>5
filter_id	string	no	UUID of a saved filter to apply
page	integer	no	Page number, 1-indexed (default 1) (min 0)
per_page	integer	no	Items per page, 1-1000 (default 25) (min 0)

openvas_resume_audit

Resume audit · mutating

Resume a stopped compliance audit. Returns the report UUID.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_start_audit

Start audit · mutating

Start a compliance audit. Returns the UUID of the report it writes to.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_stop_audit

Stop audit · mutating

Stop a running compliance audit.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_update_audit

Update audit · destructive

Update a compliance audit. Idempotent (PUT): omitted fields stay unchanged.

Parameter	Type	Required	Description
alert_ids	array	no	Replacement alert UUIDs
alterable	boolean	no
comment	string	no
id	string	yes	UUID of the task to update
name	string	no
observers	array	no	Replacement observer login names
preferences	object<string, string>	no	Key-value scan preferences
scan_config_id	string	no	Replacement scan config UUID
scanner_id	string	no	Replacement scanner UUID
schedule_id	string	no	Replacement schedule UUID
schedule_periods	integer	no
target_id	string	no	Replacement target UUID

openvas_update_policy

Update policy · destructive

Rename or re-comment a compliance policy. Idempotent (PUT).

Parameter	Type	Required	Description
comment	string	no
id	string	yes	UUID of the policy to update
name	string	no