Current File : //www/varak.net/nextcloud.varak.net/apps/app_api/docs/tech_details/api/routes.rst
.. _ex_app_routes:
======
Routes
======
Since AppAPI 3.0.0 ExApps have to declare their routes allowed to be accessed via the AppAPI ExApp proxy.
.. note::
This routes check applied only for ExApp proxy (``/apps/app_api/proxy/*``).
Register
^^^^^^^^
During ExApp installation, the ExApp routes are registered automatically.
The routes must be declared in the ``external-app`` - ``routes`` tag of the ``info.xml`` file.
Example
*******
.. code-block::
<routes>
<route>
<url>.*</url>
<verb>GET,POST,PUT,DELETE</verb>
<access_level>USER</access_level>
<headers_to_exclude>[]</headers_to_exclude>
<bruteforce_protection>[401, 500]</bruteforce_protection>
</route>
</routes>
where the fields are:
- ``url``: the route to be registered on the ExApp side, can be a regex
- ``verb``: the HTTP verb that the route will accept, can be a comma separated list of verbs
- ``access_level``: the name of the access level required to access the route, PUBLIC - public access without auth, USER - Nextcloud user auth required, ADMIN - admin user required
- ``headers_to_exclude``: a json encoded string of an array of strings, the headers that the ExApp wants to be excluded from the request to it
- ``bruteforce_protection``: a json encoded string of an array of numbers, the HTTP status codes that must trigger the bruteforce protection
Unregister
^^^^^^^^^^
ExApp routes are unregistered automatically when the ExApp is uninstalling, or during the ExApp update before registering the new routes.
Mini Shell