[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"/en/kb/api/functions-for-work-with-mailKbData":3},{"page":4,"pages":167,"recommendedPages":504,"category":41,"categoryTree":41,"total":505,"currentOrder":506,"activeManualCategoryId":41,"tag":-1},{"route":5,"uuid":8,"title":9,"excerpt":10,"content":11,"view_count":12,"published_at":13,"modified_at":14,"like":15,"category":18,"hero_image":35,"seo_metadata":36,"schema_org_metadata":39,"open_graph_metadata":42,"sections":43,"tags":160,"breadcrumbs":163,"images":166},{"language":6,"path":7},"en","/kb/api/functions-for-work-with-mail","921540a9-7668-d633-c985-ff57d0119510","Functions for work with mail","getMailboxList Description: Method returns all mailboxes on given domain. Additional parameters domain - domain, whose mailboxes will be displayed (e.g.","\n\u003Ch2 id=\"getmailboxlist\">getMailboxList\u003C/h2>\n\n\n\n\u003Ch3 id=\"description\">Description:\u003C/h3>\n\n\n\n\u003Cp>Method returns all mailboxes on given domain.\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters\">Additional parameters\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>domain\u003C/strong> - domain, whose mailboxes will be displayed (e.g. site.de);\u003C/li>\u003C/ul>\n\n\n\n\u003Ch3 id=\"call-example\">Call example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":""}\">\u003Ccode>// for illustration purposes input_data is presented in uncoded form\nhttps://api.beget.com/api/mail/getMailboxList?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data={\"domain\":\"site.de\"}\n\n// correct call example, input_data is coded with urlencode\nhttps://api.beget.com/api/mail/getMailboxList?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data=%7B%22domain%22%3A%22site.de%22%7D\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch3 id=\"response-example\">Response example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":"javascript"}\">\u003Ccode>[\n   {\n      \"mailbox\":\"mailbox1\",\n      \"domain\":\"site.de\",\n      \"spam_filter_status\":1,\n      \"forward_mail_status\":\"no_forward\"\n   },\n   {\n      \"mailbox\":\"test.mail\",\n      \"domain\":\"site.de\",\n      \"spam_filter_status\": 0,\n      \"forward_mail_status\": \"forward\"\n   },\n   {\n      \"mailbox\":\"admin\",\n      \"domain\":\"site.de\",\n      \"spam_filter_status\":1,\n      \"forward_mail_status\":\"forward_and_delete\"\n   }\n]\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch2 id=\"changemailboxpassword\">changeMailboxPassword\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-2\">Description:\u003C/h3>\n\n\n\n\u003Cp>Method changes password to given mailbox.\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters-2\">Additional parameters\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>domain\u003C/strong> - domain, where the mailbox is located (e.g. site.de);\u003C/li>\u003Cli>\u003Cstrong>mailbox\u003C/strong> - mailbox name (e.g. info);\u003C/li>\u003Cli>\u003Cstrong>mailbox_password\u003C/strong> - mailbox password.\u003C/li>\u003C/ul>\n\n\n\n\u003Ch3 id=\"call-example-2\">Call example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":""}\">\u003Ccode>// for illustration purposes input_data is presented in uncoded form\nhttps://api.beget.com/api/mail/changeMailboxPassword?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data={\"domain\":\"site.de\",\"mailbox\":\"info\",\n\"mailbox_password\":\"password\"}\n\n// correct call example, input_data is coded with urlencode\nhttps://api.beget.com/api/mail/changeMailboxPassword?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data=%7B%22domain%22%3A%22site.de%22%2C%22mailbox\n%22%3A%22info%22%2C%22mailbox_password%22%3A%22password%22%7D\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch3 id=\"response-example-2\">Response example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":"javascript"}\">\u003Ccode> true\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Cp>Returns property of successful or unsuccessful execution.\u003C/p>\n\n\n\n\u003Ch2 id=\"createmailbox\">createMailbox\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-3\">Description:\u003C/h3>\n\n\n\n\u003Cp>Method creates mailbox on given domain.\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters-3\">Additional parameters\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>domain\u003C/strong> - domain, where thd mailbox shall be created (e.g. site.de);\u003C/li>\u003Cli>\u003Cstrong>mailbox\u003C/strong> - mailbox name (e.g. info);\u003C/li>\u003Cli>\u003Cstrong>mailbox_password\u003C/strong> - mailbox password.\u003C/li>\u003C/ul>\n\n\n\n\u003Ch3 id=\"call-example-3\">Call example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":""}\">\u003Ccode>// for illustration purposes input_data is presented in uncoded form\nhttps://api.beget.com/api/mail/createMailbox?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data={\"domain\":\"site.de\",\"mailbox\":\"info\",\n\"mailbox_password\":\"password\"}\n\n// correct call example, input_data is coded with urlencode\nhttps://api.beget.com/api/mail/createMailbox?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data=%7B%22domain%22%3A%22site.de%22%2C%22mailbox\n%22%3A%22info%22%2C%22mailbox_password%22%3A%22password%22%7D\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch3 id=\"response-example-3\">Response example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":"javascript"}\">\u003Ccode> true\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Cp>Returns property of successful or unsuccessful execution.\u003C/p>\n\n\n\n\u003Ch2 id=\"dropmailbox\">dropMailbox\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-4\">Description:\u003C/h3>\n\n\n\n\u003Cp>Method deletes mailbox on given domain.\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters-4\">Additional parameters\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>domain\u003C/strong> - domain, where the mailbox is located (e.g. site.de);\u003C/li>\u003Cli>\u003Cstrong>mailbox\u003C/strong> - mailbox name (e.g. info).\u003C/li>\u003C/ul>\n\n\n\n\u003Ch3 id=\"call-example-4\">Call example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":""}\">\u003Ccode>// for illustration purposes input_data is presented in uncoded form\nhttps://api.beget.com/api/mail/dropMailbox?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data={\"domain\":\"site.de\",\"mailbox\":\"info\"}\n\n// correct call example, input_data is coded with urlencode\nhttps://api.beget.com/api/mail/dropMailbox?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data=%7B%22domain%22%3A%22site.de%22%2C%22mailbox%22%3A%22info%22%7D\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch3 id=\"response-example-4\">Response example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":"javascript"}\">\u003Ccode> true\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Cp>Returns property of successful or unsuccessful execution.\u003C/p>\n\n\n\n\u003Ch2 id=\"changemailboxsettings\">changeMailboxSettings\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-5\">Description:\u003C/h3>\n\n\n\n\u003Cp>Method sets options for mailbox.\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters-5\">Additional parameters\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>domain\u003C/strong> - domain, where the mailbox is located (e.g. site.de);\u003C/li>\u003Cli>\u003Cstrong>mailbox\u003C/strong> - mailbox name (e.g. info);\u003C/li>\u003Cli>\u003Cstrong>spam_filter_status\u003C/strong> - spam filter operation status (0/1);\u003C/li>\u003Cli>\u003Cstrong>spam_filter\u003C/strong> - spam filtering level (0 - max. filtering, 100 - minimum);\u003C/li>\u003Cli>\u003Cstrong>forward_mail_status\u003C/strong> - forwarding operation mode for mailbox.\u003Cul>\u003Cli>\u003Cem>no_forward\u003C/em> - messages will not be forwarded,\u003C/li>\u003Cli>\u003Cem>forward\u003C/em> - messages will also be forwarded to indicated mailboxes,\u003C/li>\u003Cli>\u003Cem>forward_and_delete\u003C/em> - messages will be forwarded and deleted from mailbox.\u003C/li>\u003C/ul>\u003C/li>\u003C/ul>\n\n\n\n\u003Ch3 id=\"call-example-5\">Call example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":""}\">\u003Ccode>// for illustration purposes input_data is presented in uncoded form\nhttps://api.beget.com/api/mail/changeMailboxSettings?login=userlogin&\npasswd=password&input_format=json&output_format=json&input_data=\n{\"domain\":\"site.de\",\"mailbox\":\"info\",\"spam_filter_status\":1,\"spam_filter\":50,\n\"forward_mail_status\":\"no_forward\"}\n\n// correct call example, input_data is coded with urlencode\nhttps://api.beget.com/api/mail/changeMailboxSettings?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data=%7B%22domain%22%3A%22site.de%22%2C%22mailbox%22%3A%22info\n%22%2C%22spam_filter_status%22%3A1%2C%22spam_filter%22%3A50%2C%0A\n%22forward_mail_status%22%3A%22\nno_forward%22%7D\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch3 id=\"response-example-5\">Response example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":"javascript"}\">\u003Ccode> true\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Cp>Returns property of successful or unsuccessful execution.\u003C/p>\n\n\n\n\u003Ch2 id=\"forwardlistaddmailbox\">forwardListAddMailbox\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-6\">Description:\u003C/h3>\n\n\n\n\u003Cp>Method will add mailbox to list of mailboxes for forwarding.\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters-6\">Additional parameters\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>domain\u003C/strong> - domain, where the mailbox is located (e.g. site.de);\u003C/li>\u003Cli>\u003Cstrong>mailbox\u003C/strong> - mailbox name (e.g. info);\u003C/li>\u003Cli>\u003Cstrong>forward_mailbox\u003C/strong> - mailbox, where messages will be forwarded to.\u003C/li>\u003C/ul>\n\n\n\n\u003Ch3 id=\"call-example-6\">Call example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":""}\">\u003Ccode>// for illustration purposes input_data is presented in uncoded form\nhttps://api.beget.com/api/mail/forwardListAddMailbox?login=userlogin&\npasswd=password&input_format=json&output_format=json&input_data=\n{\"domain\":\"site.de\",\"mailbox\":\"info\",\"forward_mailbox\":\"\"mail@yandex.de\"}\n\n// correct call example, input_data is coded with urlencode\nhttps://api.beget.com/api/mail/forwardListAddMailbox?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data=%7B%22domain%22%3A%22site.de%22%2C%22mailbox%22%3A%22\ninfo%22%2C%22forward_mailbox%22%3A%22%22mail%40yandex.de%22%7D\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch3 id=\"response-example-6\">Response example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":"javascript"}\">\u003Ccode> true\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Cp>Returns property of successful or unsuccessful execution.\u003C/p>\n\n\n\n\u003Ch2 id=\"forwardlistdeletemailbox\">forwardListDeleteMailbox\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-7\">Description:\u003C/h3>\n\n\n\n\u003Cp>Method deletes mailbox from list of mailboxes for forwarding.\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters-7\">Additional parameters\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>domain\u003C/strong> - domain, where the mailbox is located (e.g. site.de);\u003C/li>\u003Cli>\u003Cstrong>mailbox\u003C/strong> - mailbox name (e.g. info);\u003C/li>\u003Cli>\u003Cstrong>forward_mailbox\u003C/strong> - mailbox, which will be deleted from forwarding list.\u003C/li>\u003C/ul>\n\n\n\n\u003Ch3 id=\"call-example-7\">Call example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":""}\">\u003Ccode>// for illustration purposes input_data is presented in uncoded form\nhttps://api.beget.com/api/mail/forwardListDeleteMailbox?login=userlogin&\npasswd=password&input_format=json&output_format=json&input_data=\n{\"domain\":\"site.de\",\"mailbox\":\"info\",\"forward_mailbox\":\"\"mail@yandex.de\"}\n\n// correct call example, input_data is coded with urlencode\nhttps://api.beget.com/api/mail/forwardListDeleteMailbox?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data=%7B%22domain%22%3A%22site.de%22%2C%22mailbox%22%3A%22\ninfo%22%2C%22forward_mailbox%22%3A%22%22mail%40yandex.de%22%7D\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch3 id=\"response-example-7\">Response example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":"javascript"}\">\u003Ccode> true\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Cp>Returns property of successful or unsuccessful execution.\u003C/p>\n\n\n\n\u003Ch2 id=\"forwardlistshow\">forwardListShow\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-8\">Description:\u003C/h3>\n\n\n\n\u003Cp>Method returns forwarding list for indicated mailbox.\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters-8\">Additional parameters\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>domain\u003C/strong> - domain, where the mailbox is located (e.g. site.de);\u003C/li>\u003Cli>\u003Cstrong>mailbox\u003C/strong> - mailbox name (e.g. info).\u003C/li>\u003C/ul>\n\n\n\n\u003Ch3 id=\"call-example-8\">Call example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":""}\">\u003Ccode>// for illustration purposes input_data is presented in uncoded form\nhttps://api.beget.com/api/mail/forwardListShow?login=userlogin&\npasswd=password&input_format=json&output_format=json&input_data=\n{\"domain\":\"site.de\",\"mailbox\":\"info\"}\n\n// correct call example, input_data is coded with urlencode\nhttps://api.beget.com/api/mail/forwardListShow?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data=%7B%22domain%22%3A%22site.de%22%2C%22mailbox%22%3A%22info%22%7D\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch3 id=\"response-example-8\">Response example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":"javascript"}\">\u003Ccode>[\n   {\n      \"forward_mailbox\":\"admin@domain.de\"\n   },\n   {\n      \"forward_mailbox\":\"webmaster@site.com\"\n   }\n]\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch2 id=\"setdomainmail\">setDomainMail\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-9\">Description:\u003C/h3>\n\n\n\n\u003Cp>Method sets up domain mail.\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters-9\">Additional parameters\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>domain\u003C/strong> - domain, which the domain mail shall be set up for (e.g. site.de);\u003C/li>\u003Cli>\u003Cstrong>domain_mailbox\u003C/strong> - mailbox, which shall be set up as domain mail (e.g. mail@site.de).\u003C/li>\u003C/ul>\n\n\n\n\u003Ch3 id=\"call-example-9\">Call example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":""}\">\u003Ccode>// for illustration purposes input_data is presented in uncoded form\nhttps://api.beget.com/api/mail/setDomainMail?login=userlogin&\npasswd=password&input_format=json&output_format=json&input_data=\n{\"domain\":\"site.de\",\"domain_mailbox\":\"mail@site.de\"}\n\n// correct call example, input_data is coded with urlencode\nhttps://api.beget.com/api/mail/setDomainMail?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data=%7B%22domain%22%3A%22site.de%22%2C%22domain_mailbox%22%3A\n%22mail%40site.de%22%7D\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch3 id=\"response-example-9\">Response example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":"javascript"}\">\u003Ccode> true\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Cp>Returns property of successful or unsuccessful execution.\u003C/p>\n\n\n\n\u003Ch2 id=\"cleardomainmail\">clearDomainMail\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-10\">Description:\u003C/h3>\n\n\n\n\u003Cp>Method resets domain mail.\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters-10\">Additional parameters\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>domain\u003C/strong> - domain, which the domain mail will be reset for (e.g. site.de);\u003C/li>\u003C/ul>\n\n\n\n\u003Ch3 id=\"call-example-10\">Call example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":""}\">\u003Ccode>// for illustration purposes input_data is presented in uncoded form\nhttps://api.beget.com/api/mail/clearDomainMail?login=userlogin&\npasswd=password&input_format=json&output_format=json&input_data=\n{\"domain\":\"site.de\"}\n\n// correct call example, input_data is coded with urlencode\nhttps://api.beget.com/api/mail/clearDomainMail?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data=%7B%22domain%22%3A%22site.de%22%7D\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch3 id=\"response-example-10\">Response example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":"javascript"}\">\u003Ccode> true\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Cp>Returns property of successful or unsuccessful execution.\u003C/p>\n",3335,"2020-08-24T18:20:05+03:00","2026-02-02T15:22:31+03:00",{"count":16,"liked":17},22,false,{"route":19,"title":21,"tags":22,"breadcrumbs":28,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":32},{"language":6,"path":20},"/kb/api","Beget.API",[23],{"id":24,"title":25,"seo_metadata":26},"api","API",{"title":27,"description":27,"header":27,"keywords":27},"",[],"3fb953d7-8d0a-d5ee-7830-dcd3ffc7314d","d2ced092-cdd0-6732-3353-012a5065b6cc","/kb/api/beget-api",{"title":33,"description":34,"header":27,"keywords":27},"Принципы работы с Beget.API – Beget","API – это программный интерфейс или набор функций для управления сайтами, доменами, почтой и т. д. В статье подробно расскажем о возможностях Beget.API для вашего сайта",{"src":27,"text":27},{"title":27,"description":37,"keywords":38},"We tell you the functions of API for working with mail in Beget hosting","api mail, api email",{"faq":40,"how_to":41,"product":41},[],null,{},[44,48,52,55,58,61,64,66,68,70,72,75,77,79,81,83,86,88,90,92,94,97,99,101,103,105,108,110,112,114,116,119,121,123,125,127,130,132,134,136,138,141,143,145,147,149,152,154,156,158],{"level":45,"name":46,"anchor":47},1,"getMailboxList","getmailboxlist",{"level":49,"name":50,"anchor":51},2,"Description:","description",{"level":49,"name":53,"anchor":54},"Additional parameters","additional-parameters",{"level":49,"name":56,"anchor":57},"Call example:","call-example",{"level":49,"name":59,"anchor":60},"Response example:","response-example",{"level":45,"name":62,"anchor":63},"changeMailboxPassword","changemailboxpassword",{"level":49,"name":50,"anchor":65},"description-2",{"level":49,"name":53,"anchor":67},"additional-parameters-2",{"level":49,"name":56,"anchor":69},"call-example-2",{"level":49,"name":59,"anchor":71},"response-example-2",{"level":45,"name":73,"anchor":74},"createMailbox","createmailbox",{"level":49,"name":50,"anchor":76},"description-3",{"level":49,"name":53,"anchor":78},"additional-parameters-3",{"level":49,"name":56,"anchor":80},"call-example-3",{"level":49,"name":59,"anchor":82},"response-example-3",{"level":45,"name":84,"anchor":85},"dropMailbox","dropmailbox",{"level":49,"name":50,"anchor":87},"description-4",{"level":49,"name":53,"anchor":89},"additional-parameters-4",{"level":49,"name":56,"anchor":91},"call-example-4",{"level":49,"name":59,"anchor":93},"response-example-4",{"level":45,"name":95,"anchor":96},"changeMailboxSettings","changemailboxsettings",{"level":49,"name":50,"anchor":98},"description-5",{"level":49,"name":53,"anchor":100},"additional-parameters-5",{"level":49,"name":56,"anchor":102},"call-example-5",{"level":49,"name":59,"anchor":104},"response-example-5",{"level":45,"name":106,"anchor":107},"forwardListAddMailbox","forwardlistaddmailbox",{"level":49,"name":50,"anchor":109},"description-6",{"level":49,"name":53,"anchor":111},"additional-parameters-6",{"level":49,"name":56,"anchor":113},"call-example-6",{"level":49,"name":59,"anchor":115},"response-example-6",{"level":45,"name":117,"anchor":118},"forwardListDeleteMailbox","forwardlistdeletemailbox",{"level":49,"name":50,"anchor":120},"description-7",{"level":49,"name":53,"anchor":122},"additional-parameters-7",{"level":49,"name":56,"anchor":124},"call-example-7",{"level":49,"name":59,"anchor":126},"response-example-7",{"level":45,"name":128,"anchor":129},"forwardListShow","forwardlistshow",{"level":49,"name":50,"anchor":131},"description-8",{"level":49,"name":53,"anchor":133},"additional-parameters-8",{"level":49,"name":56,"anchor":135},"call-example-8",{"level":49,"name":59,"anchor":137},"response-example-8",{"level":45,"name":139,"anchor":140},"setDomainMail","setdomainmail",{"level":49,"name":50,"anchor":142},"description-9",{"level":49,"name":53,"anchor":144},"additional-parameters-9",{"level":49,"name":56,"anchor":146},"call-example-9",{"level":49,"name":59,"anchor":148},"response-example-9",{"level":45,"name":150,"anchor":151},"clearDomainMail","cleardomainmail",{"level":49,"name":50,"anchor":153},"description-10",{"level":49,"name":53,"anchor":155},"additional-parameters-10",{"level":49,"name":56,"anchor":157},"call-example-10",{"level":49,"name":59,"anchor":159},"response-example-10",[161],{"id":24,"title":25,"seo_metadata":162},{"title":27,"description":27,"header":27,"keywords":27},[164],{"route":165,"title":21},{"language":6,"path":31},[],[168,197,226,255,284,313,341,369,397,426,454,475],{"route":169,"uuid":170,"title":21,"excerpt":171,"content":27,"view_count":172,"published_at":173,"modified_at":174,"like":175,"category":177,"hero_image":184,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":185,"tags":186,"breadcrumbs":189,"images":196},{"language":6,"path":31},"df547ff6-f659-defa-43da-be7950d9648f","API (Application Programming Interface) is a software interface or a number of functions for the administration of websites, domains, mail etc. Mainly API is designed for programmers and developers, however it can be used by anybody.",18259,"2020-08-24T13:15:10+03:00","2024-11-01T15:10:09+03:00",{"count":176,"liked":17},28,{"route":178,"title":21,"tags":179,"breadcrumbs":182,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":183},{"language":6,"path":20},[180],{"id":24,"title":25,"seo_metadata":181},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[187],{"id":24,"title":25,"seo_metadata":188},{"title":27,"description":27,"header":27,"keywords":27},[190,194],{"route":191,"title":193},{"language":6,"path":192},"/kb","Knowledge Base",{"route":195,"title":21},{"language":6,"path":20},[],{"route":198,"uuid":200,"title":201,"excerpt":202,"content":27,"view_count":203,"published_at":204,"modified_at":205,"like":206,"category":208,"hero_image":215,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":216,"tags":217,"breadcrumbs":220,"images":225},{"language":6,"path":199},"/kb/api/basic-principles-of-operation-with-api","dcc80539-0440-0561-ee6a-1e61e2c6cf49","Basic principles of operation with API","Method of interaction Interaction with API is performed via HTTPS protocol. URL for method call looks as follows: Example: Parameter passing, mandatory parameters As we see from the previous example, two parameters have been passed to the method.",3589,"2020-08-24T13:47:32+03:00","2024-11-02T15:06:15+03:00",{"count":207,"liked":17},10,{"route":209,"title":21,"tags":210,"breadcrumbs":213,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":214},{"language":6,"path":20},[211],{"id":24,"title":25,"seo_metadata":212},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[218],{"id":24,"title":25,"seo_metadata":219},{"title":27,"description":27,"header":27,"keywords":27},[221,223],{"route":222,"title":193},{"language":6,"path":192},{"route":224,"title":21},{"language":6,"path":20},[],{"route":227,"uuid":229,"title":230,"excerpt":231,"content":27,"view_count":232,"published_at":233,"modified_at":234,"like":235,"category":237,"hero_image":244,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":245,"tags":246,"breadcrumbs":249,"images":254},{"language":6,"path":228},"/kb/api/account-administration-functions","6756ccc2-9f94-6777-5620-53ee46007e9d","Account administration functions","getAccountInfo Description: Method returns information on the user's tariff plan, on some parameters of the server, where the user is currently located and on the applied limits thereof. Call example: Response example: Some fields (e.g.",3671,"2020-08-24T14:11:20+03:00","2024-11-02T15:13:53+03:00",{"count":236,"liked":17},14,{"route":238,"title":21,"tags":239,"breadcrumbs":242,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":243},{"language":6,"path":20},[240],{"id":24,"title":25,"seo_metadata":241},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[247],{"id":24,"title":25,"seo_metadata":248},{"title":27,"description":27,"header":27,"keywords":27},[250,252],{"route":251,"title":193},{"language":6,"path":192},{"route":253,"title":21},{"language":6,"path":20},[],{"route":256,"uuid":258,"title":259,"excerpt":260,"content":27,"view_count":261,"published_at":262,"modified_at":263,"like":264,"category":266,"hero_image":273,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":274,"tags":275,"breadcrumbs":278,"images":283},{"language":6,"path":257},"/kb/api/backup-administration-functions","b572d380-43aa-8377-6dc4-75c6e962c586","Backup administration functions","getFileBackupList Description: Method returns available list of file backups. Call example: Response example: getMysqlBackupList Description: Method returns available list of mysql database backups Call example: Response example: getFileList Description: Method returns a list of files and directories from a backup according to the given path and identifier.",3201,"2020-08-24T15:06:32+03:00","2024-11-02T14:31:25+03:00",{"count":265,"liked":17},20,{"route":267,"title":21,"tags":268,"breadcrumbs":271,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":272},{"language":6,"path":20},[269],{"id":24,"title":25,"seo_metadata":270},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[276],{"id":24,"title":25,"seo_metadata":277},{"title":27,"description":27,"header":27,"keywords":27},[279,281],{"route":280,"title":193},{"language":6,"path":192},{"route":282,"title":21},{"language":6,"path":20},[],{"route":285,"uuid":287,"title":288,"excerpt":289,"content":27,"view_count":290,"published_at":291,"modified_at":292,"like":293,"category":295,"hero_image":302,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":303,"tags":304,"breadcrumbs":307,"images":312},{"language":6,"path":286},"/kb/api/cron-administration-functions","d3813f0c-4719-174a-2755-54bb15c0ba7a","Cron administration functions","getList Description: Method returns list of all CronTab tasks. Call example: Response example: Returns twodimensional array, each string whereof describes a Cron task.",3432,"2020-08-24T15:13:26+03:00","2026-02-02T15:27:34+03:00",{"count":294,"liked":17},7,{"route":296,"title":21,"tags":297,"breadcrumbs":300,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":301},{"language":6,"path":20},[298],{"id":24,"title":25,"seo_metadata":299},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[305],{"id":24,"title":25,"seo_metadata":306},{"title":27,"description":27,"header":27,"keywords":27},[308,310],{"route":309,"title":193},{"language":6,"path":192},{"route":311,"title":21},{"language":6,"path":20},[],{"route":314,"uuid":316,"title":317,"excerpt":318,"content":27,"view_count":319,"published_at":320,"modified_at":321,"like":322,"category":323,"hero_image":330,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":331,"tags":332,"breadcrumbs":335,"images":340},{"language":6,"path":315},"/kb/api/dns-administration-functions","a1a647c3-3003-f5c5-4739-78960db4e23b","DNS administration functions","getData Description: Method returns information about domain from DNS server. Additional parameters fqdn - full domain name (domain in national zones need to be passed in punycode).",4090,"2020-08-24T15:18:08+03:00","2026-02-02T15:26:58+03:00",{"count":16,"liked":17},{"route":324,"title":21,"tags":325,"breadcrumbs":328,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":329},{"language":6,"path":20},[326],{"id":24,"title":25,"seo_metadata":327},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[333],{"id":24,"title":25,"seo_metadata":334},{"title":27,"description":27,"header":27,"keywords":27},[336,338],{"route":337,"title":193},{"language":6,"path":192},{"route":339,"title":21},{"language":6,"path":20},[],{"route":342,"uuid":344,"title":345,"excerpt":346,"content":27,"view_count":347,"published_at":348,"modified_at":349,"like":350,"category":351,"hero_image":358,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":359,"tags":360,"breadcrumbs":363,"images":368},{"language":6,"path":343},"/kb/api/ftp-administration-functions","4b22aedc-ca66-c2bd-2b9e-d76508b4b481","FTP administration functions","getList Description: Method returns list of additional FTP accounts with their home directories. Call example: Response example: add Description: Method adds new FTP account.",3038,"2020-08-24T15:57:44+03:00","2026-02-02T15:26:39+03:00",{"count":236,"liked":17},{"route":352,"title":21,"tags":353,"breadcrumbs":356,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":357},{"language":6,"path":20},[354],{"id":24,"title":25,"seo_metadata":355},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[361],{"id":24,"title":25,"seo_metadata":362},{"title":27,"description":27,"header":27,"keywords":27},[364,366],{"route":365,"title":193},{"language":6,"path":192},{"route":367,"title":21},{"language":6,"path":20},[],{"route":370,"uuid":372,"title":373,"excerpt":374,"content":27,"view_count":375,"published_at":376,"modified_at":377,"like":378,"category":379,"hero_image":386,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":387,"tags":388,"breadcrumbs":391,"images":396},{"language":6,"path":371},"/kb/api/mysql-administration-functions","8ad151af-1d0c-a274-44b6-00d40b2c75a0","MySQL administration functions","getList Description: The method returns a list of MySQL databases with their accesses. Call example: Response example: addDb Description: The method adds a job to the queue for creating a new MySql database with the specified suffix and creates access for localhost with the specified password.",2737,"2020-08-24T16:08:24+03:00","2024-11-02T14:58:49+03:00",{"count":207,"liked":17},{"route":380,"title":21,"tags":381,"breadcrumbs":384,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":385},{"language":6,"path":20},[382],{"id":24,"title":25,"seo_metadata":383},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[389],{"id":24,"title":25,"seo_metadata":390},{"title":27,"description":27,"header":27,"keywords":27},[392,394],{"route":393,"title":193},{"language":6,"path":192},{"route":395,"title":21},{"language":6,"path":20},[],{"route":398,"uuid":400,"title":401,"excerpt":402,"content":27,"view_count":403,"published_at":404,"modified_at":405,"like":406,"category":408,"hero_image":415,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":416,"tags":417,"breadcrumbs":420,"images":425},{"language":6,"path":399},"/kb/api/website-administration-functions","b4321a42-9db5-54cc-4c0d-988b44eaee57","Website administration functions","getList Description: Method returns website list. If domains are linked to website, they will also be returned.",2758,"2020-08-24T16:24:07+03:00","2026-02-02T15:25:51+03:00",{"count":407,"liked":17},6,{"route":409,"title":21,"tags":410,"breadcrumbs":413,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":414},{"language":6,"path":20},[411],{"id":24,"title":25,"seo_metadata":412},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[418],{"id":24,"title":25,"seo_metadata":419},{"title":27,"description":27,"header":27,"keywords":27},[421,423],{"route":422,"title":193},{"language":6,"path":192},{"route":424,"title":21},{"language":6,"path":20},[],{"route":427,"uuid":429,"title":430,"excerpt":431,"content":27,"view_count":432,"published_at":433,"modified_at":434,"like":435,"category":436,"hero_image":443,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":444,"tags":445,"breadcrumbs":448,"images":453},{"language":6,"path":428},"/kb/api/functions-for-work-with-domains","fd520634-63f3-f088-3265-075f2363c99f","Functions for work with domains","getList Description: Method returns list of domains on user account. Call example: Response example: getZoneList Description: Method returns zone list.",3265,"2020-08-24T17:10:33+03:00","2026-02-02T15:23:34+03:00",{"count":207,"liked":17},{"route":437,"title":21,"tags":438,"breadcrumbs":441,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":442},{"language":6,"path":20},[439],{"id":24,"title":25,"seo_metadata":440},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[446],{"id":24,"title":25,"seo_metadata":447},{"title":27,"description":27,"header":27,"keywords":27},[449,451],{"route":450,"title":193},{"language":6,"path":192},{"route":452,"title":21},{"language":6,"path":20},[],{"route":455,"uuid":8,"title":9,"excerpt":10,"content":27,"view_count":12,"published_at":13,"modified_at":14,"like":456,"category":457,"hero_image":464,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":465,"tags":466,"breadcrumbs":469,"images":474},{"language":6,"path":7},{"count":16,"liked":17},{"route":458,"title":21,"tags":459,"breadcrumbs":462,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":463},{"language":6,"path":20},[460],{"id":24,"title":25,"seo_metadata":461},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[467],{"id":24,"title":25,"seo_metadata":468},{"title":27,"description":27,"header":27,"keywords":27},[470,472],{"route":471,"title":193},{"language":6,"path":192},{"route":473,"title":21},{"language":6,"path":20},[],{"route":476,"uuid":478,"title":479,"excerpt":480,"content":27,"view_count":481,"published_at":482,"modified_at":483,"like":484,"category":486,"hero_image":493,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":494,"tags":495,"breadcrumbs":498,"images":503},{"language":6,"path":477},"/kb/api/functions-for-statistic-census","ac183fcd-50bb-3691-5856-ea2e540ad8e2","Functions for statistic census","getSiteListLoad Description: Method returns information about the average load on user websites within the last month. Call example: Response example: Returns website list and average load thereof (in descending order) ID - the website id is unique within one user.",2368,"2020-08-24T18:26:50+03:00","2026-02-02T15:21:15+03:00",{"count":485,"liked":17},3,{"route":487,"title":21,"tags":488,"breadcrumbs":491,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":492},{"language":6,"path":20},[489],{"id":24,"title":25,"seo_metadata":490},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[496],{"id":24,"title":25,"seo_metadata":497},{"title":27,"description":27,"header":27,"keywords":27},[499,501],{"route":500,"title":193},{"language":6,"path":192},{"route":502,"title":21},{"language":6,"path":20},[],[],0,"popularity-desc"]