tasks

Scan tasks and their lifecycle (start/stop/resume/clone).

• Toolset name: tasks

• Enabled by default: yes

• Tools: 9 (2 read-only)

Tools

openvas_clone_task

Clone task · mutating

Clone a scan task (configuration only, no reports). Returns the UUID of the copy.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_create_task

Create task · mutating

Create a scan task. Classic tasks bind a target, scan config and scanner; other variants use their own selector (agent group, OCI image target, web application target); type: "import" creates a container task for report imports. Returns the new task’s UUID; the task is not started automatically.

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_delete_task

Delete task · destructive

Delete a scan task (to the trashcan by default; ultimate deletes permanently).

Parameter	Type	Required	Description
id	string	yes	Resource UUID
ultimate	boolean	no	Permanently delete instead of moving to the trashcan (default false)

openvas_get_task

Get task · read-only

Get one scan task by UUID, including scan config, scanner, schedule and report references.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_list_tasks

List tasks · read-only

List scan tasks with status and progress. Returns summarized rows plus pagination; use openvas_get_task for full details of one task.

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_task

Resume task · mutating

Resume a stopped scan task. Returns the UUID of the report the resumed run writes to.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_start_task

Start task · mutating

Start a scan task. Returns the UUID of the report the run writes to.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_stop_task

Stop task · mutating

Stop a running scan task.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_update_task

Update task · destructive

Update a scan task’s bindings or metadata. Idempotent (PUT): omitted fields stay unchanged; fails with 409 while the task is running.

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