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

Siproxd
~~~~~~~

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

    "``POST``","siproxd","domain","add_domain",""
    "``POST``","siproxd","domain","del_domain","$uuid"
    "``GET``","siproxd","domain","get",""
    "``GET``","siproxd","domain","get_domain","$uuid=null"
    "``GET``","siproxd","domain","search_domain",""
    "``POST``","siproxd","domain","set",""
    "``POST``","siproxd","domain","set_domain","$uuid"
    "``GET``","siproxd","domain","toggle_domain","$uuid"

    "``<<uses>>``", "", "", "", "*model* `Domain.xml <https://github.com/opnsense/plugins/blob/master/net/siproxd/src/opnsense/mvc/app/models/OPNsense/Siproxd/Domain.xml>`__"

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

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

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

    "``POST``","siproxd","service","reconfigure",""
    "``POST``","siproxd","service","restart",""
    "``GET``","siproxd","service","showregistrations",""
    "``POST``","siproxd","service","start",""
    "``GET``","siproxd","service","status",""
    "``POST``","siproxd","service","stop",""

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

    "``POST``","siproxd","user","add_user",""
    "``POST``","siproxd","user","del_user","$uuid"
    "``GET``","siproxd","user","get",""
    "``GET``","siproxd","user","get_user","$uuid=null"
    "``GET``","siproxd","user","search_user",""
    "``POST``","siproxd","user","set",""
    "``POST``","siproxd","user","set_user","$uuid"
    "``GET``","siproxd","user","toggle_user","$uuid"

    "``<<uses>>``", "", "", "", "*model* `User.xml <https://github.com/opnsense/plugins/blob/master/net/siproxd/src/opnsense/mvc/app/models/OPNsense/Siproxd/User.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			`Siproxd`
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 (DomainController.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``","siproxd","domain","add_domain",""
			"``POST``","siproxd","domain","del_domain","$uuid"
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``","siproxd","domain","get",""
development/api - camel to snake case for commands and update endpoints. 2025-04-29 14:00:06 -04:00			"``GET``","siproxd","domain","get_domain","$uuid=null"
			"``GET``","siproxd","domain","search_domain",""
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``","siproxd","domain","set",""
development/api - camel to snake case for commands and update endpoints. 2025-04-29 14:00:06 -04:00			"``POST``","siproxd","domain","set_domain","$uuid"
			"``GET``","siproxd","domain","toggle_domain","$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 `Domain.xml <https://github.com/opnsense/plugins/blob/master/net/siproxd/src/opnsense/mvc/app/models/OPNsense/Siproxd/Domain.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			"``GET``","siproxd","general","get",""
			"``POST``","siproxd","general","set",""
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:: 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``","siproxd","service","reconfigure",""
			"``POST``","siproxd","service","restart",""
			"``GET``","siproxd","service","showregistrations",""
			"``POST``","siproxd","service","start",""
			"``GET``","siproxd","service","status",""
			"``POST``","siproxd","service","stop",""

			`.. csv-table:: Resources (UserController.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``","siproxd","user","add_user",""
			"``POST``","siproxd","user","del_user","$uuid"
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``","siproxd","user","get",""
development/api - camel to snake case for commands and update endpoints. 2025-04-29 14:00:06 -04:00			"``GET``","siproxd","user","get_user","$uuid=null"
			"``GET``","siproxd","user","search_user",""
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``","siproxd","user","set",""
development/api - camel to snake case for commands and update endpoints. 2025-04-29 14:00:06 -04:00			"``POST``","siproxd","user","set_user","$uuid"
			"``GET``","siproxd","user","toggle_user","$uuid"
API: plugins, add models for standard templates. 2020-04-07 14:48:40 -04:00
			"``<<uses>>``", "", "", "", "model `User.xml <https://github.com/opnsense/plugins/blob/master/net/siproxd/src/opnsense/mvc/app/models/OPNsense/Siproxd/User.xml>`__"