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

Update iRedAdmin-Pro API: able to enable/disable and remove all enabled per-domain services.

This commit is contained in:
Zhang Huangbin 2016-07-30 16:52:42 +08:00
parent 67532862c2
commit 9ba0d13846
2 changed files with 45 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
en_US/faq/2-iredadmin-pro.restful.api.md
View File

@ -112,6 +112,18 @@ Notes:
</div>
!!! api "`PUT`{: .put } `/api/domain/services/<domain>`{: .url } `Update enabled per-domain services`{: .comment } `upcoming`{: .upcoming } `Parameters`{: .has_params }"
<div class="params params_domain_services">
Parameter Name | Summary | Sample Usage
--- |--- |---
`enableService` | Enable new services | `enableService=sogo,vpn,xmpp`
`disableService` | Disable existing services | `disableService=sogo,vpn,xmpp`
`removeAllServices` | Disable all services (including mail service) | `removeAllServices=`
</div>
### User {: .toggle }
!!! api "`POST`{: .post } `/api/user/<mail>`{: .url } `Create a new mail user`{: .comment } `Parameters`{: .has_params }"

33
html/iredadmin-pro.restful.api.html
View File

@ -258,6 +258,39 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
</table>
</div>
</div>
<div class="admonition api">
<p class="admonition-title"><code class="put">PUT</code> <code class="url">/api/domain/services/&lt;domain&gt;</code> <code class="comment">Update enabled per-domain services</code> <code class="upcoming">upcoming</code> <code class="has_params">Parameters</code></p>
<div class="params params_domain_services">
<table>
<thead>
<tr>
<th>Parameter Name</th>
<th>Summary</th>
<th>Sample Usage</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>enableService</code></td>
<td>Enable new services</td>
<td><code>enableService=sogo,vpn,xmpp</code></td>
</tr>
<tr>
<td><code>disableService</code></td>
<td>Disable existing services</td>
<td><code>disableService=sogo,vpn,xmpp</code></td>
</tr>
<tr>
<td><code>removeAllServices</code></td>
<td>Disable all services (including mail service)</td>
<td><code>removeAllServices=</code></td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 class="toggle" id="user">User</h3>
<div class="admonition api">