elmau
/
iredmail-doc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Sync iRedAdmin-Pro RESTful API doc.

This commit is contained in:
Zhang Huangbin 2019-05-21 11:02:58 +08:00
parent 64f52b623c
commit 6a35e113d4
2 changed files with 10 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
en_US/iredadmin/0-iredadmin-pro.restful.api-new.md
View File

@ -38,21 +38,15 @@ after changed iRedAdmin config file.
* on RHEL/CentOS, it's `/opt/www/iredadmin/settings.py` (in recent iRedMail
releases) or `/var/www/iredadmin/settings.py` (in old iRedMail releases).
* on Debian/Ubuntu, it's `/opt/www/iredadmin/settings.py` (in recent
iRedMail releases) or `/usr/share/apache2/iredadmin/settings.py` (in old iRedMail releases).
iRedMail releases) or `/usr/share/apache2/iredadmin/settings.py` (in old
iRedMail releases).
* on FreeBSD, it's `/usr/local/www/iredadmin/settings.py`.
* on OpenBSD, it's `/opt/www/iredadmin/settings.py` (in recent iRedMail
releases) or `/var/www/iredadmin/settings.py` (in old iRedMail releases).
To restrict API access to few IP addresses, please also add settings below in
iRedAdmin-Pro config file:
```
# Enable restriction
RESTRICT_API_ACCESS = True
# List all IP addresses of allowed client for API access.
RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
```
To restrict API access to few IP addresses, please login to iRedAdmin-Pro as
global admin, then click menu `System -> Settings`, find option `RESTful API is accessible only from specified IP addresses or networks`, input the allowed IP addresses or
networks.
## Sample code to interact with iRedAdmin-Pro RESTful API

15
html/iredadmin-pro.restful.api-new.html
View File

@ -79,21 +79,16 @@ after changed iRedAdmin config file.</p>
<li>on RHEL/CentOS, it's <code>/opt/www/iredadmin/settings.py</code> (in recent iRedMail
releases) or <code>/var/www/iredadmin/settings.py</code> (in old iRedMail releases).</li>
<li>on Debian/Ubuntu, it's <code>/opt/www/iredadmin/settings.py</code> (in recent
iRedMail releases) or <code>/usr/share/apache2/iredadmin/settings.py</code> (in old iRedMail releases).</li>
iRedMail releases) or <code>/usr/share/apache2/iredadmin/settings.py</code> (in old
iRedMail releases).</li>
<li>on FreeBSD, it's <code>/usr/local/www/iredadmin/settings.py</code>.</li>
<li>on OpenBSD, it's <code>/opt/www/iredadmin/settings.py</code> (in recent iRedMail
releases) or <code>/var/www/iredadmin/settings.py</code> (in old iRedMail releases).</li>
</ul>
</div>
<p>To restrict API access to few IP addresses, please also add settings below in
iRedAdmin-Pro config file:</p>
<pre><code># Enable restriction
RESTRICT_API_ACCESS = True
# List all IP addresses of allowed client for API access.
RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
</code></pre>
<p>To restrict API access to few IP addresses, please login to iRedAdmin-Pro as
global admin, then click menu <code>System -&gt; Settings</code>, find option <code>RESTful API is accessible only from specified IP addresses or networks</code>, input the allowed IP addresses or
networks.</p>
<h2 id="sample-code-to-interact-with-iredadmin-pro-restful-api">Sample code to interact with iRedAdmin-Pro RESTful API</h2>
<ul>
<li><a href="./iredadmin-pro.restful.api.curl.html">iRedAdmin-Pro RESTful API (interact with <code>curl</code>)</a></li>