github-jwinterm/modoboa
1
0
Fork 0
mirror of https://github.com/jwinterm/modoboa.git synced 2026-10-19 05:58:34 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2538 from saaditDE/patch-1

Browse Source 
updated docs to new api
This commit is contained in:
Antoine Nguyen
2022-11-15 10:35:13 +01:00
committed by GitHub
parent 7f320cf973 0d9380204b
commit 8e088d3a0e
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/rest_api.rst
+10 -4
View File
@@ -6,12 +6,18 @@ To ease the integration with external sources (software or other),
Modoboa provides a REST API.
Every installed instance comes with a ready-to-use API and a
documentation. You will find them using the following url patterns:
documentation.
* API: *http://<hostname>/api/v1/*
* Documentation: *http://<hostname>/docs/api/*
**You will find them using the following url patterns:**
An `example <https://demo.modoboa.org/docs/api/>`_ of this
* New API+Docs: *https://<hostname>/api/schema-v2/swagger/*
* Old API: *http://<hostname>/api/v1/
* (Old) Documentation: *http://<hostname>/docs/api/*
**Examples:**
* `new example <https://demo.modoboa.org/api/schema-v2/swagger/>`_
* `old example <https://demo.modoboa.org/docs/api/>`_
documentation is available on the official demo.
Using this API requires an authentication and for now, only a token