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

Update iRedAdmin-Pro API doc for upcoming release.

This commit is contained in:
Zhang Huangbin 2017-09-09 10:35:57 +08:00
parent f09d404db7
commit 25d8598448
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -140,7 +140,7 @@ Notes:
`outboundRelay` | Per-domain outbound relay. Set an empty value to disable outbound relay. | `outboundRelay=smtp:[192.168.1.2]:25` or `outboundRelay=` (disable outbound relay)
`addService` | Enable new services. Multiple services must be separated by comma. Available services are listed below. | `addService=self-service`
`removeService` | Disable existing services. Multiple services must be separated by comma. Available services are listed below. | `removeService=self-service`
`removeAllServices` | Disable all services (including mail service) | `removeAllServices=` (empty value)
`services` | Reset all services. If empty, all existing services will be removed. | `services=mail,self-service`
`disableDomainProfile` | disable given domain profiles. Normal admin cannot view and update disabled profiles in domain profile page. Available domain profiles are listed below. | `disableDomainProfile=bcc,relay,aliases`
`enableDomainProfile` | enable given domain profiles. Normal admin can view and update disabled profiles in domain profile page. Available domain profiles are listed below. | `enableDomainProfile=bcc,relay,aliases`
`disableUserProfile` | disable given user profiles. Normal admin cannot view and update disabled profiles in user profile page. Available user profiles are listed below. | `disableUserProfile=bcc,relay,aliases`
@ -612,6 +612,7 @@ Notes:
* While updating domain profile (`PUT /api/domain/<domain>`):
* `enableService` was renamed to `addService`
* `disableService` was renamed to `removeService`
* `removeAllServices` was renamed to `services`
### iRedAdmin-Pro-SQL-2.8.0, iRedAdmin-Pro-LDAP-3.0

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

@ -359,9 +359,9 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
<td><code>removeService=self-service</code></td>
</tr>
<tr>
<td><code>removeAllServices</code></td>
<td>Disable all services (including mail service)</td>
<td><code>removeAllServices=</code> (empty value)</td>
<td><code>services</code></td>
<td>Reset all services. If empty, all existing services will be removed.</td>
<td><code>services=mail,self-service</code></td>
</tr>
<tr>
<td><code>disableDomainProfile</code></td>
@ -1596,6 +1596,7 @@ please use mail alias account as mailing list.</p>
<li>While updating domain profile (<code>PUT /api/domain/&lt;domain&gt;</code>):<ul>
<li><code>enableService</code> was renamed to <code>addService</code></li>
<li><code>disableService</code> was renamed to <code>removeService</code></li>
<li><code>removeAllServices</code> was renamed to <code>services</code></li>
</ul>
</li>
</ul>