opnsense-docs/source/development/api/plugins/clamav.rst

Clamav
~~~~~~

.. csv-table:: Resources (GeneralController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40

    "``GET``","clamav","general","get",""
    "``POST``","clamav","general","set",""

    "``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/security/clamav/src/opnsense/mvc/app/models/OPNsense/ClamAV/General.xml>`__"

.. csv-table:: Service (ServiceController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40

    "``POST``","clamav","service","freshclam",""
    "``POST``","clamav","service","reconfigure",""
    "``POST``","clamav","service","restart",""
    "``POST``","clamav","service","start",""
    "``GET``","clamav","service","status",""
    "``POST``","clamav","service","stop",""
    "``GET``","clamav","service","version",""

.. csv-table:: Resources (UrlController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40

    "``POST``","clamav","url","add_url",""
    "``POST``","clamav","url","del_url","$uuid"
    "``GET``","clamav","url","get",""
    "``GET``","clamav","url","get_url","$uuid=null"
    "``GET,POST``","clamav","url","search_url",""
    "``POST``","clamav","url","set",""
    "``POST``","clamav","url","set_url","$uuid"
    "``POST``","clamav","url","toggle_url","$uuid"

    "``<<uses>>``", "", "", "", "*model* `Url.xml <https://github.com/opnsense/plugins/blob/master/security/clamav/src/opnsense/mvc/app/models/OPNsense/ClamAV/Url.xml>`__"
API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 10:11:37 -05:00			`Clamav`
restructure api doc section https://github.com/opnsense/docs/pull/24 as agreed with @fvanroie 2018-05-06 09:25:26 -04:00			`~~~~~~`

api update: plugins 2025-05-01 04:05:15 -04:00			`.. csv-table:: Resources (GeneralController.php)`
api: update plugins 2021-03-08 06:22:26 -05:00			`:header: "Method", "Module", "Controller", "Command", "Parameters"`
			`:widths: 4, 15, 15, 30, 40`

			"``GET``","clamav","general","get",""
API docs - update using script 2022-10-19 11:21:08 -04:00			"``POST``","clamav","general","set",""
api: update plugins 2021-03-08 06:22:26 -05:00
			"``<<uses>>``", "", "", "", "model `General.xml <https://github.com/opnsense/plugins/blob/master/security/clamav/src/opnsense/mvc/app/models/OPNsense/ClamAV/General.xml>`__"

API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 10:11:37 -05:00			`.. csv-table:: Service (ServiceController.php)`
restructure api doc section https://github.com/opnsense/docs/pull/24 as agreed with @fvanroie 2018-05-06 09:25:26 -04:00			`:header: "Method", "Module", "Controller", "Command", "Parameters"`
			`:widths: 4, 15, 15, 30, 40`

API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 10:11:37 -05:00			"``POST``","clamav","service","freshclam",""
API docs - update using script 2022-10-19 11:21:08 -04:00			"``POST``","clamav","service","reconfigure",""
			"``POST``","clamav","service","restart",""
			"``POST``","clamav","service","start",""
api: update plugins 2021-03-08 06:22:26 -05:00			"``GET``","clamav","service","status",""
API docs - update using script 2022-10-19 11:21:08 -04:00			"``POST``","clamav","service","stop",""
API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 10:11:37 -05:00			"``GET``","clamav","service","version",""
restructure api doc section https://github.com/opnsense/docs/pull/24 as agreed with @fvanroie 2018-05-06 09:25:26 -04:00
API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 10:11:37 -05:00			`.. csv-table:: Resources (UrlController.php)`
restructure api doc section https://github.com/opnsense/docs/pull/24 as agreed with @fvanroie 2018-05-06 09:25:26 -04:00			`:header: "Method", "Module", "Controller", "Command", "Parameters"`
			`:widths: 4, 15, 15, 30, 40`

development/api - camel to snake case for commands and update endpoints. 2025-04-29 14:00:06 -04:00			"``POST``","clamav","url","add_url",""
			"``POST``","clamav","url","del_url","$uuid"
api: update plugins 2021-03-08 06:22:26 -05:00			"``GET``","clamav","url","get",""
development/api - camel to snake case for commands and update endpoints. 2025-04-29 14:00:06 -04:00			"``GET``","clamav","url","get_url","$uuid=null"
api doc: fix method sort order 2025-05-01 07:06:32 -04:00			"``GET,POST``","clamav","url","search_url",""
API docs - update using script 2022-10-19 11:21:08 -04:00			"``POST``","clamav","url","set",""
development/api - camel to snake case for commands and update endpoints. 2025-04-29 14:00:06 -04:00			"``POST``","clamav","url","set_url","$uuid"
			"``POST``","clamav","url","toggle_url","$uuid"
API: plugins, add models for standard templates. 2020-04-07 14:48:40 -04:00
			"``<<uses>>``", "", "", "", "model `Url.xml <https://github.com/opnsense/plugins/blob/master/security/clamav/src/opnsense/mvc/app/models/OPNsense/ClamAV/Url.xml>`__"