opensense-docs/source/development/api/plugins/bind.rst

Bind
~~~~

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

    "``POST``","bind","acl","addAcl",""
    "``POST``","bind","acl","delAcl","$uuid"
    "``GET``","bind","acl","get",""
    "``GET``","bind","acl","getAcl","$uuid=null"
    "``*``","bind","acl","searchAcl",""
    "``POST``","bind","acl","set",""
    "``POST``","bind","acl","setAcl","$uuid"
    "``POST``","bind","acl","toggleAcl","$uuid"

    "``<<uses>>``", "", "", "", "*model* `Acl.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/Acl.xml>`__"

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

    "``GET``","bind","dnsbl","get",""
    "``POST``","bind","dnsbl","set",""

    "``<<uses>>``", "", "", "", "*model* `Dnsbl.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/Dnsbl.xml>`__"

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

    "``POST``","bind","domain","addPrimaryDomain","$uuid=null"
    "``POST``","bind","domain","addSecondaryDomain","$uuid=null"
    "``POST``","bind","domain","delDomain","$uuid"
    "``GET``","bind","domain","get",""
    "``GET``","bind","domain","getDomain","$uuid=null"
    "``GET``","bind","domain","searchMasterDomain",""
    "``*``","bind","domain","searchPrimaryDomain",""
    "``*``","bind","domain","searchSecondaryDomain",""
    "``GET``","bind","domain","searchSlaveDomain",""
    "``POST``","bind","domain","set",""
    "``POST``","bind","domain","setDomain","$uuid=null"
    "``POST``","bind","domain","toggleDomain","$uuid"

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

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

    "``GET``","bind","general","get",""
    "``POST``","bind","general","set",""
    "``GET``","bind","general","zoneshow","$zonename=null"
    "``GET``","bind","general","zonetest","$zonename=null"

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

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

    "``POST``","bind","record","addRecord",""
    "``POST``","bind","record","delRecord","$uuid"
    "``GET``","bind","record","get",""
    "``GET``","bind","record","getRecord","$uuid=null"
    "``*``","bind","record","searchRecord",""
    "``POST``","bind","record","set",""
    "``POST``","bind","record","setRecord","$uuid=null"
    "``POST``","bind","record","toggleRecord","$uuid"

    "``<<uses>>``", "", "", "", "*model* `Record.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/Record.xml>`__"

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

    "``GET``","bind","service","dnsbl",""
    "``POST``","bind","service","reconfigure",""
    "``POST``","bind","service","restart",""
    "``POST``","bind","service","start",""
    "``GET``","bind","service","status",""
    "``POST``","bind","service","stop",""

    "``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/General.xml>`__"
API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 15:11:37 +00:00			`Bind`
			`~~~~`
Add bind and frr to API (#50) 2018-09-30 10:13:51 +00:00
API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 15:11:37 +00:00			`.. csv-table:: Resources (AclController.php)`
Add bind and frr to API (#50) 2018-09-30 10:13:51 +00: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 15:11:37 +00:00			"``POST``","bind","acl","addAcl",""
			"``POST``","bind","acl","delAcl","$uuid"
api: update plugins 2021-03-08 11:22:26 +00:00			"``GET``","bind","acl","get",""
API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 15:11:37 +00:00			"``GET``","bind","acl","getAcl","$uuid=null"
			"``*``","bind","acl","searchAcl",""
API docs - update using script 2022-10-19 15:21:08 +00:00			"``POST``","bind","acl","set",""
API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 15:11:37 +00:00			"``POST``","bind","acl","setAcl","$uuid"
			"``POST``","bind","acl","toggleAcl","$uuid"
Add bind and frr to API (#50) 2018-09-30 10:13:51 +00:00
API: plugins, add models for standard templates. 2020-04-07 18:48:40 +00:00			"``<<uses>>``", "", "", "", "model `Acl.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/Acl.xml>`__"

api: update plugins 2021-03-08 11:22:26 +00:00			`.. csv-table:: Service (DnsblController.php)`
			`:header: "Method", "Module", "Controller", "Command", "Parameters"`
			`:widths: 4, 15, 15, 30, 40`

			"``GET``","bind","dnsbl","get",""
API docs - update using script 2022-10-19 15:21:08 +00:00			"``POST``","bind","dnsbl","set",""
api: update plugins 2021-03-08 11:22:26 +00:00
			"``<<uses>>``", "", "", "", "model `Dnsbl.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/Dnsbl.xml>`__"

API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 15:11:37 +00:00			`.. csv-table:: Resources (DomainController.php)`
Add bind and frr to API (#50) 2018-09-30 10:13:51 +00:00			`:header: "Method", "Module", "Controller", "Command", "Parameters"`
			`:widths: 4, 15, 15, 30, 40`

update API docs 2023-07-07 08:59:17 +00:00			"``POST``","bind","domain","addPrimaryDomain","$uuid=null"
			"``POST``","bind","domain","addSecondaryDomain","$uuid=null"
API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 15:11:37 +00:00			"``POST``","bind","domain","delDomain","$uuid"
api: update plugins 2021-03-08 11:22:26 +00:00			"``GET``","bind","domain","get",""
API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 15:11:37 +00:00			"``GET``","bind","domain","getDomain","$uuid=null"
update API docs 2023-07-07 08:59:17 +00:00			"``GET``","bind","domain","searchMasterDomain",""
			"``*``","bind","domain","searchPrimaryDomain",""
			"``*``","bind","domain","searchSecondaryDomain",""
			"``GET``","bind","domain","searchSlaveDomain",""
API docs - update using script 2022-10-19 15:21:08 +00:00			"``POST``","bind","domain","set",""
API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 15:11:37 +00:00			"``POST``","bind","domain","setDomain","$uuid=null"
			"``POST``","bind","domain","toggleDomain","$uuid"
Add bind and frr to API (#50) 2018-09-30 10:13:51 +00:00
API: plugins, add models for standard templates. 2020-04-07 18:48:40 +00:00			"``<<uses>>``", "", "", "", "model `Domain.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/Domain.xml>`__"

api: update plugins 2021-03-08 11:22:26 +00:00			`.. csv-table:: Service (GeneralController.php)`
			`:header: "Method", "Module", "Controller", "Command", "Parameters"`
			`:widths: 4, 15, 15, 30, 40`

			"``GET``","bind","general","get",""
API docs - update using script 2022-10-19 15:21:08 +00:00			"``POST``","bind","general","set",""
api endpoints (plugins) 2024-02-20 14:52:06 +00:00			"``GET``","bind","general","zoneshow","$zonename=null"
			"``GET``","bind","general","zonetest","$zonename=null"
api: update plugins 2021-03-08 11:22:26 +00:00
			"``<<uses>>``", "", "", "", "model `General.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/General.xml>`__"

API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 15:11:37 +00:00			`.. csv-table:: Resources (RecordController.php)`
Add bind and frr to API (#50) 2018-09-30 10:13:51 +00: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 15:11:37 +00:00			"``POST``","bind","record","addRecord",""
			"``POST``","bind","record","delRecord","$uuid"
api: update plugins 2021-03-08 11:22:26 +00:00			"``GET``","bind","record","get",""
API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 15:11:37 +00:00			"``GET``","bind","record","getRecord","$uuid=null"
			"``*``","bind","record","searchRecord",""
API docs - update using script 2022-10-19 15:21:08 +00:00			"``POST``","bind","record","set",""
API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 15:11:37 +00:00			"``POST``","bind","record","setRecord","$uuid=null"
			"``POST``","bind","record","toggleRecord","$uuid"
Add bind and frr to API (#50) 2018-09-30 10:13:51 +00:00
API: plugins, add models for standard templates. 2020-04-07 18:48:40 +00:00			"``<<uses>>``", "", "", "", "model `Record.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/Record.xml>`__"

API/plugins: update to stable/20.1. closes https://github.com/opnsense/plugins/issues/1698 while there 2020-02-16 15:11:37 +00:00			`.. csv-table:: Service (ServiceController.php)`
Add bind and frr to API (#50) 2018-09-30 10:13:51 +00: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 15:11:37 +00:00			"``GET``","bind","service","dnsbl",""
API docs - update using script 2022-10-19 15:21:08 +00:00			"``POST``","bind","service","reconfigure",""
			"``POST``","bind","service","restart",""
			"``POST``","bind","service","start",""
api: update plugins 2021-03-08 11:22:26 +00:00			"``GET``","bind","service","status",""
API docs - update using script 2022-10-19 15:21:08 +00:00			"``POST``","bind","service","stop",""
API: plugins, add models for standard templates. 2020-04-07 18:48:40 +00:00
			"``<<uses>>``", "", "", "", "model `General.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/General.xml>`__"