Update iRedAdmin-Pro API doc.
This commit is contained in:
parent
01fbd1b44b
commit
503f6730c7
|
@ -62,8 +62,9 @@ Restarting Apache or uwsgi (if you're running Nginx) is required.
|
|||
Notes:
|
||||
|
||||
* Parameter name with a `*` mark means the parameter is required, otherwise is optional.
|
||||
* replace `<domain>` in URL by the real domain name.
|
||||
* replace `<mail>` in URL by the real email address.
|
||||
* replace `<domain>` in URL by the real domain name. e.g. `example.com`
|
||||
* replace `<mail>` in URL by the real email address. e.g. `user@domain.com`
|
||||
* replace `<number>` in URL by an integer number. e.g. `30`, `200`
|
||||
|
||||
<button type="button" class="toggle_all">Expand/Collapse All API Parameters</button>
|
||||
|
||||
|
@ -90,7 +91,8 @@ Notes:
|
|||
|
||||
</div>
|
||||
|
||||
!!! api "`DELETE`{: .delete } `/api/domain/<domain>`{: .url } `Delete an existing domain`{: .comment }"
|
||||
!!! api "`DELETE`{: .delete } `/api/domain/<domain>`{: .url } `Delete an existing domain (all mail messages will NOT be removed)`{: .comment }"
|
||||
!!! api "`DELETE`{: .delete } `/api/domain/<domain>/keep_mailbox_days/<number>`{: .url } `Delete domain, and keep all mail messages for given days`{: .comment } `upcoming`{: .upcoming }"
|
||||
!!! api "`PUT`{: .put } `/api/domain/<domain>`{: .url } `Update profile of an existing domain`{: .comment } `upcoming`{: .upcoming } `Parameters`{: .has_params }"
|
||||
|
||||
<div class="params params_domain">
|
||||
|
|
|
@ -97,8 +97,9 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
|
|||
<p>Notes:</p>
|
||||
<ul>
|
||||
<li>Parameter name with a <code>*</code> mark means the parameter is required, otherwise is optional.</li>
|
||||
<li>replace <code><domain></code> in URL by the real domain name.</li>
|
||||
<li>replace <code><mail></code> in URL by the real email address.</li>
|
||||
<li>replace <code><domain></code> in URL by the real domain name. e.g. <code>example.com</code></li>
|
||||
<li>replace <code><mail></code> in URL by the real email address. e.g. <code>user@domain.com</code></li>
|
||||
<li>replace <code><number></code> in URL by an integer number. e.g. <code>30</code>, <code>200</code></li>
|
||||
</ul>
|
||||
<p><button type="button" class="toggle_all">Expand/Collapse All API Parameters</button></p>
|
||||
<h3 class="toggle" id="domain">Domain</h3>
|
||||
|
@ -179,7 +180,10 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
|
|||
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="delete">DELETE</code> <code class="url">/api/domain/<domain></code> <code class="comment">Delete an existing domain</code></p>
|
||||
<p class="admonition-title"><code class="delete">DELETE</code> <code class="url">/api/domain/<domain></code> <code class="comment">Delete an existing domain (all mail messages will NOT be removed)</code></p>
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="delete">DELETE</code> <code class="url">/api/domain/<domain>/keep_mailbox_days/<number></code> <code class="comment">Delete domain, and keep all mail messages for given days</code> <code class="upcoming">upcoming</code></p>
|
||||
</div>
|
||||
<div class="admonition api">
|
||||
<p class="admonition-title"><code class="put">PUT</code> <code class="url">/api/domain/<domain></code> <code class="comment">Update profile of an existing domain</code> <code class="upcoming">upcoming</code> <code class="has_params">Parameters</code></p>
|
||||
|
|
Loading…
Reference in New Issue