mirror of https://github.com/opnsense/docs
Development Manual / API reference - Firewall and firewall plugin additions.
o point people seeking for an API to manage rules to the os-firewall plugin o in the plugin, remove the quote about future plans as these might change and doesn't add much to the topic o explain general plugin usage in case anyone missed that o provide a general tip on how to debug issues with API's while explaining the scope of the work at hand. closes https://github.com/opnsense/docs/pull/437pull/439/head
parent
7b934c9dc5
commit
45e1b74f36
@ -0,0 +1,22 @@
|
||||
.. _api_core_firewall:
|
||||
|
||||
{{ title }}
|
||||
{{ title_underline }}
|
||||
{% for controller in controllers %}
|
||||
.. csv-table:: {{controller.type}} ({{controller.filename}})
|
||||
:header: "Method", "Module", "Controller", "Command", "Parameters"
|
||||
:widths: 4, 15, 15, 30, 40
|
||||
{% for endpoint in controller.endpoints %}
|
||||
"``{{endpoint.method}}``","{{endpoint.module}}","{{endpoint.controller}}","{{endpoint.command}}","{{endpoint.parameters}}"
|
||||
{%- endfor %}
|
||||
{%- if controller.uses %}
|
||||
{% for use in controller.uses %}
|
||||
"``<<uses>>``", "", "", "", "*{{use.type}}* `{{use.name}} <{{use.link}}>`__"
|
||||
{%- endfor %}
|
||||
{%- endif %}
|
||||
{% endfor %}
|
||||
|
||||
.. Tip::
|
||||
|
||||
In order to inject rules using an API, you may take a look at the :ref:`Firewall Plugin API <api_plugins_firewall>`,
|
||||
currently the core system does not support rule modifications via the api for this topic.
|
Loading…
Reference in New Issue