schedules

Scan schedules.

• Toolset name: schedules

• Enabled by default: yes

• Tools: 5 (2 read-only)

Tools

openvas_create_schedule

Create schedule · mutating

Create a scan schedule from an iCalendar definition. Not idempotent: repeating the call creates duplicates.

Parameter	Type	Required	Description
comment	string	no	Optional comment
icalendar	string	yes	iCalendar (RFC 5545) definition, e.g. a VEVENT with RRULE
name	string	yes	Schedule name
timezone	string	yes	IANA timezone, e.g. “UTC” or “Europe/Istanbul”

openvas_delete_schedule

Delete schedule · destructive

Delete a scan schedule (to the trashcan by default; ultimate deletes permanently). Fails with 409 if a task still uses it.

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

openvas_get_schedule

Get schedule · read-only

Get one schedule by UUID, including its iCalendar definition.

Parameter	Type	Required	Description
id	string	yes	Resource UUID

openvas_list_schedules

List schedules · read-only

List scan schedules with their next run times.

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_update_schedule

Update schedule · destructive

Update a scan schedule. Idempotent (PUT): omitted fields stay unchanged.

Parameter	Type	Required	Description
comment	string	no
icalendar	string	no	Replacement iCalendar (RFC 5545) definition
id	string	yes	UUID of the schedule to update
name	string	no
timezone	string	no	Replacement IANA timezone