[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"/en/kb/api/functions-for-work-with-domainsKbData":3},{"page":4,"pages":197,"recommendedPages":534,"category":41,"categoryTree":41,"total":535,"currentOrder":536,"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":190,"breadcrumbs":193,"images":196},{"language":6,"path":7},"en","/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.","\n\u003Ch2 id=\"getlist\">getList\u003C/h2>\n\n\n\n\u003Ch3 id=\"description\">Description:\u003C/h3>\n\n\n\n\u003Cp>Method returns list of domains on user account.\u003C/p>\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>https://api.beget.com/api/domain/getList?login=userlogin&\npasswd=password&output_format=json\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      \"id\":\"132456\",                    // domain ID    \n  \n      \"fqdn\":\"mylogin.bget.de\",         // full domain name      \n\n      \"date_add\":\"2011-10-24 15:01:40\", // date and time of domain creation\n\n      \"auto_renew\":\"0\",                 // \"automatic domain renewal\"  \n                                        // option status\n\n      \"date_register\":\"2011-10-24\",     // domain registration date\n                                        // (if under BeGet administration)\n\n      \"date_expire\":0,                  // expiration date of delegation \n                                        // (if under BeGet administration)\n\n      \"can_renew\":\"0\",                  // renewal possibility status\n\n      \"registrar\":null,                 // domain name registrar \n                                        // (if under BeGet administration)\n\n      \"registrar_status\":null,          // domain status at registrar \n                                        // (if under BeGet administration). \n                                        // Can be: <em>delegated, not_active, \n                                        // undelegated</em>\n\n      \"register_order_status\":null,     // status of domain registration order \n                                        // (if domain was added to  \n                                        // its registration order). \n                                        // Can be: <em>new, registred, delete</em>\n\n      \"register_order_comment\":null,    // comment on registration order \n                                        // (mostly comment \n                                        // on reasons of order annulment)\n\n      \"renew_order_status\":\"0\",         // status of domain renewal order. \n                                        // Can be: <em>pending, delete, \n                                        // canceled error, success</em>\n\n      \"is_under_control\":0              // Status shows if domain \n                                        // is under BeGet administration. \n                                        // Defines possibility of operations, such as: \n                                        // domain renewal,\n                                        // ordering add. services from registrar, \n                                        // DNS server change\n   }\n]\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch2 id=\"getzonelist\">getZoneList\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-2\">Description:\u003C/h3>\n\n\n\n\u003Cp>Method returns zone list.\u003C/p>\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>https://api.beget.com/api/domain/getZoneList?login=userlogin&\npasswd=password&output_format=json\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>{\n   \"de\":{\n      \"id\":\"1\",               // zone ID\n      \"zone\":\"de\",            // zone name\n      \"price\":\"120\",          // price of domain registration in zone\n      \"price_renew\":\"120\",    // price of domain renewal in zone\n      \"price_idn\":null,       // price of IDN domain registration in zone\n      \"price_idn_renew\":null, // price of IDN domain renewal in zone\n      \"is_idn\":\"0\",           // does the zone support IDN domains\n      \"is_national\":\"1\",      // is the zone national\n      \"min_period\":\"1\",       // minimum domain registration period (in years)\n      \"max_period\":\"1\"        // maximum domain registration period (in years)\n   },\n}\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch2 id=\"addvirtual\">addVirtual\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-3\">Description:\u003C/h3>\n\n\n\n\u003Cp>Method adds domain.\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters\">Additional parameters\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>hostname\u003C/strong> - domain name without zone (e.g. domain);\u003C/li>\u003Cli>\u003Cstrong>zone_id\u003C/strong> - zone id, type int;\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/domain/addVirtual?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data={\"hostname\":\"domain\",\"zone_id\": 1}\n\n// correct call example, input_data is coded with urlencode\nhttps://api.beget.com/api/domain/addVirtual?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data=%7B%22hostname%22%3A%22domain%22%2C%22zone_id%22%3A+1%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> 12510\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Cp>Returns ID of added domain.\u003C/p>\n\n\n\n\u003Ch2 id=\"delete\">delete\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-4\">Description:\u003C/h3>\n\n\n\n\u003Cp>Method deletes domain. If the domain was linked to a website, it will be unlinked from it. All subdomains of this domain will be deleted.\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters-2\">Additional parameters\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>id\u003C/strong> - domain ID;\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/domain/delete?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data={\"id\":12510}\n\n// correct call example, input_data is coded with urlencode\nhttps://api.beget.com/api/domain/delete?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data=%7B%22id%22%3A12510%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=\"getsubdomainlist\">getSubdomainList\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-5\">Description:\u003C/h3>\n\n\n\n\u003Cp>Method returns subdomain list.\u003C/p>\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>https://api.beget.com/api/domain/getSubdomainList?login=userlogin&\npasswd=password&output_format=json\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>[\n   {\n      \"id\":\"132456\",                // subdomain ID\n      \"fqdn\":\"subodmain.domain.de\", // full subdomain name\n      \"domain_id\":\"12345\"           // parent domain ID\n   },\n   {\n      \"id\":\"123457\",\n      \"fqdn\":\"user.forum.domain.com\",\n      \"domain_id\":\"12347\"\n   }\n]\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch2 id=\"addsubdomainvirtual\">addSubdomainVirtual\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-6\">Description:\u003C/h3>\n\n\n\n\u003Cp>Method adds given subdomain.\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters-3\">Additional parameters\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>subdomain\u003C/strong> - subdomain name;\u003C/li>\u003Cli>\u003Cstrong>domain_id\u003C/strong> - parent domain ID;\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/domain/addSubdomainVirtual?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data={\"subdomain\": \"subdomain\",\"domain_id\": 1000}\n\n// correct call example, input_data is coded with urlencode\nhttps://api.beget.com/api/domain/addSubdomainVirtual?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data=%7B%22subdomain%22%3A+%22subdomain\n%22%2C%22domain_id%22%3A+1000%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> 12345\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Cp>Returns ID of added subdomain.\u003C/p>\n\n\n\n\u003Ch2 id=\"deletesubdomain\">deleteSubdomain\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-7\">Description:\u003C/h3>\n\n\n\n\u003Cp>Method deletes given subdomain.\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters-4\">Additional parameters\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>id\u003C/strong> - subdomain id.\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/domain/deleteSubdomain?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data={\"id\": 1000}\n\n// correct call example, input_data is coded with urlencode\nhttps://api.beget.com/api/domain/deleteSubdomain?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data=%7B%22id%22%3A+1000%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=\"checkdomaintoregister\">checkDomainToRegister\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-8\">Description:\u003C/h3>\n\n\n\n\u003Cp>Method returns information about registration possibility for given domain name.\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters-5\">Additional parameters\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>hostname\u003C/strong> - domain name without zone;\u003C/li>\u003Cli>\u003Cstrong>zone_id\u003C/strong> - zone ID, you can receive a zone list through the method getZoneList;\u003C/li>\u003Cli>\u003Cstrong>period\u003C/strong> - registration period (in years), type int.\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/domain/checkDomainToRegister?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data={\"hostname\": \"domain\", \"zone_id\": 3, \"period\":1}\n\n// correct call example, input_data is coded with urlencode\nhttps://api.beget.com/api/domain/checkDomainToRegister?login=userlogin&\npasswd=password&input_format=json&output_format=json&\ninput_data=%7B%22hostname%22%3A+%22domain%22%2C+%22zone_id\n%22%3A+3%2C+%22period%22%3A1%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   \"may_be_registered\":true, // is the domain available for registration \n                             // (based on WHOIS service)\n\n   \"bonus_domains\":0,        // current number of bonus domains \n                             // on account in selected zone\n\n   \"balance\":289.46,         // current account balance\n\n   \"pay_type\":null,          // payment type for domain registration. Can be:\n                             // <em>null</em> - domain cannot be paid;\n                             // <em>money</em> - payment will be performed from account balance;\n                             // <em>bonus_domain</em> - payment will be performed on expense of a bonus.\n                                                   \n   \"price\":350,              // total price of domain registration \n                             // (considering the period)\n\n   \"in_system\":false         // does such a domain already exist \n                             // in the BeGet system\n}\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch3 id=\"annotation\">Annotation:\u003C/h3>\n\n\n\n\u003Cp>For a final decision about the possibility of registering the domain three fields must be analyzed: \u003Cem>may_be_registered, pay_type и in_system\u003C/em>\u003C/p>\n\n\n\n\u003Cp>Required values:\u003C/p>\n\n\n\n\u003Cul>\u003Cli>may_be_registered - \u003Cem>true\u003C/em>\u003C/li>\u003Cli>pay_type - \u003Cem>money\u003C/em> or \u003Cem>bonus_domain\u003C/em>\u003C/li>\u003Cli>in_system - \u003Cem>false\u003C/em>\u003C/li>\u003C/ul>\n\n\n\n\u003Cp>When making an application for domain registration, you will need to pass the \u003Cem>pay_type\u003C/em>, which was returned by the method.\u003C/p>\n\n\n\n\u003Ch2 id=\"getphpversion\">getPhpVersion\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-9\">Description:\u003C/h3>\n\n\n\n\u003Cp>The method returns information about the current version of php for the domain, whether php is enabled as cgi and php versions available for installation\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters-6\">Additional parameters:\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>full_fqdn\u003C/strong> - the full name of the domain for which you want to get information;\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>http://api.beget.com/api/domain/getPhpVersion?login=usrlogin&passwd=usrpasswd&full_fqdn=foobar.com&output_format=json\n\nhttps://api.beget.com/api/domain/getPhpVersion?login%3Dusrlogin%26passwd%3Dusrpasswd%26full_fqdn%3Dfoobar.com%26output_format%3Djson\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>\"status\": \"success\",\n    \"answer\": {\n        \"status\": \"success\",\n        \"result\": {\n            \"full_fqdn\": \"foobar.com\",\n            \"php_version\": \"5.6\",\n            \"cgi\": \"disabled\",\n            \"allowed_versions\": [\n                \"4.4\",\n                \"5.2\",\n                \"5.3\",\n                \"5.4\",\n                \"5.5\",\n                \"5.6\"\n            ]\n        }\n    }\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch2 id=\"changephpversion\">changePhpVersion\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-10\">Description:\u003C/h3>\n\n\n\n\u003Cp>The method changes the php version to the transferred one. Allows you to set and remove cgi mode\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters-7\">Additional parameters:\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>full_fqdn\u003C/strong> - the full name of the domain for which you want to change the version of php;\u003C/li>\u003Cli>\u003Cstrong>php_version\u003C/strong> - version of php to be modified;\u003C/li>\u003Cli>\u003Cstrong>is_cgi\u003C/strong> - set or remove cgi mode. Defaults to false;\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>https://api.beget.com/api/domain/changePhpVersion?login=userlogin&passwd=password&output_format=json&input_format=json&input_data={\"full_fqdn\": \"example.com\", \"php_version\": \"5.4\"}\n\nhttps://api.beget.com/api/domain/changePhpVersion?login=userlogin&passwd=password&full_fqdn=example.com&php_version=5.4&is_cgi=true&output_format=json\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>\"status\": \"success\",\n\"answer\": {\n    \"status\": \"success\",\n    \"result\": {\n        \"full_fqdn\": \"example.com\", // domain with which php version and cgi mode were changed\n        \"result\": \"changes will take effect in some time\", // changes may take some time\n        \"php_version\": \"5.4\", // version of php after the current request\n        \"cgi\": \"enabled\" // is cgi mode enabled\n    }\n}\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch2 id=\"getdirectives\">getDirectives\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-11\">Description:\u003C/h3>\n\n\n\n\u003Cp>The method returns custom directives for the specified domain\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters-8\">Additional parameters:\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>full_fqdn\u003C/strong> - full domain name;\u003C/li>\u003C/ul>\n\n\n\n\u003Ch3 id=\"call-example-11\">Call example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":""}\">\u003Ccode>https://api.beget.com/api/domain/getDirectives?login=userlogin&passwd=password&output_format=json&input_format=json&input_data={\"full_fqdn\": \"example.com\"}\n\nhttps://api.beget.com/api/domain/getDirectives?login=userlogin&passwd=password&full_fqdn=example.com&output_format=json\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch3 id=\"response-example-11\">Response example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":"javascript"}\">\u003Ccode>\"status\": \"success\",\n\"answer\": {\n    \"status\": \"success\",\n    \"result\": [ // directive array\n        {\n            \"name\": \"php_admin_value\", // directive name\n            \"value\": \"session.save_handler redis\"  // its meaning\n        }\n    ]\n}\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch2 id=\"adddirectives\">addDirectives\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-12\">Description:\u003C/h3>\n\n\n\n\u003Cp>The method adds custom directives for the specified domain\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters-9\">Additional parameters:\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>full_fqdn\u003C/strong> - full domain name;\u003C/li>\u003Cli>\u003Cstrong>directives_list\u003C/strong> - array of directives in the format:\u003C/li>\u003C/ul>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":"javascript"}\">\u003Ccode>[\n    {\n        name: \"name of directive\",\n        value: \"value of directive\"\n    }\n]\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch3 id=\"call-example-12\">Call example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":""}\">\u003Ccode>https://api.beget.com/api/domain/addDirectives?login=userlogin&passwd=password&output_format=json&full_fqdn=example.com&directives_list[0][name]=php_flag&directives_list[0][value]=log_errors on\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch3 id=\"response-example-12\">Response example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":"javascript"}\">\u003Ccode>\"status\":\"success\",\n\"answer\": {\n    \"status\": \"success\",\n    \"result\":true\n}\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch2 id=\"removedirectives\">removeDirectives\u003C/h2>\n\n\n\n\u003Ch3 id=\"description-13\">Description:\u003C/h3>\n\n\n\n\u003Cp>The method removes user directives for the specified domain\u003C/p>\n\n\n\n\u003Ch3 id=\"additional-parameters-10\">Additional parameters:\u003C/h3>\n\n\n\n\u003Cul>\u003Cli>\u003Cstrong>full_fqdn\u003C/strong> - full domain name;\u003C/li>\u003Cli>\u003Cstrong>directives_list\u003C/strong> - array of directives in the format:\u003C/li>\u003C/ul>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":"javascript"}\">\u003Ccode>[\n    {\n        name: \"name of directive\",\n        value: \"value of directive\"\n    }\n]\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch3 id=\"call-example-13\">Call example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":""}\">\u003Ccode>https://api.beget.com/api/domain/removeDirectives?login=userlogin&passwd=password&output_format=json&full_fqdn=example.com&directives_list[0][name]=php_flag&directives_list[0][value]=log_errors on\u003C/code>\u003C/pre>\u003C/div>\n\n\n\n\u003Ch3 id=\"response-example-13\">Response example:\u003C/h3>\n\n\n\n\u003Cdiv class=\"wp-block-beget-code code-block\">\u003Cpre data-options=\"{"mode":"javascript"}\">\u003Ccode>\"status\":\"success\",\n\"answer\": {\n    \"status\": \"success\",\n    \"result\":true\n}\u003C/code>\u003C/pre>\u003C/div>\n",3265,"2020-08-24T17:10:33+03:00","2026-02-02T15:23:34+03:00",{"count":16,"liked":17},10,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 about API functions for working with domains in Beget hosting","api domain",{"faq":40,"how_to":41,"product":41},[],null,{},[44,48,52,55,58,61,63,65,67,70,72,75,77,79,81,83,85,87,89,92,94,96,98,101,103,105,107,109,112,114,116,118,120,123,125,127,129,131,134,137,139,142,144,146,149,151,153,155,157,160,162,164,166,168,171,173,175,177,179,182,184,186,188],{"level":45,"name":46,"anchor":47},1,"getList","getlist",{"level":49,"name":50,"anchor":51},2,"Description:","description",{"level":49,"name":53,"anchor":54},"Call example:","call-example",{"level":49,"name":56,"anchor":57},"Response example:","response-example",{"level":45,"name":59,"anchor":60},"getZoneList","getzonelist",{"level":49,"name":50,"anchor":62},"description-2",{"level":49,"name":53,"anchor":64},"call-example-2",{"level":49,"name":56,"anchor":66},"response-example-2",{"level":45,"name":68,"anchor":69},"addVirtual","addvirtual",{"level":49,"name":50,"anchor":71},"description-3",{"level":49,"name":73,"anchor":74},"Additional parameters","additional-parameters",{"level":49,"name":53,"anchor":76},"call-example-3",{"level":49,"name":56,"anchor":78},"response-example-3",{"level":45,"name":80,"anchor":80},"delete",{"level":49,"name":50,"anchor":82},"description-4",{"level":49,"name":73,"anchor":84},"additional-parameters-2",{"level":49,"name":53,"anchor":86},"call-example-4",{"level":49,"name":56,"anchor":88},"response-example-4",{"level":45,"name":90,"anchor":91},"getSubdomainList","getsubdomainlist",{"level":49,"name":50,"anchor":93},"description-5",{"level":49,"name":53,"anchor":95},"call-example-5",{"level":49,"name":56,"anchor":97},"response-example-5",{"level":45,"name":99,"anchor":100},"addSubdomainVirtual","addsubdomainvirtual",{"level":49,"name":50,"anchor":102},"description-6",{"level":49,"name":73,"anchor":104},"additional-parameters-3",{"level":49,"name":53,"anchor":106},"call-example-6",{"level":49,"name":56,"anchor":108},"response-example-6",{"level":45,"name":110,"anchor":111},"deleteSubdomain","deletesubdomain",{"level":49,"name":50,"anchor":113},"description-7",{"level":49,"name":73,"anchor":115},"additional-parameters-4",{"level":49,"name":53,"anchor":117},"call-example-7",{"level":49,"name":56,"anchor":119},"response-example-7",{"level":45,"name":121,"anchor":122},"checkDomainToRegister","checkdomaintoregister",{"level":49,"name":50,"anchor":124},"description-8",{"level":49,"name":73,"anchor":126},"additional-parameters-5",{"level":49,"name":53,"anchor":128},"call-example-8",{"level":49,"name":56,"anchor":130},"response-example-8",{"level":49,"name":132,"anchor":133},"Annotation:","annotation",{"level":45,"name":135,"anchor":136},"getPhpVersion","getphpversion",{"level":49,"name":50,"anchor":138},"description-9",{"level":49,"name":140,"anchor":141},"Additional parameters:","additional-parameters-6",{"level":49,"name":53,"anchor":143},"call-example-9",{"level":49,"name":56,"anchor":145},"response-example-9",{"level":45,"name":147,"anchor":148},"changePhpVersion","changephpversion",{"level":49,"name":50,"anchor":150},"description-10",{"level":49,"name":140,"anchor":152},"additional-parameters-7",{"level":49,"name":53,"anchor":154},"call-example-10",{"level":49,"name":56,"anchor":156},"response-example-10",{"level":45,"name":158,"anchor":159},"getDirectives","getdirectives",{"level":49,"name":50,"anchor":161},"description-11",{"level":49,"name":140,"anchor":163},"additional-parameters-8",{"level":49,"name":53,"anchor":165},"call-example-11",{"level":49,"name":56,"anchor":167},"response-example-11",{"level":45,"name":169,"anchor":170},"addDirectives","adddirectives",{"level":49,"name":50,"anchor":172},"description-12",{"level":49,"name":140,"anchor":174},"additional-parameters-9",{"level":49,"name":53,"anchor":176},"call-example-12",{"level":49,"name":56,"anchor":178},"response-example-12",{"level":45,"name":180,"anchor":181},"removeDirectives","removedirectives",{"level":49,"name":50,"anchor":183},"description-13",{"level":49,"name":140,"anchor":185},"additional-parameters-10",{"level":49,"name":53,"anchor":187},"call-example-13",{"level":49,"name":56,"anchor":189},"response-example-13",[191],{"id":24,"title":25,"seo_metadata":192},{"title":27,"description":27,"header":27,"keywords":27},[194],{"route":195,"title":21},{"language":6,"path":31},[],[198,227,255,284,313,342,371,399,427,456,477,505],{"route":199,"uuid":200,"title":21,"excerpt":201,"content":27,"view_count":202,"published_at":203,"modified_at":204,"like":205,"category":207,"hero_image":214,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":215,"tags":216,"breadcrumbs":219,"images":226},{"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":206,"liked":17},28,{"route":208,"title":21,"tags":209,"breadcrumbs":212,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":213},{"language":6,"path":20},[210],{"id":24,"title":25,"seo_metadata":211},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[217],{"id":24,"title":25,"seo_metadata":218},{"title":27,"description":27,"header":27,"keywords":27},[220,224],{"route":221,"title":223},{"language":6,"path":222},"/kb","Knowledge Base",{"route":225,"title":21},{"language":6,"path":20},[],{"route":228,"uuid":230,"title":231,"excerpt":232,"content":27,"view_count":233,"published_at":234,"modified_at":235,"like":236,"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":229},"/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":16,"liked":17},{"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":223},{"language":6,"path":222},{"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/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":265,"liked":17},14,{"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":223},{"language":6,"path":222},{"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/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":294,"liked":17},20,{"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":223},{"language":6,"path":222},{"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":324,"hero_image":331,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":332,"tags":333,"breadcrumbs":336,"images":341},{"language":6,"path":315},"/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":323,"liked":17},7,{"route":325,"title":21,"tags":326,"breadcrumbs":329,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":330},{"language":6,"path":20},[327],{"id":24,"title":25,"seo_metadata":328},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[334],{"id":24,"title":25,"seo_metadata":335},{"title":27,"description":27,"header":27,"keywords":27},[337,339],{"route":338,"title":223},{"language":6,"path":222},{"route":340,"title":21},{"language":6,"path":20},[],{"route":343,"uuid":345,"title":346,"excerpt":347,"content":27,"view_count":348,"published_at":349,"modified_at":350,"like":351,"category":353,"hero_image":360,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":361,"tags":362,"breadcrumbs":365,"images":370},{"language":6,"path":344},"/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":352,"liked":17},22,{"route":354,"title":21,"tags":355,"breadcrumbs":358,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":359},{"language":6,"path":20},[356],{"id":24,"title":25,"seo_metadata":357},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[363],{"id":24,"title":25,"seo_metadata":364},{"title":27,"description":27,"header":27,"keywords":27},[366,368],{"route":367,"title":223},{"language":6,"path":222},{"route":369,"title":21},{"language":6,"path":20},[],{"route":372,"uuid":374,"title":375,"excerpt":376,"content":27,"view_count":377,"published_at":378,"modified_at":379,"like":380,"category":381,"hero_image":388,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":389,"tags":390,"breadcrumbs":393,"images":398},{"language":6,"path":373},"/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":265,"liked":17},{"route":382,"title":21,"tags":383,"breadcrumbs":386,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":387},{"language":6,"path":20},[384],{"id":24,"title":25,"seo_metadata":385},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[391],{"id":24,"title":25,"seo_metadata":392},{"title":27,"description":27,"header":27,"keywords":27},[394,396],{"route":395,"title":223},{"language":6,"path":222},{"route":397,"title":21},{"language":6,"path":20},[],{"route":400,"uuid":402,"title":403,"excerpt":404,"content":27,"view_count":405,"published_at":406,"modified_at":407,"like":408,"category":409,"hero_image":416,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":417,"tags":418,"breadcrumbs":421,"images":426},{"language":6,"path":401},"/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":16,"liked":17},{"route":410,"title":21,"tags":411,"breadcrumbs":414,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":415},{"language":6,"path":20},[412],{"id":24,"title":25,"seo_metadata":413},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[419],{"id":24,"title":25,"seo_metadata":420},{"title":27,"description":27,"header":27,"keywords":27},[422,424],{"route":423,"title":223},{"language":6,"path":222},{"route":425,"title":21},{"language":6,"path":20},[],{"route":428,"uuid":430,"title":431,"excerpt":432,"content":27,"view_count":433,"published_at":434,"modified_at":435,"like":436,"category":438,"hero_image":445,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":446,"tags":447,"breadcrumbs":450,"images":455},{"language":6,"path":429},"/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":437,"liked":17},6,{"route":439,"title":21,"tags":440,"breadcrumbs":443,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":444},{"language":6,"path":20},[441],{"id":24,"title":25,"seo_metadata":442},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[448],{"id":24,"title":25,"seo_metadata":449},{"title":27,"description":27,"header":27,"keywords":27},[451,453],{"route":452,"title":223},{"language":6,"path":222},{"route":454,"title":21},{"language":6,"path":20},[],{"route":457,"uuid":8,"title":9,"excerpt":10,"content":27,"view_count":12,"published_at":13,"modified_at":14,"like":458,"category":459,"hero_image":466,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":467,"tags":468,"breadcrumbs":471,"images":476},{"language":6,"path":7},{"count":16,"liked":17},{"route":460,"title":21,"tags":461,"breadcrumbs":464,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":465},{"language":6,"path":20},[462],{"id":24,"title":25,"seo_metadata":463},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[469],{"id":24,"title":25,"seo_metadata":470},{"title":27,"description":27,"header":27,"keywords":27},[472,474],{"route":473,"title":223},{"language":6,"path":222},{"route":475,"title":21},{"language":6,"path":20},[],{"route":478,"uuid":480,"title":481,"excerpt":482,"content":27,"view_count":483,"published_at":484,"modified_at":485,"like":486,"category":487,"hero_image":494,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":495,"tags":496,"breadcrumbs":499,"images":504},{"language":6,"path":479},"/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.",3335,"2020-08-24T18:20:05+03:00","2026-02-02T15:22:31+03:00",{"count":352,"liked":17},{"route":488,"title":21,"tags":489,"breadcrumbs":492,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":493},{"language":6,"path":20},[490],{"id":24,"title":25,"seo_metadata":491},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[497],{"id":24,"title":25,"seo_metadata":498},{"title":27,"description":27,"header":27,"keywords":27},[500,502],{"route":501,"title":223},{"language":6,"path":222},{"route":503,"title":21},{"language":6,"path":20},[],{"route":506,"uuid":508,"title":509,"excerpt":510,"content":27,"view_count":511,"published_at":512,"modified_at":513,"like":514,"category":516,"hero_image":523,"seo_metadata":41,"schema_org_metadata":41,"open_graph_metadata":41,"sections":524,"tags":525,"breadcrumbs":528,"images":533},{"language":6,"path":507},"/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":515,"liked":17},3,{"route":517,"title":21,"tags":518,"breadcrumbs":521,"uuid":29,"parent_uuid":30,"default_page_path":31,"seo_metadata":522},{"language":6,"path":20},[519],{"id":24,"title":25,"seo_metadata":520},{"title":27,"description":27,"header":27,"keywords":27},[],{"title":33,"description":34,"header":27,"keywords":27},{"src":27,"text":27},[],[526],{"id":24,"title":25,"seo_metadata":527},{"title":27,"description":27,"header":27,"keywords":27},[529,531],{"route":530,"title":223},{"language":6,"path":222},{"route":532,"title":21},{"language":6,"path":20},[],[],0,"popularity-desc"]