diff --git a/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md b/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md index aa654b4e..ff8a6432 100644 --- a/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md +++ b/en_US/iredadmin/0-iredadmin-pro.restful.api.new.md @@ -22,13 +22,6 @@ iRedAdmin-Pro RESTful API will return message in JSON format. ## Enable RESTful API -!!! note "iRedAdmin-Pro config file location" - - * on RHEL/CentOS, it's `/var/www/iredadmin/settings.py`. - * 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). - * on FreeBSD, it's `/usr/local/www/iredadmin/settings.py`. - * on OpenBSD, it's `/var/www/iredadmin/settings.py`. - RESTful API is disabled by default, to enable it, please add setting below in iRedAdmin-Pro config file `settings.py`: @@ -36,6 +29,16 @@ iRedAdmin-Pro config file `settings.py`: ENABLE_RESTFUL_API = True ``` +Restarting Apache or uwsgi (if you're running Nginx) is required after changed +iRedAdmin config file. + +!!! note "iRedAdmin-Pro config file location" + + * on RHEL/CentOS, it's `/var/www/iredadmin/settings.py`. + * 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). + * on FreeBSD, it's `/usr/local/www/iredadmin/settings.py`. + * on OpenBSD, it's `/var/www/iredadmin/settings.py`. + To restrict API access to few IP addresses, please also add settings below in iRedAdmin-Pro config file: @@ -47,8 +50,6 @@ RESTRICT_API_ACCESS = True RESTFUL_API_CLIENTS = ['172.16.244.1', ...] ``` -Restarting Apache or uwsgi (if you're running Nginx) is required. - ## Sample code to interact with iRedAdmin-Pro RESTful API * [iRedAdmin-Pro RESTful API (interact with `curl`)](./iredadmin-pro.restful.api.curl.html) diff --git a/en_US/iredadmin/2-iredadmin-pro.restful.api.md b/en_US/iredadmin/2-iredadmin-pro.restful.api.md index a79a66ac..c36020b8 100644 --- a/en_US/iredadmin/2-iredadmin-pro.restful.api.md +++ b/en_US/iredadmin/2-iredadmin-pro.restful.api.md @@ -22,13 +22,6 @@ iRedAdmin-Pro RESTful API will return message in JSON format. ## Enable RESTful API -!!! note "iRedAdmin-Pro config file location" - - * on RHEL/CentOS, it's `/var/www/iredadmin/settings.py`. - * 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). - * on FreeBSD, it's `/usr/local/www/iredadmin/settings.py`. - * on OpenBSD, it's `/var/www/iredadmin/settings.py`. - RESTful API is disabled by default, to enable it, please add setting below in iRedAdmin-Pro config file `settings.py`: @@ -36,6 +29,16 @@ iRedAdmin-Pro config file `settings.py`: ENABLE_RESTFUL_API = True ``` +Restarting Apache or uwsgi (if you're running Nginx) is required after changed +iRedAdmin config file. + +!!! note "iRedAdmin-Pro config file location" + + * on RHEL/CentOS, it's `/var/www/iredadmin/settings.py`. + * 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). + * on FreeBSD, it's `/usr/local/www/iredadmin/settings.py`. + * on OpenBSD, it's `/var/www/iredadmin/settings.py`. + To restrict API access to few IP addresses, please also add settings below in iRedAdmin-Pro config file: @@ -47,8 +50,6 @@ RESTRICT_API_ACCESS = True RESTFUL_API_CLIENTS = ['172.16.244.1', ...] ``` -Restarting Apache or uwsgi (if you're running Nginx) is required. - ## Sample code to interact with iRedAdmin-Pro RESTful API * [iRedAdmin-Pro RESTful API (interact with `curl`)](./iredadmin-pro.restful.api.curl.html) diff --git a/html/iredadmin-pro.restful.api.html b/html/iredadmin-pro.restful.api.html index d861ac1f..aea3e242 100644 --- a/html/iredadmin-pro.restful.api.html +++ b/html/iredadmin-pro.restful.api.html @@ -69,6 +69,13 @@
{'_success': false, '_msg': '<error_reason>'}
.RESTful API is disabled by default, to enable it, please add setting below in
+iRedAdmin-Pro config file settings.py
:
ENABLE_RESTFUL_API = True
+
+
+Restarting Apache or uwsgi (if you're running Nginx) is required after changed +iRedAdmin config file.
iRedAdmin-Pro config file location
/var/www/iredadmin/settings.py
.RESTful API is disabled by default, to enable it, please add setting below in
-iRedAdmin-Pro config file settings.py
:
ENABLE_RESTFUL_API = True
-
-
To restrict API access to few IP addresses, please also add settings below in iRedAdmin-Pro config file:
# Enable restriction
@@ -92,7 +94,6 @@ RESTRICT_API_ACCESS = True
RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
-Restarting Apache or uwsgi (if you're running Nginx) is required.
curl
){'_success': false, '_msg': '<error_reason>'}
.RESTful API is disabled by default, to enable it, please add setting below in
+iRedAdmin-Pro config file settings.py
:
ENABLE_RESTFUL_API = True
+
+
+Restarting Apache or uwsgi (if you're running Nginx) is required after changed +iRedAdmin config file.
iRedAdmin-Pro config file location
/var/www/iredadmin/settings.py
.RESTful API is disabled by default, to enable it, please add setting below in
-iRedAdmin-Pro config file settings.py
:
ENABLE_RESTFUL_API = True
-
-
To restrict API access to few IP addresses, please also add settings below in iRedAdmin-Pro config file:
# Enable restriction
@@ -93,7 +95,6 @@ RESTRICT_API_ACCESS = True
RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
-Restarting Apache or uwsgi (if you're running Nginx) is required.