diff --git a/en_US/iredadmin/2-iredadmin-pro.restful.api.md b/en_US/iredadmin/2-iredadmin-pro.restful.api.md index 7478ace9..253c750c 100644 --- a/en_US/iredadmin/2-iredadmin-pro.restful.api.md +++ b/en_US/iredadmin/2-iredadmin-pro.restful.api.md @@ -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 `` in URL by the real domain name. -* replace `` in URL by the real email address. +* replace `` in URL by the real domain name. e.g. `example.com` +* replace `` in URL by the real email address. e.g. `user@domain.com` +* replace `` in URL by an integer number. e.g. `30`, `200` @@ -90,7 +91,8 @@ Notes: -!!! api "`DELETE`{: .delete } `/api/domain/`{: .url } `Delete an existing domain`{: .comment }" +!!! api "`DELETE`{: .delete } `/api/domain/`{: .url } `Delete an existing domain (all mail messages will NOT be removed)`{: .comment }" +!!! api "`DELETE`{: .delete } `/api/domain//keep_mailbox_days/`{: .url } `Delete domain, and keep all mail messages for given days`{: .comment } `upcoming`{: .upcoming }" !!! api "`PUT`{: .put } `/api/domain/`{: .url } `Update profile of an existing domain`{: .comment } `upcoming`{: .upcoming } `Parameters`{: .has_params }"
diff --git a/html/iredadmin-pro.restful.api.html b/html/iredadmin-pro.restful.api.html index e200976d..1eee67cb 100644 --- a/html/iredadmin-pro.restful.api.html +++ b/html/iredadmin-pro.restful.api.html @@ -97,8 +97,9 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]

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

Domain

@@ -179,7 +180,10 @@ RESTFUL_API_CLIENTS = ['172.16.244.1', ...]
-

DELETE /api/domain/<domain> Delete an existing domain

+

DELETE /api/domain/<domain> Delete an existing domain (all mail messages will NOT be removed)

+
+
+

DELETE /api/domain/<domain>/keep_mailbox_days/<number> Delete domain, and keep all mail messages for given days upcoming

PUT /api/domain/<domain> Update profile of an existing domain upcoming Parameters