mirror of https://github.com/opnsense/docs
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
73 lines
1.8 KiB
ReStructuredText
73 lines
1.8 KiB
ReStructuredText
=============
|
|
API Reference
|
|
=============
|
|
|
|
Introduction
|
|
------------
|
|
|
|
The OPNsense API calls are structured in the form:
|
|
|
|
.. code-block:: sh
|
|
|
|
https://opnsense.local/api/<module>/<controller>/<command>/[<param1>/[<param2>/...]]
|
|
|
|
There are two HTTP verbs used in the OPNsense API:
|
|
|
|
- ``GET`` Retrieves data from OPNsense
|
|
- ``POST`` Creates new data, updates existing data or executes an action
|
|
|
|
The body of the HTTP POST request and response is an 'application/json' object.
|
|
|
|
The $key and $secret parameters are used to pass the API credentials using curl. You need to set these parameters with your own API credentials before using them in the examples:
|
|
|
|
.. code-block:: sh
|
|
|
|
key=w86XNZob/8Oq8aC5r0kbNarNtdpoQU781fyoeaOBQsBwkXUt
|
|
secret=XeD26XVrJ5ilAc/EmglCRC+0j2e57tRsjHwFepOseySWLM53pJASeTA3
|
|
|
|
.. note::
|
|
|
|
When using Postman to test an API call, use the 'basic auth' authorization type. The $key and $secret parameters go into Username/Password respectively.
|
|
|
|
.. note::
|
|
|
|
Always make sure the owner of the key is authorized to access the resource in question, the "Effective Privileges" set on the user
|
|
shows which resources are accessible. (Edit reveals the endpoints assigned to each resource).
|
|
|
|
ACL's are explained in :doc:`development/components/acl </development/components/acl>`).
|
|
|
|
Core API
|
|
--------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:titlesonly:
|
|
:glob:
|
|
|
|
api/core/*
|
|
|
|
Plugins API
|
|
------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:titlesonly:
|
|
:glob:
|
|
|
|
api/plugins/*
|
|
|
|
|
|
Business edition API
|
|
------------------------
|
|
|
|
The business edition comes packed with some additional features which could also be used
|
|
for integration purposes from third-party applications. The most relevant ones will be explained in this section.
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:titlesonly:
|
|
:glob:
|
|
|
|
api/be/*
|