Sync iRedAdmin-Pro RESTful API doc.
This commit is contained in:
parent
64f52b623c
commit
6a35e113d4
|
@ -38,21 +38,15 @@ after changed iRedAdmin config file.
|
||||||
* on RHEL/CentOS, it's `/opt/www/iredadmin/settings.py` (in recent iRedMail
|
* on RHEL/CentOS, it's `/opt/www/iredadmin/settings.py` (in recent iRedMail
|
||||||
releases) or `/var/www/iredadmin/settings.py` (in old iRedMail releases).
|
releases) or `/var/www/iredadmin/settings.py` (in old iRedMail releases).
|
||||||
* on Debian/Ubuntu, it's `/opt/www/iredadmin/settings.py` (in recent
|
* 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 FreeBSD, it's `/usr/local/www/iredadmin/settings.py`.
|
||||||
* on OpenBSD, it's `/opt/www/iredadmin/settings.py` (in recent iRedMail
|
* on OpenBSD, it's `/opt/www/iredadmin/settings.py` (in recent iRedMail
|
||||||
releases) or `/var/www/iredadmin/settings.py` (in old iRedMail releases).
|
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
|
To restrict API access to few IP addresses, please login to iRedAdmin-Pro as
|
||||||
iRedAdmin-Pro config file:
|
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.
|
||||||
```
|
|
||||||
# Enable restriction
|
|
||||||
RESTRICT_API_ACCESS = True
|
|
||||||
|
|
||||||
# List all IP addresses of allowed client for API access.
|
|
||||||
RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
|
|
||||||
```
|
|
||||||
|
|
||||||
## Sample code to interact with iRedAdmin-Pro RESTful API
|
## Sample code to interact with iRedAdmin-Pro RESTful API
|
||||||
|
|
||||||
|
|
|
@ -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
|
<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>
|
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
|
<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 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
|
<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>
|
releases) or <code>/var/www/iredadmin/settings.py</code> (in old iRedMail releases).</li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
<p>To restrict API access to few IP addresses, please also add settings below in
|
<p>To restrict API access to few IP addresses, please login to iRedAdmin-Pro as
|
||||||
iRedAdmin-Pro config file:</p>
|
global admin, then click menu <code>System -> Settings</code>, find option <code>RESTful API is accessible only from specified IP addresses or networks</code>, input the allowed IP addresses or
|
||||||
<pre><code># Enable restriction
|
networks.</p>
|
||||||
RESTRICT_API_ACCESS = True
|
|
||||||
|
|
||||||
# List all IP addresses of allowed client for API access.
|
|
||||||
RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
|
|
||||||
</code></pre>
|
|
||||||
|
|
||||||
<h2 id="sample-code-to-interact-with-iredadmin-pro-restful-api">Sample code to interact with iRedAdmin-Pro RESTful API</h2>
|
<h2 id="sample-code-to-interact-with-iredadmin-pro-restful-api">Sample code to interact with iRedAdmin-Pro RESTful API</h2>
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="./iredadmin-pro.restful.api.curl.html">iRedAdmin-Pro RESTful API (interact with <code>curl</code>)</a></li>
|
<li><a href="./iredadmin-pro.restful.api.curl.html">iRedAdmin-Pro RESTful API (interact with <code>curl</code>)</a></li>
|
||||||
|
|
Loading…
Reference in New Issue