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

Tor
~~~

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

    "``POST``","tor","exitacl","addacl",""
    "``POST``","tor","exitacl","delacl","$uuid"
    "``GET``","tor","exitacl","get",""
    "``GET``","tor","exitacl","getacl","$uuid=null"
    "``GET,POST``","tor","exitacl","searchacl",""
    "``POST``","tor","exitacl","set",""
    "``POST``","tor","exitacl","setacl","$uuid"
    "``POST``","tor","exitacl","toggleacl","$uuid"

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

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

    "``POST``","tor","general","addhidservauth",""
    "``POST``","tor","general","delhidservauth","$uuid"
    "``GET``","tor","general","get",""
    "``GET``","tor","general","gethidservauth","$uuid=null"
    "``GET,POST``","tor","general","searchhidservauth",""
    "``POST``","tor","general","set",""
    "``POST``","tor","general","sethidservauth","$uuid"
    "``POST``","tor","general","togglehidservauth","$uuid"

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

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

    "``POST``","tor","hiddenservice","addservice",""
    "``POST``","tor","hiddenservice","delservice","$uuid"
    "``GET``","tor","hiddenservice","get",""
    "``GET``","tor","hiddenservice","getservice","$uuid=null"
    "``GET,POST``","tor","hiddenservice","searchservice",""
    "``POST``","tor","hiddenservice","set",""
    "``POST``","tor","hiddenservice","setservice","$uuid"
    "``POST``","tor","hiddenservice","toggleservice","$uuid"

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

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

    "``POST``","tor","hiddenserviceacl","addacl",""
    "``POST``","tor","hiddenserviceacl","delacl","$uuid"
    "``GET``","tor","hiddenserviceacl","get",""
    "``GET``","tor","hiddenserviceacl","getacl","$uuid=null"
    "``GET,POST``","tor","hiddenserviceacl","searchacl",""
    "``POST``","tor","hiddenserviceacl","set",""
    "``POST``","tor","hiddenserviceacl","setacl","$uuid"
    "``POST``","tor","hiddenserviceacl","toggleacl","$uuid"

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

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

    "``GET``","tor","relay","get",""
    "``POST``","tor","relay","set",""

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

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

    "``GET``","tor","service","circuits",""
    "``GET``","tor","service","get_hidden_services",""
    "``POST``","tor","service","reconfigure",""
    "``POST``","tor","service","restart",""
    "``POST``","tor","service","start",""
    "``GET``","tor","service","status",""
    "``POST``","tor","service","stop",""
    "``GET``","tor","service","streams",""

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

    "``POST``","tor","socksacl","addacl",""
    "``POST``","tor","socksacl","delacl","$uuid"
    "``GET``","tor","socksacl","get",""
    "``GET``","tor","socksacl","getacl","$uuid=null"
    "``GET,POST``","tor","socksacl","searchacl",""
    "``POST``","tor","socksacl","set",""
    "``POST``","tor","socksacl","setacl","$uuid"
    "``POST``","tor","socksacl","toggleacl","$uuid"

    "``<<uses>>``", "", "", "", "*model* `ACLSocksPolicy.xml <https://github.com/opnsense/plugins/blob/master/security/tor/src/opnsense/mvc/app/models/OPNsense/Tor/ACLSocksPolicy.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			`Tor`
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 (ExitaclController.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``","tor","exitacl","addacl",""
			"``POST``","tor","exitacl","delacl","$uuid"
api: update plugins 2021-03-08 06:22:26 -05:00			"``GET``","tor","exitacl","get",""
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``","tor","exitacl","getacl","$uuid=null"
api doc: fix method sort order 2025-05-01 07:06:32 -04:00			"``GET,POST``","tor","exitacl","searchacl",""
API docs - update using script 2022-10-19 11:21:08 -04:00			"``POST``","tor","exitacl","set",""
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``","tor","exitacl","setacl","$uuid"
			"``POST``","tor","exitacl","toggleacl","$uuid"
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, add models for standard templates. 2020-04-07 14:48:40 -04:00			"``<<uses>>``", "", "", "", "model `ACLExitPolicy.xml <https://github.com/opnsense/plugins/blob/master/security/tor/src/opnsense/mvc/app/models/OPNsense/Tor/ACLExitPolicy.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:: Resources (GeneralController.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``","tor","general","addhidservauth",""
			"``POST``","tor","general","delhidservauth","$uuid"
api: update plugins 2021-03-08 06:22:26 -05:00			"``GET``","tor","general","get",""
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``","tor","general","gethidservauth","$uuid=null"
api doc: fix method sort order 2025-05-01 07:06:32 -04:00			"``GET,POST``","tor","general","searchhidservauth",""
API docs - update using script 2022-10-19 11:21:08 -04:00			"``POST``","tor","general","set",""
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``","tor","general","sethidservauth","$uuid"
			"``POST``","tor","general","togglehidservauth","$uuid"
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, add models for standard templates. 2020-04-07 14:48:40 -04:00			"``<<uses>>``", "", "", "", "model `General.xml <https://github.com/opnsense/plugins/blob/master/security/tor/src/opnsense/mvc/app/models/OPNsense/Tor/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 (HiddenserviceController.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``","tor","hiddenservice","addservice",""
			"``POST``","tor","hiddenservice","delservice","$uuid"
api: update plugins 2021-03-08 06:22:26 -05:00			"``GET``","tor","hiddenservice","get",""
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``","tor","hiddenservice","getservice","$uuid=null"
api doc: fix method sort order 2025-05-01 07:06:32 -04:00			"``GET,POST``","tor","hiddenservice","searchservice",""
API docs - update using script 2022-10-19 11:21:08 -04:00			"``POST``","tor","hiddenservice","set",""
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``","tor","hiddenservice","setservice","$uuid"
			"``POST``","tor","hiddenservice","toggleservice","$uuid"
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, add models for standard templates. 2020-04-07 14:48:40 -04:00			"``<<uses>>``", "", "", "", "model `HiddenService.xml <https://github.com/opnsense/plugins/blob/master/security/tor/src/opnsense/mvc/app/models/OPNsense/Tor/HiddenService.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 (HiddenserviceaclController.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``","tor","hiddenserviceacl","addacl",""
			"``POST``","tor","hiddenserviceacl","delacl","$uuid"
api: update plugins 2021-03-08 06:22:26 -05:00			"``GET``","tor","hiddenserviceacl","get",""
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``","tor","hiddenserviceacl","getacl","$uuid=null"
api doc: fix method sort order 2025-05-01 07:06:32 -04:00			"``GET,POST``","tor","hiddenserviceacl","searchacl",""
API docs - update using script 2022-10-19 11:21:08 -04:00			"``POST``","tor","hiddenserviceacl","set",""
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``","tor","hiddenserviceacl","setacl","$uuid"
			"``POST``","tor","hiddenserviceacl","toggleacl","$uuid"

API: plugins, add models for standard templates. 2020-04-07 14:48:40 -04:00			"``<<uses>>``", "", "", "", "model `HiddenServiceACL.xml <https://github.com/opnsense/plugins/blob/master/security/tor/src/opnsense/mvc/app/models/OPNsense/Tor/HiddenServiceACL.xml>`__"

api update: plugins 2025-05-01 04:05:15 -04:00			`.. csv-table:: Resources (RelayController.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``","tor","relay","get",""
API docs - update using script 2022-10-19 11:21:08 -04:00			"``POST``","tor","relay","set",""
api: update plugins 2021-03-08 06:22:26 -05:00
			"``<<uses>>``", "", "", "", "model `Relay.xml <https://github.com/opnsense/plugins/blob/master/security/tor/src/opnsense/mvc/app/models/OPNsense/Tor/Relay.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)`
			`:header: "Method", "Module", "Controller", "Command", "Parameters"`
			`:widths: 4, 15, 15, 30, 40`

			"``GET``","tor","service","circuits",""
development/api - camel to snake case for commands and update endpoints. 2025-04-29 14:00:06 -04:00			"``GET``","tor","service","get_hidden_services",""
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``","tor","service","reconfigure",""
			"``POST``","tor","service","restart",""
			"``POST``","tor","service","start",""
			"``GET``","tor","service","status",""
			"``POST``","tor","service","stop",""
			"``GET``","tor","service","streams",""

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

			"``POST``","tor","socksacl","addacl",""
			"``POST``","tor","socksacl","delacl","$uuid"
api: update plugins 2021-03-08 06:22:26 -05:00			"``GET``","tor","socksacl","get",""
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``","tor","socksacl","getacl","$uuid=null"
api doc: fix method sort order 2025-05-01 07:06:32 -04:00			"``GET,POST``","tor","socksacl","searchacl",""
API docs - update using script 2022-10-19 11:21:08 -04:00			"``POST``","tor","socksacl","set",""
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``","tor","socksacl","setacl","$uuid"
			"``POST``","tor","socksacl","toggleacl","$uuid"
API: plugins, add models for standard templates. 2020-04-07 14:48:40 -04:00
			"``<<uses>>``", "", "", "", "model `ACLSocksPolicy.xml <https://github.com/opnsense/plugins/blob/master/security/tor/src/opnsense/mvc/app/models/OPNsense/Tor/ACLSocksPolicy.xml>`__"