curl
)Note
If you need an API which has not yet been implemented, feel free to contact us.
iRedAdmin-Pro RESTful API will return message in JSON format.
{'success': true}
.{'success': false, 'msg': '<error_reason>'}
.curl
: https://curl.haxx.se./login
, POST)curl -X POST -c cookie.txt -d "username=<username>&password=<password>" https://<server>/api/login
<username>
by the real admin email address.<password>
by the real admin password.cookie.txt
under current directory./domain/<domain>
)curl -X POST -i -b cookie.txt -d "var=<value>&var2=value2" https://<server>/api/domain/<domain>
<domain>
by the (new) real domain name.Optional POST data:
cn
: the short description of this domain name. e.g. company name.quota
: a integer number for mailbox quota (for whole domain)preferredLanguage
: default preferred language for new user. e.g. en_US
for English, de_DE
for Deutsch.defaultQuota
: default mailbox quota for new user.maxUserQuota
: Max mailbox quota of a single mail usernumberOfUsers
: Max number of mail user accountsnumberOfAliases
: Max number of mail alias accountscurl -X DELETE -i -b cookie.txt https://<server>/api/domain/<domain>
<domain>
by the (existing) domain name./user/<mail>
)curl -X POST -i -b cookie.txt -d "var=value1&var2=value2&..." https://<server>/api/user/<mail>
<mail>
by the (new) email address.Required POST data:
password
: password for this userOptional POST data:
cn
: display namepreferredLanguage
: default preferred language for new user. e.g. en_US
for English, de_DE
for Deutsch.mailQuota
: mailbox quota for this user (in MB). Defaults to per-domain quota setting or unlimited.curl -X DELETE -i -b cookie.txt https://<server>/api/user/<mail>
<mail>
by the (existing) email address./alias/<mail>
)curl -X POST -i -b cookie.txt -d "..." https://<server>/api/alias/<mail>
<mail>
by the email address of (new) mail alias account.Optional POST data:
cn
: display namecurl -X DELETE -i -b cookie.txt https://<server>/api/alias/<mail>
<mail>
by the email address (existing) mail alias account./maillist/<mail>
, OpenLDAP backend only)curl -X POST -i -b cookie.txt -d "..." https://<server>/api/maillist/<mail>
<mail>
by the email address of (new) mailing list.Optional POST data:
cn
: display namecurl -X DELETE -i -b cookie.txt https://<server>/api/maillist/<mail>
<mail>
by the email address of (existing) mailing list.All documents are available in BitBucket repository, and published under Creative Commons license. If you found something wrong, please do contact us to fix it.