Functions for work with domains

getList

Description:

Method returns list of domains on user account.

Call example:
https://api.beget.de/api/domain/getList?login=userlogin&
passwd=password&output_format=json
Response example:
[
   {
      "id":"132456",                    // domain ID    
  
      "fqdn":"mylogin.bget.de",         // full domain name      

      "date_add":"2011-10-24 15:01:40", // date and time of domain creation

      "auto_renew":"0",                 // "automatic domain renewal"  
                                        // option status

      "date_register":"2011-10-24",     // domain registration date
                                        // (if under BeGet administration)

      "date_expire":0,                  // expiration date of delegation 
                                        // (if under BeGet administration)

      "can_renew":"0",                  // renewal possibility status

      "registrar":null,                 // domain name registrar 
                                        // (if under BeGet administration)

      "registrar_status":null,          // domain status at registrar 
                                        // (if under BeGet administration). 
                                        // Can be: <em>delegated, not_active, 
                                        // undelegated</em>

      "register_order_status":null,     // status of domain registration order 
                                        // (if domain was added to  
                                        // its registration order). 
                                        // Can be: <em>new, registred, delete</em>

      "register_order_comment":null,    // comment on registration order 
                                        // (mostly comment 
                                        // on reasons of order annulment)

      "renew_order_status":"0",         // status of domain renewal order. 
                                        // Can be: <em>pending, delete, 
                                        // canceled error, success</em>

      "is_under_control":0              // Status shows if domain 
                                        // is under BeGet administration. 
                                        // Defines possibility of operations, such as: 
                                        // domain renewal,
                                        // ordering add. services from registrar, 
                                        // DNS server change
   }
]

getZoneList

Description:

Method returns zone list.

Call example:
https://api.beget.de/api/domain/getZoneList?login=userlogin&
passwd=password&output_format=json
Response example:
{
   "de":{
      "id":"1",               // zone ID
      "zone":"de",            // zone name
      "price":"120",          // price of domain registration in zone
      "price_renew":"120",    // price of domain renewal in zone
      "price_idn":null,       // price of IDN domain registration in zone
      "price_idn_renew":null, // price of IDN domain renewal in zone
      "is_idn":"0",           // does the zone support IDN domains
      "is_national":"1",      // is the zone national
      "min_period":"1",       // minimum domain registration period (in years)
      "max_period":"1"        // maximum domain registration period (in years)
   },
}

addVirtual

Description:

Method adds domain.

Additional parameters
  • hostname - domain name without zone (e.g. domain);
  • zone_id - zone id, type int;
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/domain/addVirtual?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"hostname":"domain","zone_id": 1}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/domain/addVirtual?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22hostname%22%3A%22domain%22%2C%22zone_id%22%3A+1%7D
Response example:
 12510

Returns ID of added domain.

delete

Description:

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.

Additional parameters
  • id - domain ID;
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/domain/delete?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"id":12510}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/domain/delete?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22id%22%3A12510%7D
Response example:
 true

Returns property of successful or unsuccessful execution.

getSubdomainList

Description:

Method returns subdomain list.

Call example:
https://api.beget.de/api/domain/getSubdomainList?login=userlogin&
passwd=password&output_format=json
Response example:
[
   {
      "id":"132456",                // subdomain ID
      "fqdn":"subodmain.domain.de", // full subdomain name
      "domain_id":"12345"           // parent domain ID
   },
   {
      "id":"123457",
      "fqdn":"user.forum.domain.com",
      "domain_id":"12347"
   }
]

addSubdomainVirtual

Description:

Method adds given subdomain.

Additional parameters
  • subdomain - subdomain name;
  • domain_id - parent domain ID;
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/domain/addSubdomainVirtual?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"subdomain": "subdomain","domain_id": 1000}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/domain/addSubdomainVirtual?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22subdomain%22%3A+%22subdomain
%22%2C%22domain_id%22%3A+1000%7D
Response example:
 12345

Returns ID of added subdomain.

deleteSubdomain

Description:

Method deletes given subdomain.

Additional parameters
  • id - subdomain id.
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/domain/deleteSubdomain?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"id": 1000}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/domain/deleteSubdomain?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22id%22%3A+1000%7D
Response example:
 true

Returns property of successful or unsuccessful execution.

checkDomainToRegister

Description:

Method returns information about registration possibility for given domain name.

Additional parameters
  • hostname - domain name without zone;
  • zone_id - zone ID, you can receive a zone list through the method getZoneList;
  • period - registration period (in years), type int.
Call example:
// for illustration purposes input_data is presented in uncoded form
https://api.beget.de/api/domain/checkDomainToRegister?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data={"hostname": "domain", "zone_id": 3, "period":1}

// correct call example, input_data is coded with urlencode
https://api.beget.de/api/domain/checkDomainToRegister?login=userlogin&
passwd=password&input_format=json&output_format=json&
input_data=%7B%22hostname%22%3A+%22domain%22%2C+%22zone_id
%22%3A+3%2C+%22period%22%3A1%7D
Response example:
{
   "may_be_registered":true, // is the domain available for registration 
                             // (based on WHOIS service)

   "bonus_domains":0,        // current number of bonus domains 
                             // on account in selected zone

   "balance":289.46,         // current account balance

   "pay_type":null,          // payment type for domain registration. Can be:
                             // <em>null</em> - domain cannot be paid;
                             // <em>money</em> - payment will be performed from account balance;
                             // <em>bonus_domain</em> - payment will be performed on expense of a bonus.
                                                   
   "price":350,              // total price of domain registration 
                             // (considering the period)

   "in_system":false         // does such a domain already exist 
                             // in the BeGet system
}
Annotation:

For a final decision about the possibility of registering the domain three fields must be analyzed: may_be_registered, pay_type и in_system

Required values:

  • may_be_registered - true
  • pay_type - money or bonus_domain
  • in_system - false

When making an application for domain registration, you will need to pass the pay_type, which was returned by the method.

getPhpVersion

Description:

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

Additional parameters:
  • full_fqdn - the full name of the domain for which you want to get information;
Call example:
http://api.beget.com/api/domain/getPhpVersion?login=usrlogin&passwd=usrpasswd&full_fqdn=foobar.com&output_format=json

https://api.beget.com/api/domain/getPhpVersion?login%3Dusrlogin%26passwd%3Dusrpasswd%26full_fqdn%3Dfoobar.com%26output_format%3Djson
Response example:
"status": "success",
    "answer": {
        "status": "success",
        "result": {
            "full_fqdn": "foobar.com",
            "php_version": "5.6",
            "cgi": "disabled",
            "allowed_versions": [
                "4.4",
                "5.2",
                "5.3",
                "5.4",
                "5.5",
                "5.6"
            ]
        }
    }

changePhpVersion

Description:

The method changes the php version to the transferred one. Allows you to set and remove cgi mode

Additional parameters:
  • full_fqdn - the full name of the domain for which you want to change the version of php;
  • php_version - version of php to be modified;
  • is_cgi - set or remove cgi mode. Defaults to false;
Call example:
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"}

https://api.beget.com/api/domain/changePhpVersion?login=userlogin&passwd=password&full_fqdn=example.com&php_version=5.4&is_cgi=true&output_format=json
Response example:
"status": "success",
"answer": {
    "status": "success",
    "result": {
        "full_fqdn": "example.com", // domain with which php version and cgi mode were changed
        "result": "changes will take effect in some time", // changes may take some time
        "php_version": "5.4", // version of php after the current request
        "cgi": "enabled" // is cgi mode enabled
    }
}

getDirectives

Description:

The method returns custom directives for the specified domain

Additional parameters:
  • full_fqdn - full domain name;
Call example:
https://api.beget.com/api/domain/getDirectives?login=userlogin&passwd=password&output_format=json&input_format=json&input_data={"full_fqdn": "example.com"}

https://api.beget.com/api/domain/getDirectives?login=userlogin&passwd=password&full_fqdn=example.com&output_format=json
Response example:
"status": "success",
"answer": {
    "status": "success",
    "result": [ // directive array
        {
            "name": "php_admin_value", // directive name
            "value": "session.save_handler redis"  // its meaning
        }
    ]
}

addDirectives

Description:

The method adds custom directives for the specified domain

Additional parameters:
  • full_fqdn - full domain name;
  • directives_list - array of directives in the format:
[
    {
        name: "name of directive",
        value: "value of directive"
    }
]
Call example:
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
Response example:
"status":"success",
"answer": {
    "status": "success",
    "result":true
}

removeDirectives

Description:

The method removes user directives for the specified domain

Additional parameters:
  • full_fqdn - full domain name;
  • directives_list - array of directives in the format:
[
    {
        name: "name of directive",
        value: "value of directive"
    }
]
Call example:
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
Response example:
"status":"success",
"answer": {
    "status": "success",
    "result":true
}