• VPS Hosting
  • Popular OpenVZ VPS Servers VPS XEN Cloud VPS (KVM)new AI and Machine Learning Windows VPS servers Jelastic Server administration
  • Индивидуальные решения Dedicated servers Server for business
  • Operations Renewal Change owner Transfer services within REG.COM Legal Agreements
  • My Services
  • Dedicated Servers
  • Popular Dedicated servers Colocation Server administration
  • Cloud infrastructure VPS servers (VDS) AI and Machine Learning Virtual Data Center VMware
  • Operations Renewal Change owner Transfer services within REG.COM Legal Agreements
  • Services Server for business Dedicated IP
  • My Services
  • SSL
  • Popular Compare SSL Certificates About certificates GlobalSign SSL Certificates Thawte SSL Certificates Comodo SSL Certificates TrustWave SSL Certificates Symantec SSL Certificates GeoTrust SSL Certificates Free SSL Certificate
  • My Services
  • Web tools
  • Promotion SEO promotion
    E-mail for a domain Free E-mail Gmail, Google Apps for domain
  • Monitoring Hosting history WHOIS history Whois Domain tracking Urgent warning SMS-services and notifications
  • Security Privacy Protection Domain name security Host protection Spam protection SSL Certificate installation
  • My Services
  • Cloud services
  • Cloud hosting Cloud VPS (KVM) Jelastic LAMP LEMP
    Development Jenkins Nexus Docker
  • AI and Machine Learningnew GPU Cloud Computing Machine learning Speed up TensorFlow Photogrammetry with Metashape High performance computing Cinema 4D Rendering Blender rendering Восстановление паролей в Passware
  • Business management Google Apps cloud services Alfresco Liferay Cyclos
  • My Services
  • Resellers
  • Partner programs Ideas of partners
    Reseller program Reseller program overview PRO services Reseller plans Apply for a reseller account REG.Reseller REG.API v2
  • Referral program Reseller program overview Rules
  • Other Legal Agreements Paperless operations Business tips Promotional materials
  • REG.Friends Club Club plans
  • About Us Timeline Our clients Legal Agreements Contact Us Reviews
  • Blog Projects Careers at REG.COM Payment methods
  • Business tips Referral program Club plans Media 100+ unique features Brand Story
  • My Account
  • Domains
  • Websites
  • Web Hosting
  • VPS Hosting
  • Dedicated Servers
  • SSL
  • REG.API 2.0

    1. 1.  Introduction
      1. 1.1.  REG.API 2.0 benefits
      2. 1.2.  Recommendations for effective use of REG.API
      3. 1.3.  Official client libraries to access REG.API Providers
    2. 2.  REG.API 2.0 overview
      1. 2.1.  General interaction principles
      2. 2.2.  Request formats
        1. 2.3.  Types of input parameters
        2. 2.4.  Transfer of input parameters
        3. 2.5.  Formats of input parameters
          1. 2.6.  PLAIN (simple HTTP parameters)
          2. 2.7.  JSON
          3. 2.8.  XML
        4. 2.9.  Common input parameters
          1. 2.10.  Authentication parameters
          2. 2.11.  API management parameters
          3. 2.12.  Service identification parameters
          4. 2.13.  Service list identification parameters
          5. 2.14.  Folder identification parameters
          6. 2.15.  Payment parameters
      3. 2.16.  Response format
        1. 2.17.  Transfer of output parameters
          1. 2.18.  JSON
          2. 2.19.  YAML
          3. 2.20.  XML
          4. 2.21.  PLAIN
        2. 2.22.  Common output parameters
        3. 2.23.  Common error codes
      4. 2.24.  Authentication
        1. 2.25.  Login authentication
        2. 2.26.  Signature authentication
        3. 2.27.  Additional check using the ssl-certificate
      5. 2.28.  Test and production modes to access REG.API
    3. 3.  General descriptions of functions
      1. 3.1.  Function categories
      2. 3.2.  Function accessibility
      3. 3.3.  List of functions
    4. 4.  Common functions
      1. 4.1.  nop (idleness)
      2. 4.2.  reseller_nop (nop for the partners)
      3. 4.3.  get_user_id (getting a user ID)
      4. 4.4.  get_service_id (getting an id for a domain or service)
    5. 5.  User management functions (the category "user")
      1. 5.1.  user/nop (check for availability)
      2. 5.2.  user/create (new user registration)
      3. 5.3.  user/get_statistics (getting statistics)
      4. 5.4.  user/get_balance (view balance of the account)
      5. 5.5.  user/refill_balance (replenishment of balance)
      6. 5.6.  user/set_reseller_url (set URL for the redirect from the external service)
      7. 5.7.  user/get_reseller_url (get URL for the redirect from the external service)
    6. 6.  Invoice management functions (the category «bill»)
      1. 6.1.  bill/nop (check for availability)
      2. 6.2.  bill/get_not_payed (the list of unpaid bills)
      3. 6.3.  bill/get_for_period (the list of invoices for the period)
      4. 6.4.  bill/change_pay_type (payment method change)
      5. 6.5.  bill/delete (invoice deletion)
    7. 7.  Service management functions (the category «service»)
      1. 7.1.  service/nop (check the service list availability)
      2. 7.2.  service/get_prices (Get services activation/renewal prices)
      3. 7.3.  service/get_servtype_details (get the price and general information of the service)
      4. 7.4.  service/create (order a new service)
      5. 7.5.  service/check_create (Validate parameters for service_create)
      6. 7.6.  service/delete (remove a service)
      7. 7.7.  service/get_info (get information on services)
      8. 7.8.  service/get_list (get the list of active services)
      9. 7.9.  service/get_folders (get the directory folders, in which the service is included)
      10. 7.10.  service/get_details (get general information on the service)
      11. 7.11.  service/get_dedicated_server_list (get the list of dedicated servers, which are available for order)
      12. 7.12.  service/update (service customization)
      13. 7.13.  service/renew (domain or service renewal)
      14. 7.14.  service/get_bills (get the list of the bills, which are connected with the services)
      15. 7.15.  service/set_autorenew_flag (control the flag for auto renewal)
      16. 7.16.  service/suspend (suspend provision of the service)
      17. 7.17.  service/resume (resume provision of the service)
      18. 7.18.  service/get_depreciated_period (number of periods to the service expiration date)
      19. 7.19.  service/upgrade (increase the tariff for the service)
      20. 7.20.  service/partcontrol_grant (transfer a service into partial control)
      21. 7.21.  service/partcontrol_revoke (recall the rights of partial control)
      22. 7.22.  service/resend_mail (resend mail to user)
      23. 7.23.  service/refill (refill balance of service)
      24. 7.24.  service/refund (money withdrawal from an external service's account to the account of the reg.ru's user)
      25. 7.25.  service/get_balance (get the external service's balance)
      26. 7.26.  service/seowizard_manage_link (get link for Seowizard control panel)
      27. 7.27.  service/get_websitebuilder_link (get a link to the publication of the Reg.ru sitebuilder)
    8. 8.  Domain management functions (the category «domain»)
      1. 8.1.  domain/nop (test function)
      2. 8.2.  domain/get_prices (get the price for all the TLDs)
      3. 8.3.  domain/get_suggest (domain name selection by keywords)
      4. 8.4.  domain/get_premium_prices
      5. 8.5.  domain/get_deleted (the list of deleted domains)
      6. 8.6.  domain/check (check availability of a domain)
      7. 8.7.  domain/create (application for a domain registration)
      8. 8.8.  domain/transfer (application for a domain transfer)
      9. 8.9.  domain/get_transfer_status
      10. 8.10.  domain/set_new_authinfo
      11. 8.11.  domain/get_rereg_data (the list of expiring domains with their specifications)
      12. 8.12.  domain/set_rereg_bids (to make an order for expiring domains)
      13. 8.13.  domain/get_user_rereg_bids (the list of expiring domains with their own bids)
      14. 8.14.  domain/get_docs_upload_uri (get the link for documents download)
      15. 8.15.  domain/update_contacts (domains contact data change)
      16. 8.16.  domain/update_private_person_flag (contact data hide / show flag change in whois)
      17. 8.17.  domain/register_ns (put a domain into the NSI-registry)
      18. 8.18.  domain/delete_ns (remove a domain from the NSI-registry)
      19. 8.19.  domain/get_nss (get the list of DNS for domains)
      20. 8.20.  domain/update_nss (domains DNS servers change)
      21. 8.21.  domain/delegate (domain delegation)
      22. 8.22.  domain/undelegate (domain delegation cancellation)
      23. 8.23.  domain/transfer_to_another_account (transmit a domain to another account)
      24. 8.24.  domain/look_at_entering_list (view the domains, which are transmitted into the account)
      25. 8.25.  domain/accept_or_refuse_entering_list (accept or decline the domains, which are transmitted into the account)
      26. 8.26.  domain/request_to_transfer (send an application for domains transposition to your account)
      27. 8.27.  domain/get_tld_info
      28. 8.28.  domain/send_email_verification_letter
    9. 9.  DNS management functions (the category «zone»)
      1. 9.1.  zone/nop (check the DNS TLD control access)
      2. 9.2.  zone/add_alias (link a subdomain to an IP-address)
      3. 9.3.  zone/add_aaaa (link a subdomain to an IPv6-address)
      4. 9.4.  zone/add_caa (Specify SSL certificate issue rules for subdomain)
      5. 9.5.  zone/add_cname (link a domain to the address of another domain)
      6. 9.6.  zone/add_mx (set the service mailbox server)
      7. 9.7.  zone/add_ns (add the ns entry)
      8. 9.8.  zone/add_txt (add a txt entry)
      9. 9.9.  zone/add_srv (add an srv entry)
      10. 9.10.  zone/get_resource_records (get resource entries for a TLD)
      11. 9.11.  zone/update_records (add and/or remove several resource entries at a single request)
      12. 9.12.  zone/update_soa (change the duration period for TLD cash)
      13. 9.13.  zone/tune_forwarding (add resource entries for web-forwarding)
      14. 9.14.  zone/clear_forwarding (remove resource entries, which are necessary for web-forwarding)
      15. 9.15.  zone/tune_parking (add resource entries for Parking page)
      16. 9.16.  zone/clear_parking (remove resource entries for Parking page)
      17. 9.17.  zone/remove_record (remove one resource entry)
      18. 9.18.  zone/clear (remove all resource entries)
    10. 10.  DNSSEC management functions
      1. 10.1.  dnssec/nop (You can check if you can manage DNSSEC of domains.)
      2. 10.2.  dnssec/get_status (Gets DNSSEC status for domain.)
      3. 10.3.  dnssec/enable (Enables DNSSEC for domain, that uses REG.RU nameservers.)
      4. 10.4.  dnssec/disable (Disables DNSSEC for domain, that uses REG.RU nameservers.)
      5. 10.5.  dnssec/renew_ksk (Regenerates and updates KSK key for domain, that uses REG.RU nameservers.)
      6. 10.6.  dnssec/renew_zsk (Regenerates and updates ZSK key for domain, that uses REG.RU nameservers.)
      7. 10.7.  dnssec/get_records (Gets list of DNSSEC records of a domain.)
      8. 10.8.  dnssec/add_keys (Adds information about KSK keys to the parent zone.)
    11. 11.  Hosting management functions (the category «hosting»)
      1. 11.1.  hosting/nop (check API accessibility)
      2. 11.2.  hosting/get_jelastic_refill_url (get Jelastic URL for account balance refill)
      3. 11.3.  hosting/set_jelastic_refill_url (set Jelastic URL for account balance refill)
      4. 11.4.  hosting/get_parallelswpb_constructor_url (get URL to the ParallelsWPB constructor)
      5. 11.5.  hosting/get_rs_themes (get list available themes for ready-made solutions based on popular CMS)
    12. 12.  Folder management functions (the category «folder»)
      1. 12.1.  folder/nop (testing, check availability of a folder)
      2. 12.2.  folder/create (create a folder)
      3. 12.3.  folder/remove (delete a folder)
      4. 12.4.  folder/rename (rename a folder)
      5. 12.5.  folder/get_services (get the list of services in the folder)
      6. 12.6.  folder/add_services (add a service into the folder)
      7. 12.7.  folder/remove_services (remove a service from the folder)
      8. 12.8.  folder/replace_services (rewrite a service in the folder)
      9. 12.9.  folder/move_services (transfer a service from one folder to another one)
    13. 13.  Domain Shop management functions
      1. 13.1.  shop/nop (check for availability)
      2. 13.2.  shop/update_lot (update lot)
      3. 13.3.  shop/delete_lot (delete lot)
      4. 13.4.  shop/get_info (get information about lot)
      5. 13.5.  shop/get_lot_list (get the list of lots)
      6. 13.6.  shop/get_category_list (get the list of categories)
      7. 13.7.  shop/get_suggested_tags (get the list of suggested tags)

    1. Introduction

    To make the work of REG.RU customers and partners with the distributed registration system (further referred to as RegRuSRS) more convenient, REG.RU developed a simple, user-friendly program interface - REG.API - that functions over the HTTP protocol. We believe that the use of REG.API makes our relations with our customers and partners more efficient.

    This document describes REG.API v.2.0 which is the next generation of RegRuSRS program interface. The document is intended for software designers and programmers involved in automation of operations with RegRuSRS.

    The document assumes that the reader is familiar with HTTP basics and has decent programming skills. If you have any questions not answered in this document, you can ask them here.

    1.1. REG.API 2.0 benefits

    1. Unified transfer of complex data structures.
    2. Wide choice of data transfer formats: input parameters can be passed as plain HTTP, JSON or XML; output parameters can be returned in the JSON, YAML, XML or plain text format.
    3. As of now one user can perform several non-financial parallel operations.
    4. Multiple encoding support (the default encoding is utf8; other supported encodings include cp1251, koi8-r, koi8-u, cp866).
    5. Multi-language output.
    6. Detailed information about errors.
    7. A unified domain and service identification method.
    8. New ways to identify services: in addition to domain names, now you can use service identifiers that ensure quick and accurate service identification.
    9. Advanced debugging capabilities: a variety of test functions, the possibility to view input parameters (to monitor their transfer and decoding accuracy).
    10. For users’ convenience, the field Content-type now allows all types of values. 11.The major part of the functions is accessible for all users! You do not have to be a partner!

    Click here to download the presentation on API 2.0 benefits.

    1.2. Recommendations for effective use of REG.API

    This section provides information that will help you to make you work with REG.API more productive and convenient.

    One of the most frequent problems our partners face when working with REG.API is exceeding the maximum request limit (1,200 requests per hour for user/ip). Both limits are acting at the same time. If the limits has exceeded then REG.API sets the error code (depends on kind of) to IP_EXCEEDED_ALLOWED_CONNECTION_RATE or ACCOUNT_EXCEEDED_ALLOWED_CONNECTION_RATE.

    The analysis of such situations showed that in most cases such problems are the results of improper use or misuse of REG.API due to bugs or design faults in the software used by partners.

    The recommendations below will, on the one hand, allow you to preclude situations with excessive requests to REG.API leading to temporary blocking of user accounts, and, on the other hand, to reduce the load on RegRuSRS.

    1. We recommend you to send WHOIS requests (for the display of WHOIS data on your sites) not to REG.API, but directly to the WHOIS servers of the corresponding domain zones.

      The advantages of this approach are as follows:

    2. The responses to WHOIS requests will arriver faster.
    3. You will get data directly from its source without mediation.
    4. The overall number of requests will decrease, thus the likelihood of blocking of your account due to excessive requests to REG.API decreases as well.
  • We can offer you ready-to-use software solutions that will allow you to optimize your procedures of getting WHOIS data.

    We recommend you to use REG.API for placing orders or changing data rather than for obtaining data. The software employed by some of our partners either do not locally store domain-related data or store incomplete data. As a result this data is dynamically downloaded from our system with the help of such functions domain_list, service/get_info, domain/get_contacts, domain/get_nss, etc. We advise you to store all domain- and service-related locally and address to REG.API only when you want to change some data in the registry. This will ensure fast and reliable operation of your applications and minimize your dependency on the availability of our system.

  • All data change requests should be performed asynchronously.

    Some applications perform domain/service registration operations, as well as data change operations right at the moment of processing HTTP requests from clients. But if the execution of an API request fails for some reason (connection loss, exceeding of request limit, parallel request blocking), this request will get lost and the client will receive an error message.

    This mode of interaction is very unreliable and inconvenient for your customers.

    We recommend you to perform all service ordering/data changing requests asynchronously using the queue mechanism. In such a case:

  • You will exclude the possibility of API request blockings (because only one API request is performed at a time).
  • In case of connection failures the request can be repeated until it is executed (this significantly increases the system reliability).
  • In case of request processing errors (if REG.RU returned an error code), you can fix the problem and repeat the request, while the customer will not get any error messages. You can solve the major part of your customers’ problems on your own without their participation.
  • Use bulk operations whenever possible. A lot of methods support operations over lists of services and domains at once.

  • It is a good practice to keep logs of all API request and responses. If a problem arises, logs will help you or our support engineers to efficiently locate and solve it.

    We hope that this information will be useful for you and that it will help you to optimize your work with REG.API.

  • 1.3. Official client libraries to access REG.API Providers

  • Regru::API module for Perl (CPAN, GitHub).
  • 2. REG.API 2.0 overview

    2.1. General interaction principles

    The transport protocol employed for calling REG.API functions is HTTP (HTTPS). REG.API supports both GET and POST requests; however we recommend that you use the POST method, because it has no limitations on the request length.

    Each call of a function is atomic and synchronous, i.e. all requests are independent. All operations are also synchronous: the result of an operation returns immediately, there are no any intermediate stages during execution of operations. The choice in favor of this interaction method was made to simplify the customers’ work flow with REG.API.

    Parallel processing of calls is available to requests not changing balance of the client on the REG.API provider's account.

    2.2. Request formats

    The URL for calling functions has the following format:

    https://api.reg.ru/api/regru2/<function_category_name>/<function_name>[?<HTTP_parameters_for_GET_ requests>]
    
    

    Thus, every function is called by means of an individual URL (in API v.1.0 there was one and same URL for all functions, while the required function was identified by the parameter «action»).

    Almost all of the functions require additional parameters for being called.

    2.2.1. Types of input parameters

    Input parameters fall into the following categories:

  • authentication parameters;
  • service identification parameters;
  • API control parameters;
  • function-specific parameters.
  • Out of four input parameter types the authentication parameters are mandatory for almost every function. The use of other parameters varies from function to function and is described below individually for each function.

    2.2.2. Transfer of input parameters

    All additional parameters, if any, can be transferred as typical GET or POST parameters, where transferred data is encoded as x-www-form-urlencoded.

    An example of data transfer with the help of a GET request:

    https://api.reg.ru/api/regru2/nop?username=test&password=test&output_content_type=plain

    When using curl, enclose the URL with params in '' to avoid shell interpretation of special symbols in URL (e.g. &).

    Example of request using curl

    $ curl -v 'https://api.reg.ru/api/regru2/nop?username=test&password=test&output_content_type=plain'

    Function parameters can be also transferred in the JSON and XML formats. In this case all the parameters serialized into a string are transferred as a single HTTP-parameter in the input_data field.

    An example of sending serialized parameters in a GET request:

    https://api.reg.ru/api/regru2/nop?input_format=json&input_data=%7B%22username%22%3A%22test%22%2C%22password%22%3A%22test%22%2C%22output_content_type%22%3A%22plain%22%7D

    An example of a complex structure call is provided in the section describing the set_rereg_bids function

    The use of JSON and XML is the only way to send complex data structures.

    2.2.3. Formats of input parameters

    REG.API v.2.0 allows data transfer in several formats. You can transfer data as simple HTTP requests using GET or POST (further conventionally referred to as the «PLAIN» format), as well as JSON and XML. For illustration purposes we will use examples of data transfer with JSON responses and output of all received data (for this, the input parameter show_input_params = 1). To demonstrate the way data lists are transferred, the request below includes a dummy leftdata list.

    2.2.3.1. PLAIN (simple HTTP parameters)

    Fields input_format and input_data
    are not available
    
    
    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "service_id" : "123456"
       },
       "input_params" : {
          "domain_name" : "qqq.ru",
          "leftdata" : [
             "1",
             "2",
             "3"
          ],
          "output_content_type" : "plain",
          "password" : "test",
          "show_input_params" : "1",
          "username" : "test"
       },
       "result" : "success"
    }
    
    

    2.2.3.2. JSON

    Value of the field input_format

    json

    Example of a request:

    https://api.reg.ru/api/regru2/domain/nop?username=test&password=test&input_format=json&input_data={"output_content_type":"plain","show_input_params":1,"domain_name":"qqq.ru","leftdata":[1,2,3]}

    Example of a successful responce:
    {
       "input_params" : {
          "show_input_params" : "1",
          "output_content_type" : "plain",
          "domain_name" : "qqq.ru",
          "password" : "test",
          "leftdata" : [
             "1",
             "2",
             "3"
          ],
          "username" : "test"
       },
       "answer" : {
          "service_id" : "123456"
       },
       "result" : "success"
    }
    

    2.2.3.3. XML

    Value of the field input_format

    xml

    Example of a request:

    https://api.reg.ru/api/regru2/domain/nop?username=test&password=test&input_format=xml&input_data=<opt%20domain_name="qqq.ru"%20output_content_type="plain"%20show_input_params="1"><leftdata>1</leftdata><leftdata>2</leftdata><leftdata>3</leftdata></opt>

    Example of a successful responce:
    {
       "input_params" : {
          "domain_name" : "qqq.ru",
          "show_input_params" : "1",
          "output_content_type" : "plain",
          "password" : "test",
          "input_format" : "xml",
          "leftdata" : [
             "1",
             "2",
             "3"
          ],
          "username" : "test",
    
       },
       "answer" : {
          "service_id" : "123456"
       },
       "result" : "success"
    }
    

    2.2.4. Common input parameters

    The full set of parameters varies from function to function, however some of the parameters are applicable to all or to the major part of the functions. This section describes common input parameters.

    2.2.4.1. Authentication parameters

    These parameters are mandatory for the functions that require authentication. These are fields username+password OR username+signature (depending on the authentication method used)

    Login authentication

    Parameter Description
    username
    Name of the user (login) in RegRu.
    password
    The main user password used for logging into REG.RU or an alternative password for API, defined on the Reseller settings page.

    Example:

    https://api.reg.ru/api/regru2/nop?username=test&password=test

    You see other examples of use below.

    Signature authentication

    Parameter Description
    username
    Name of the user (login) in RegRu.
    sig
    Base 64 encoded signature of SHA1 digest

    The signature is created on the basis of the transferred parameters. The text for the signature is united through a symbol ; the sorted UTF-8 array of the lines received from values of the transferred parameters. Zero, space and undefined value should be ignored. Don't forget to include here also username values. The signature is created by private RSA a key, corresponding to which the certificate has been earlier loaded at security settings.

    We are using the next query as an example:

    https://api.reg.ru/api/regru2/domain/nop?username=test&output_content_type=plain&show_input_params=1&domain_name=qqq.ru&leftdata=1&leftdata=2&leftdata=3

    There are several parameters in the query: test, plain, 1, qqq.ru, 1, 2, 3. Let us sort and concatenate them with semicolon as delimeter. We will receive the string: "1;1;2;3;plain;qqq.ru;test", and sign it with private key, using the console:

    echo -n "1;1;2;3;plain;qqq.ru;test" | openssl dgst -sign my.key -sha1 | openssl enc -base64 -out my.sig
    
    

    So we got base64 encoded signature for the query in file my.sig. Please keep an eye on -n parameter of echo command, to strip the text from carriage return symbol.

    Now we are going to send our query with curl:

    curl -F 'sig=<my.sig' 'https://api.reg.ru/api/regru2/domain/nop?username=\
    test&output_content_type=plain&show_input_params=1&domain_name=qqq.ru&leftdata=1&leftdata=2&leftdata=3'
    
    

    Attention: you should use your real login instead of test. Signature authentication is not activated for test user.

    Additional check using the ssl-certificate

    Additional check using the ssl-certificate it can be used both for password and signature authentication. To enable this option, check the 'Use SSL cert for API access' flag in the account Security Settings -> Options for API. If this check is enabled, every API request must contain SSL-cert in HTTP header. You can pass the SSL cert in params for curl or use any intermediate library for your preferred programming language that does the same.
    The example of creation of the SSL certificate for API is given above.

    Example of authorization with password and SSL certificate by means of curl:

    curl -k --key my.key --cert my.crt 'https://api.reg.ru/api/regru2/domain/nop?username=test&password=\
    test&output_content_type=plain&show_input_params=1&domain_name=qqq.ru&leftdata=1&leftdata=2&leftdata=3'
    
    

    Example of authorization with signature and SSL certificate by means of curl:

    curl -k --key my.key --cert my.crt -F 'sig=<my.sig' 'https://api.reg.ru/api/regru2/domain/nop?username=\
    test&output_content_type=plain&show_input_params=1&domain_name=qqq.ru&leftdata=1&leftdata=2&leftdata=3'
    
    

    Instead of the test login it is necessary to use your username as login. For the login test access to API with use of the SSL-certificate isn't possible.

    Here are also a few examples of code for authentication with and without SSL certificate.

    A simple PHP script that makes an API request to check domain availability. Authentication is made using signature and SSL certificate. ```php

    !/usr/bin/php

    <?php

    $params = [ 'dname' => 'yayayayayaya.ru', 'input_format' => 'plain', 'username' => 'test', ];

    $sig_params = $params; sort($sig_params);

    $pkeyid = openssl_pkey_get_private("file:///path/my.key"); openssl_sign( implode(';', $sig_params), $sig, $pkeyid );

    $params['sig'] = base64_encode($sig); $endpoint = 'https://api.reg.ru/api/regru2/domain/check'; $url = $endpoint . '?' . http_build_query($params);

    $curl = curl_init(); curl_setopt($curl, CURLOPT_URL, $url); curl_setopt($curl, CURLOPT_SSLCERT, getcwd() . "/my.crt"); curl_setopt($curl, CURLOPT_SSLKEY, getcwd() . "/my.key"); curl_setopt($curl, CURLOPT_RETURNTRANSFER,true); curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, 1);

    $result = curl_exec($curl); curl_close($curl); $result = json_decode(urldecode($result),true); echo "\n"; print_r($result); echo "\n"; ?> ```

    Without using SSL certificate, the code for the same API request would be the following: ```php

    !/usr/bin/php

    <?php

    $params = [ 'dname' => 'yayayayayaya.ru', 'input_format' => 'plain', 'username' => 'test', ];

    $sig_params = $params; # clone sort($sig_params);

    $pkeyid = openssl_pkey_get_private("file:///path/my.key"); openssl_sign( implode(';', $sig_params), $sig, $pkeyid );

    $params['sig'] = base64_encode($sig); $endpoint = 'https://api.reg.ru/api/regru2/domain/check'; $url = $endpoint . '?' . http_build_query($params);

    $curl = curl_init(); curl_setopt($curl, CURLOPT_URL, $url); curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);

    $result = curl_exec($curl); curl_close($curl); $result = json_decode(urldecode($result),true); echo "\n"; print_r($result); echo "\n";

    ?> ```

    The common example of a perl-code where are shown authorization according to the password and with use of a signature, calls of nops and more complex option variant — registration of the domain:

    #!/usr/bin/perl
    
    use Data::Dumper;
    use MIME::Base64;
    use JSON::XS;
    use Crypt::OpenSSL::X509;
    use Crypt::OpenSSL::RSA;
    use LWP;
    
    use strict;
    use warnings;
    
    my $ua = LWP::UserAgent->new(
        parse_head => 0,
        timeout    => 5,
        keep_alive => 30,
    );
    
    my $url = 'https://api.reg.ru';
    
    print "login by password\n";
    
    
    my %pas_form = (
        username => 'test',
        password => 'test',
        show_input_params => '1',
    );
    
    my $response = $ua->post( $url . '/api/regru2/reseller_nop', \%pas_form );
    
    if ( $response->code == 200 ) {
        print "req ok: code 200\n";
    }
    else {
        print "req fail: code " . $response->code . "\n";
        exit;
    }
    
    print "answer:\n" . $response->content . "\n";
    
    
    
    print "login by signature\n";
    
    # for get RSA PRIVATE KEY from pem PRIVATE KEY need use openssl
    my $private_key = '-----BEGIN RSA PRIVATE KEY-----
    MII< hidden data >A==
    -----END RSA PRIVATE KEY-----';
    # or read private_key from file
    
    
    my %sig_form = (
        username          => 'test',
        show_input_params => '1',
        show_sig_params   => '1',
    );
    
    my $sigtext = make_text_for_sig( \%sig_form );
    
    print "$sigtext\n";
    
    my $rsa_priv = Crypt::OpenSSL::RSA->new_private_key( $private_key );
    
    $rsa_priv->use_sha1_hash();
    my $signature = $rsa_priv->sign( $sigtext );
    
    my $sig = encode_base64( $signature );
    
    print "$sig\n";
    
    $sig_form{sig} = $sig;
    
    $response = $ua->post( $url . '/api/regru2/reseller_nop', \%sig_form );
    
    
    if ( $response->code == 200 ) {
        print "req ok: code 200\n";
    }
    else {
        print "req fail: code " . $response->code . "\n";
        exit;
    }
    
    print "answer:\n" . $response->content . "\n";
    
    
    print "create using login by signature\n";
    
    my %cre_form = (
        username     => 'pppp',
        input_format => 'json',
        input_data   => {
            'contacts' => {
                'b_fax'          => '+7.9665443322',
                't_addr'         => 'Bolshoy sobachiy, 33',
                'a_state'        => 'Moskva',
                'o_fax'          => '+7.9665443322',
                'o_postcode'     => '291000',
                't_phone'        => '+7.9665443322',
                'a_fax'          => '+7.9665443322',
                'o_addr'         => 'Bolshoy sobachiy, 33',
                'a_email'        => 'sig@ya.ru',
                'a_addr'         => 'Bolshoy sobachiy, 33',
                't_company'      => 'FirmA, LLC',
                'b_phone'        => '+7.9665443322',
                'o_company'      => 'FirmA, LLC',
                'o_city'         => 'Moscow',
                'b_first_name'   => 'Ivan',
                't_city'         => 'Moscow',
                'b_state'        => 'Moskva',
                'a_postcode'     => '291000',
                't_first_name'   => 'Ivan',
                't_state'        => 'Moskva',
                't_email'        => 'sig@ya.ru',
                'a_country_code' => 'RU',
                'o_phone'        => '+7.9665443322',
                'a_city'         => 'Moscow',
                't_country_code' => 'RU',
                'b_last_name'    => 'Ivanoff',
                'a_phone'        => '+7.9665443322',
                't_postcode'     => '291000',
                't_last_name'    => 'Ivanoff',
                'b_addr'         => 'Bolshoy sobachiy, 33',
                'b_company'      => 'FirmA, LLC',
                'o_last_name'    => 'Ivanoff',
                'b_country_code' => 'RU',
                'a_company'      => 'FirmA, LLC',
                'b_email'        => 'sig@ya.ru',
                'a_last_name'    => 'Ivanoff',
                't_addr'         => 'Bolshoy sobachiy, 33',
                'b_city'         => 'Moscow',
                'o_state'        => 'Moskva',
                'o_first_name'   => 'Ivan',
                't_fax'          => '+7.9665443322',
                'b_postcode'     => '291000',
                'o_country_code' => 'RU',
                'o_email'        => 'sig@ya.ru',
                'a_first_name'   => 'Ivan'
            },
            'domain_name' => '', # not to register the domain and to receive a registration error
            'nss' => {},
            'enduser_ip' => '10.11.12.13',
        },
        show_input_params => '1',
        show_sig_params   => '1',
    );
    
    # or use this data:
    # 'domains'    => [ { 'dname' => 'test.com' } ],
    # 'nss'        => { 'ns0' => 'ns1.reg.ru', 'ns1' => 'ns2.reg.ru' },
    
    my $sigtext = make_text_for_sig( \%cre_form );
    
    print "$sigtext\n";
    
    $rsa_priv->use_sha1_hash();
    $signature = $rsa_priv->sign( $sigtext );
    
    $sig = encode_base64( $signature );
    
    print "$sig\n";
    
    $cre_form{sig} = $sig;
    
    $cre_form{input_data} = JSON::XS->new->utf8->encode( $cre_form{input_data} );
    
    $response = $ua->post( $url . '/api/regru2/domain/create', \%cre_form );
    
    
    if ( $response->code == 200 ) {
        print "req ok: code 200\n";
    }
    else {
        print "req fail: code " . $response->code . "\n";
        exit;
    }
    
    print "answer:\n" . $response->content . "\n";
    
    
    # functions for generation of a signature
    
    sub make_text_for_sig {
        return join ';', sort( _make_text_for_sig(@_) );
    }
    
    sub _make_text_for_sig {
        my ( $d ) = @_;
    
        if ( ref $d eq 'ARRAY' ) {
            return map { _make_text_for_sig( $_ ) } @$d;
        }
        elsif ( ref $d eq 'HASH' ) {
            return map { _make_text_for_sig( $$d{$_} ) } grep { $_ ne 'sig' } keys %$d;
        }
        elsif ( not ref $d and $d ) {
            return $d;
        }
    
        return ();
    }
    
    

    2.2.4.2. API management parameters

    The API management and service identification parameters can be referred to as additional parameters.

    The common API management parameters are the functions that define the format of input and output parameters, encoding and language settings.

    Parameter Description Default value
    io_encoding
    This parameter serves for defining the encoding used for data exchange (currently REG.RU API supports the following encodings: cp1251, koi8-r, koi8-u, cp866).
    utf8
    Input data management
    input_format
    The format of data transferred API in requests. The data itself is transferred in the input_data field. Currently REG.RU API supports the json and xml values. All other values are handled as plain format values without data analysis.
    plain
    input_data
    Data in the format set by the parameter input_format. Do not pass authentication data (username + password/signature) in the input_data field.
    Output data management
    output_format
    This parameter serves to define the format of System responses: «json» (default), «yaml», «xml» or «plain» (REG.API 1.0 format). As for the YAML format, it should be mentioned that data is passed encoded in Base64.
    json
    view
    A synonym of the output_format parameter. Obsolete.
    json
    output_content_type
    This parameter serves for defining the content type without changes in the response format. For text/plain, just define plain.
    Depends on the value of the settings of the output_format field.
    lang
    This parameter sets the language of error_text. Currently the System supports Russian, English and Thai: ru, en, th. Error_code is always the same irrespective of the language settings. By default the text of errors comes in English.
    en
    show_input_params
    With this parameter enabled the system returns all input parameters as a hash of input_params. If input parameters are passed in the JSON or XML format, the output data will be processed by the json or xml parser. Thus, if input_format=json and output_format=xml, then for input_params the data will be translated from JSON into XML.
    0

    2.2.4.3. Service identification parameters

    This group of parameters serves for identification of specific pre-ordered services.

    Services can be identified by:

    1. service ID (both domains and services),
    2. domain name (domains only),
    3. domain name and service type (services only),
    4. ID of a parent service, service type or subtype (services only).

    Identification by numeric service identifiers is the most reliable and quick method. For this reason, we recommend that you save and store domain/service IDs on your side and use them for service identification.

    Parameter Description
    Identification by service ID (recommended)
    service_id
    Numeric service identifier.
    Identification by service ID passed by the user
    user_servid
    Alphanumeric service identifier. To use such an identifier, you should define it during domain/service creation. To learn the pre-defined identifier, use the service/get_info function.
    Domain identification by name
    domain_name
    Domain name. Russian domain names should be passed in the punycode or national encoding.
    Service identification by domain name and type of service (except for VPS)
    domain_name
    Name of the domain the service is associated with. Russian domain names should be passed in the punycode or national encoding.
    servtype
    Service type. For example, «srv_hosting_ispmgr» for hosting or «srv_webfwd» for the web-forwarding service.
    Service identification by parent service ID, service type or subtype
    uplink_service_id
    ID of the parent service with which the required service is associated
    servtype
    Service type. For example, «srv_hosting_ispmgr» for hosting or «srv_webfwd» for the web-forwarding service.
    subtype
    Service subtype. For example, «pro» for the ISP Manager Pro license.

    2.2.4.4. Service list identification parameters

    Parameter Description
    domains
    A list where each element includes a domain name or its service_ID in compliance with common service identification parameters.
    You can specify not more than 1000 services in one request.
    services
    A list where each element includes a domain name + service type or service_ID in compliance common service identification parameters.

    In general, input_data of such a request in the JSON format looks as follows:

    input_data={"services":[{"service_identification_parameter_1":"value",...},
    {"service_identification_parameter _2":"value",...}]}
    
    

    The response to such a request will also include a list of results individual for each of the services. The content of the «result» fields is either a «success» or a text of an error together with the «error_code» field providing the common error codes, the same as the codes returned in responses to single-domain requests.

    Example: getting service IDs by means of service/nop with errors in two last values

    https://api.reg.ru/api/regru2/service/nop?username=test&password=test&input_format=json&input_data={"services":[{"dname":"test.ru"},{"dname":"test.su","servtype":"srv_hosting_ispmgr"},{"service_id":"111111"},{"service_id":"22bug22"},{"surprise":"surprise.ru"}]}

    {
       "answer" : {
          "services" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : 12345,
                "servtype" : "domain"
             },
             {
                "dname" : "test.su",
                "result" : "success",
                "service_id" : 12346,
                "servtype" : "srv_hosting_ispmgr"
             },
             {
                "dname" : "test12347.ru",
                "result" : "success",
                "service_id" : "111111",
                "servtype" : "domain"
             },
             {
                "error_code" : "INVALID_SERVICE_ID",
                "error_text" : "service_id is invalid",
                "result" : "error",
                "service_id" : "22bug22"
             },
             {
                "error_code" : "NO_DOMAIN",
                "error_text" : "domain_name not given or empty",
                "result" : "error",
                "surprise" : "surprise.ru"
             }
          ]
       },
       "charset" : "utf-8",
       "messagestore" : null,
       "result" : "success"
    }
    

    Further, when describing each function in detail we will mention whether a function supports service lists or not.

    2.2.4.5. Folder identification parameters

    This section describes the methods of folder identification.

    The most reliable and effective method of folder identification is the identification by folder_id. For this reason we recommend that you save and store folder IDs on your side and use them for calling functions.

    Parameter Description
    folder_id
    Numeric folder identifier (recommended).
    folder_name
    Folder name.

    2.2.4.6. Payment parameters

    This section describes the parameters common for the functions dealing with service ordering or renewal of services, i.e. the functions that involve payments.

    Parameter Description
    point_of_sale
    An arbitrary string that identifies a system/web site used by the customer for placing an order for a domain. Optional field. Example: «regpanel.ru».
    pay_type
    Payment option. Currently available payment options: (WM, bank, pbank, prepay, yamoney, rapida, robox, paymer, cash, chronopay)
    Default value: prepay. Please note that automatic payments can be done only if the selected payment method is «prepay» and you have enough funds in your account. Otherwise, your order will be marked as unpaid and you will have to arrange the payment manually from your profile page.
    ok_if_no_money
    Enable to create bill when not enough funds to complete the operation. In this case requested operation is stored in the system, however it will be processed after submitting "change payment method" request via web interface. Return error if this flag not set and not enough funds to complete the operation.

    2.3. Response format

    2.3.1. Transfer of output parameters

    All functions can return responses in the following formats: JSON, YAML, XML and plain text. JSON is the default format. The format of output parameters is configured with the help of the output_format option.

    Some of the functions support additional output formats. For example, the get_rereg_data function can return data in the CSV format.

    2.3.1.1. JSON

    Value of the field output_format
  • json
  • Example of a request:

    https://api.reg.ru/api/regru2/nop?username=test&password=test

    https://api.reg.ru/api/regru2/nop?username=test&password=test&output_format=json

    Example of a response:
    {
       "answer" : {
          "login" : "test",
          "user_id" : 0
       },
       "charset" : "utf-8",
       "messagestore" : null,
       "result" : "success"
    }
    
    

    2.3.1.2. YAML

    Value of the field output_format
  • yaml
  • Example of a request:

    https://api.reg.ru/api/regru2/nop?username=test&password=test&output_format=yaml

    Example of a response:
    --- 
    answer: 
      login: test
      user_id: 0
    charset: utf-8
    messagestore: !!perl/hash:SRS::MessageStore 
      _messages: {}
    
    result: success
    
    

    2.3.1.3. XML

    Value of the field output_format
  • xml
  • Example of a request:

    https://api.reg.ru/api/regru2/nop?username=test&password=test&output_format=xml

    Example of a response:
    <opt charset="utf-8" result="success">
      <answer login="test" user_id="0" />
      <messagestore name="_messages" />
    </opt>
    

    2.3.1.4. PLAIN

    This format does not support complex/embedded data structures. For this reason, we do not recommend you to use this format.

    Value of the field output_format
  • plain
  • Example of a request:

    https://api.reg.ru/api/regru2/nop?username=test&password=test&output_format=plain

    Example of a response:
    Success: ; login: test; user_id: 0
    

    2.3.2. Common output parameters

    All API responses (both failed and successful ones) are standardized.

    The mandatory field for each response is the result field. It can take either error or success values.

    Fields included into successful responses:

    Field Description
    result
    Always «success».
    answer
    A hash of the function results.
    input_params
    A hash of parameters passed to the function. Available only if the parameter show_input_params was set to «1».

    Example of a successful response:

    {
       "answer" : {
          "login" : "test",
          "user_id" : "0"
       },
       "charset" : "utf-8",
       "messagestore" : null,
       "result" : "success"
    }
    

    Fields returned upon errors:

    Field Description
    result
    Always error.
    error_code
    An error code, a capitalized sentence with the underscore symbols ("_") used as delimiters. This code is for internal System use and serves for error analysis on the program level. For users the field error_text is provided.
    error_text
    Detailed error description in Russian or English depending on the setting of the input parameter lang.
    error_params
    Parameters included into the common error text. These parameters can be useful during automatic error analysis.
    input_params
    A hash of parameters passed to the function. Available only if the parameter show_input_params was set to «1».

    Example of a failed response:

    {
       "error_code" : "PASSWORD_AUTH_FAILED",
       "error_text" : "Username/password incorrect",
       "result" : "error"
    }
    

    Please, pay attention that the texts in the error_text field are not intended for automatic processing and can be modified without additional notification from our side.

    2.3.3. Common error codes

    Authorization errors

    Error_code error_text
    NO_USERNAME
    No username given
    NO_AUTH
    No authorization mechanism selected
    PASSWORD_AUTH_FAILED
    Username/password Incorrect
    RESELLER_AUTH_FAILED
    Only resellers can access to this function
    ACCESS_DENIED
    Your access to API denied. Please, contact us
    PURCHASES_DISABLED
    Purchases disabled for this account
    ACCESS_DENIED_FROM_IP
    Access to API from this IP denied
    ACCESS_DENIED_FROM_IP_WITH_SECRET_WORD
    Access to API from this IP denied. Instruction for access restoration will be sent to email.
    ACCOUNT_BLOCKED
    Account is blocked. The instructions on how to retrieve access can be found in Profile Page.
    USER_AUTHENTICATION_FAILED
    Login or password is incorrect.
    MORE_THAN_ONE_ACCOUNT_WITH_THE_SAME_EMAIL
    More than one account with the same e-mail found. Please provide a login.

    Errors of domains, services, folders identification

    Error_code error_text
    DOMAIN_NOT_FOUND
    Domain $domain_name not found or not owned by You
    SERVICE_NOT_FOUND
    Service $servtype for ext domain $domain_name not found
    SERVICE_NOT_SPECIFIED
    Service identification failed
    SERVICE_ID_NOT_FOUND
    Service $service_id not found or not owned by You
    NO_DOMAIN
    domain_name not given or empty
    INVALID_DOMAIN_NAME_FORMAT
    $domain_name is invalid or unsupported zone
    INVALID_SERVICE_ID
    service_id is invalid
    INVALID_DOMAIN_NAME_PUNYCODE
    Invalid punycode value for domain_name
    BAD_USER_SERVID
    Invalid value for user_servid.
    USER_SERVID_IS_NOT_UNIQUE
    Field servid is not unique
    TOO_MANY_OBJECTS_IN_ONE_REQUEST
    Too many objects (more than $max_objects) specified in one request
    CLIENT_NOT_FOUND
    Customer $client_uid is not found

    Accessibility errors

    Error_code error_text
    SERVICE_UNAVAILABLE
    Reg.API is temporarily unavailable
    BILLING_LOCK
    You have another active connection for billing operation to Reg.API
    DOMAIN_BAD_NAME
    Domain $domain_name is reserved or disalowed by the registry, or is a premium domain offered by special price
    DOMAIN_BAD_NAME_ONLYDIGITS
    Domain names that contains only digits can not be registered in this zone
    HAVE_MIXED_CODETABLES
    You can't mix latin and cyrillic letters in domain names
    DOMAIN_BAD_TLD
    Registration in $tld TLD is not available
    TLD_DISABLED
    Registration in $tld TLD is not available
    DOMAIN_NAME_MUSTBEENG
    Russian letters are not allowed in chosen TLD (.$tld)
    DOMAIN_NAME_MUSTBERUS
    Latin letters are not allowed in chosen TLD (.$tld)
    DOMAIN_ALREADY_EXISTS
    Domain already exists, use whois service
    DOMAIN_INVALID_LENGTH
    Invalid domain name length, You have entered too short or too long name
    DOMAIN_STOP_LIST
    Domain is unavailable, this domain name is either reserved or this is premium-domain with special price
    DOMAIN_STOP_PATTERN
    Unfortunately domain name ($domain_name) can't be registered
    FREE_DATE_IN_FUTURE
    Domain freeing date is in the long time future
    NO_DOMAINS_CHECKED
    You have chosen no domains for registration
    NO_CONTRACT
    Filing preschedule for the domain registration after freeing is impossible before You signing up the contract on the domain registration
    INVALID_PUNYCODE_INPUT
    Invalud Punycode name (error while converting from punycode)
    CONNECTION_FAILED
    Domain check failed: can't connect to server. Please, try again later
    DOMAIN_ALREADY_ORDERED
    The domain name $domain_name was order by you, You can pay for the registration and domain will be registered
    DOMAIN_EXPIRED
    Domain $domain_name is either expired or will expire in near future
    DOMAIN_TOO_YOUNG
    From registration date of domain $domain_name passed less than 60 days. Please, try to transfer domain later
    CANT_OBTAIN_EXPDATE
    Can't determine expiration date of domain $domain_name
    DOMAIN_CLIENT_TRANSFER_PROHIBITED
    Domain $domain_name prohibited for transfer, contact previous registrar to unlock domain transfer
    DOMAIN_TRANSFER_PROHIBITED_UNKNOWN
    Domain $domain_name transfer prohibited, contact our technical support staff for details
    DOMAIN_REGISTERED_VIA_DIRECTI
    Automatical internal transfers are unavailable in present time
    NOT_FOUND_UNIQUE_REQUIRED_DATA
    Not found all data for check unique: dname, servtype or user_id
    NOT_FOUND_UNIQUE_REQUIRED_DATA_IN_MARKET
    Not found all data for check unique: market_lot_id, servtype
    ORDER_ALREADY_PAYED
    Order on $dname $servtype is already payed
    DOUBLE_ORDER
    You already have not payed order on $dname $servtype
    DOMAIN_ORDER_LOCKED
    The order or renew of the domain is disabled since processing of other operation for the same domain isn't completed yet
    UNAVAILABLE_DOMAIN_ZONE
    $tld is unavailable domain zone

    Errors at working with DNS servers

    Error_code error_text
    DOMAIN_IS_NOT_USE_REGRU_NSS
    This domain not use REG.RU name services
    REVERSE_ZONE_API_NOT_SUPPORTED
    Reverse zone not supported now
    IP_INVALID
    Invalid IP address
    SUBD_INVALID
    Invalid subdomain
    CONFLICT_CNAME
    Can not set CNAME record together with other record for one subdomain

    Errors at working with DNSSEC

    Error_code error_text
    DOMAIN_DOESNT_SUPPORT_DNSSEC
    This domain doesn't support DNSSEC
    CANT_GET_INFO_FROM_REGISTRY
    Can't get information from provider's registry
    DNSSEC_UPDATING_IN_PROGRESS
    DNSSEC updating for domain already in progress
    DOMAIN_USES_REGRU_NSS
    This domain uses REG.RU nameservers
    DOMAIN_IS_NOT_USE_REGRU_NSS
    This domain not use REG.RU name services
    INVALID_RECORDS
    Invalid records

    Other errors

    Error_code error_text
    NO_SUCH_COMMAND
    Command $command_name not found
    HTTPS_ONLY
    Access to api over non secure interface (http) prohibited! Please use https only
    PARAMETER_MISSING
    $param required
    PARAMETER_INCORRECT
    $param has incorrect format or data
    NOT_ENOUGH_MONEY
    Not enough money at account for this operation
    INTERNAL_ERROR
    Internal error: $error_detail
    SERVICE_OPERATIONS_DISABLED
    Operations on this service disabled
    UNSUPPORTED_CURRENCY
    Unsupported currency
    PRICES_NOT_FOUND
    Prices not found for servtype $servtype
    SERVICE_ALREADY_EXISTS
    Service already exists
    DOMAIN_IS_NOT_ACTIVE
    This domain is not activated yet

    2.4. Authentication

    If ip-addresses are not added, working with the API is impossible. You can add ip-adress to white list on "Security settings" page.

    The major part of API functions requires authentication. The following authentication methods are available:

  • by login and password.
  • by login and signature
  • additional check using the ssl-certificate for two ways stated above
  • 2.4.1. Login authentication

    For login/password access both fields are passed explicitly as the values of the username and password fields:

    https://api.reg.ru/api/regru2/nop?username=test&password=test

    Since logins and passwords are passed explicitly (GET-query), because passwords can be easily intercepted. Use POST-query.

    The list of fields used for authentication and their description is provided in the section «Authenctication parameters».

    For information about errors that might occur at the authentication stage, refer to the list of common error codes.

    2.4.2. Signature authentication

    2.4.3. Additional check using the ssl-certificate

    2.5. Test and production modes to access REG.API

    For debugging purposes you can use the test access mode provided by REG.RU API. For this, just enter “test” for both the login and password. In the test mode, the System ensures all necessary checks of input parameters, provides responses to requests but does not perform any actions for real and does not impose any charges. Functions called in the test mode do not return real data about domains.

    Also, for debugging purposes REG.RU API provides several special functions that allow you to call functions with real identification data. These functions are: nop, reseller_nop, user/nop, bill/nop, domain/nop, zone/nop, service/nop, folder/nop. They do not invoke any actions, but allow users to check the system for availability without putting additional load on it and with minimum response time.

    3. General descriptions of functions

    3.1. Function categories

    Currently there are five categories of API functions:

    1. User functions (relative path: user/) - serve for getting user-related data (current balance requests, registration statistics, etc.).
    2. Domain management functions (relative path: domain/) - allow users to manipulate domains.
    3. Service management functions (relative path: service/) - provide all necessary service management means.
    4. Folder management functions (relative path: folder/) - allows users to group domain and services by their own criteria.
    5. Several debugging functions that do not fall under any category.

    URLs will vary depending on the category of the function you need. The general address format of URLs is as follows:

    https://api.reg.ru/api/regru2/<category_name>/
    
    

    where category_name can have the following values: user, domain, service, folder, bill, zone, hosting.

    3.2. Function accessibility

    In terms of accessibility all REG.RU API functions can be divided into three categories.

    The first category embraces the functions accessible to all users. When called, these functions do not require entering username. Typically these are the functions that serve for getting general data that does not depend on the type of the user calling it. Throughout this document these functions have the «Everyone» value in the column «Accessibility».

    The second category includes the functions that require authentication, but accessible for all users registered on our web site.

    The access to the third category is allowed only for the users who signed up a Partner Agreement with REG.RU.

    3.3. List of functions

    The table below presents a list of all REG.API functions with brief descriptions and accessibility notes. For detailed description of each function, refer to a respective section below.

    Function Short description Accessibility
    Common functions
    returns a login
    Clients
    returns login
    Partners
    Returns client’s user ID
    Clients
    getting an id for a domain or service
    Clients
    User management functions (the category "user")
    Test function
    Everyone
    Registration of a new user
    Partners
    View user statistics
    Clients
    View current balance
    Clients
    Add funds to the client’s balance
    Clients
    set URL for the redirect from the external service
    Partners
    get URL for the redirect from the external service
    Partners
    Invoice management functions (the category «bill»)
    test function
    Clients
    clients
    Clients
    View invoices for the defined period
    Partners
    Change payment method
    Clients
    Delete unpaid invoices
    Clients
    Service management functions (the category «service»)
    Test function
    Clients
    Get serves activation/renewal prices
    Everyone
    Get price for the service
    Everyone
    Order a service
    Everyone
    Validate parameters for service_create
    Everyone
    Remove a service
    Clients
    Get start letter
    Clients
    Get information about services
    Clients
    Get the list of active services
    Clients
    Get the list of folders the service is associated with
    Clients
    Get the service parameters
    Clients
    Get the service parameters
    Clients
    Get the dedicated server list
    Clients
    Configure the service
    Clients
    Renew the service
    Clients
    Get the list of invoices related to the specified services
    Partners
    Enable/disable the autorenewal option
    Clients
    Suspend the service (for a domain – suspend delegation)
    Clients
    Resume the service (for a domain – resume delegation)
    Clients
    Calculate the number of periods till the service expiration date
    Clients
    Upgrade the service (packet)
    Clients
    Grant a part of service management rights to another user
    Clients
    Stop granting service management rights to other users
    Clients
    Resend mail to user
    Clients
    Refill service balance
    Clients
    Refund money from the external service's balance
    Partners
    Get service balance
    Clients
    get link for Seowizard control panel
    Partners
    Partners
    Domain management functions (the category «domain»)
    Test function
    Everyone
    Get prices of domain registration/renewal in all available zones
    Everyone
    Suggest a domain name
    Partners
    Partners
    Get a list of deleted domains
    Partners
    Check that the domain is available for registration
    Partners
    Apply for domain name registration
    Clients
    Apply for transfer of a domain from another registrar
    Clients
    Clients
    Clients
    Cancel domain transfer
    Partners
    Get a list of “to be released” (TBR) domains with details; after registration or renewal the domains are removed from the list
    Partners
    Place bids for TBR domains
    Clients
    Get the list of your bids for TBR domains; after registration or renewal the domains are removed from the list
    Clients
    Get a link for downloading documents on .RU/.SU/.РФ domains
    Clients
    Update of domain contact data
    Clients
    Change settings of the flags «Private Person« and «Total Private Person» (show/hide contact data in WHOIS)
    Clients
    Register a name server in the NSI-registry
    Everyone
    Remove a name server from the NSI-registry
    Everyone
    Get a list of DNS servers
    Clients
    Update the list DNS servers
    Clients
    Allow domain delegation
    Partners
    Suspend domain delegation
    Partners
    Transfer a domain to another account
    Partners
    View the list of transferred domains
    Partners
    Accept or decline the transfered domain
    Partners
    Send request to domain transfer
    Partners with plan Partner 2 or higher
    Clients
    Partners
    DNS management functions (the category «zone»)
    Test function
    Clients
    Associate a subdomain with an IPv4 address
    Clients
    Associate a subdomain with an IPv6 address
    Clients
    Specify SSL certificate issue rules for subdomain
    Clients
    Associate a subdomain with a name of another domain
    Clients
    Define the domain or IP address of the mail server that will receive e-mail destined to your domain
    Clients
    Hand over a subdomain to other DNS servers
    Clients
    Add an arbitrary note (TXT) for a subdomain
    Clients
    Add a service record
    Clients
    Get zone resource records for each subdomain
    Clients
    Add/delete several resource records by a single request
    Partners
    Change the zone cache TTL
    Clients
    Configure the zone for web-forwarding
    Clients
    Delete web-forwarding records of the zone
    Clients
    Configure the zone for parking
    Clients
    Delete parking records of the zone
    Clients
    Remove a resource record
    Clients
    Remove all zone resource records
    Clients
    DNSSEC management functions
    You can check if you can manage DNSSEC of domains.
    Clients
    Gets DNSSEC status for domain.
    Clients
    Enables DNSSEC for domain, that uses REG.RU nameservers.
    Clients
    Disables DNSSEC for domain, that uses REG.RU nameservers.
    Clients
    Regenerates and updates KSK key for domain, that uses REG.RU nameservers.
    Clients
    Regenerates and updates ZSK key for domain, that uses REG.RU nameservers.
    Clients
    Gets list of DNSSEC records of a domain.
    Clients
    Adds information about KSK keys to the parent zone.
    Clients
    Hosting management functions (the category «hosting»)
    check API accessibility
    Clients
    Get Jelastic URL
    Partners
    Set Jelastic URL
    Partners
    get URL to the ParallelsWPB constructor
    Clients
    get list available themes
    Everyone
    get a list of operating systems
    Everyone
    Folder management functions (the category «folder»)
    Test function
    Everyone
    Create a folder
    Everyone
    Delete a folder
    Everyone
    Rename a folder
    Everyone
    Get the list of services in the folder
    Everyone
    Add services to the folder
    Everyone
    Remove services from the folder
    Everyone
    Replace existing services with new ones
    Everyone
    Move services between folders
    Everyone
    Domain Shop management functions
    test function
    Clients
    update lot
    Everyone
    delete lot
    Everyone
    get information about lot
    Everyone
    get the list of lots
    Everyone
    get the list of categories
    Everyone
    get the list of suggested tags
    Everyone

    If you can’t find necessary information about API functions in this document, you can ask a question on the REG.RU API forum

    4. Common functions

    4.1. Function: nop

    Accessibility:
    Clients

    4.2. Function: reseller_nop

    Accessibility:
    Partners
    Support of service list:
    No

    4.3. Function: get_user_id

    Accessibility:
    Clients
    Support of service list:
    No

    4.4. Function: get_service_id

    Accessibility:
    Clients
    Support of service list:
    No

    5. User management functions (the category "user")

    5.1. Function: user/nop

    Accessibility:
    Everyone
    Support of service list:
    No
    Designation:

    Accessibility testing

    Request fields:

    no

    Response fields:

    no

    Example of a request:
    Example of a successful response:
    {
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    5.2. Function: user/create

    Accessibility:
    Partners
    Support of service list:
    No
    Designation:

    new user registration

    Request fields:
    Mandatory fields
    Parameter Description

    user_login

    Login of the new user in the REG.RU system. Allowed symbols: Latin lower-case letters (a-z), digits (0 -9) and the symbols "-" and "_".

    user_password

    Password of the new user. Allowed symbols: Latin lower- and upper-case letters.

    user_email

    E-mail of the new user.

    user_country_code

    Two-letter ISO code of the country of residence of the new user, for example, RU.

    Optional fields — User contact data
    Parameter Description

    user_first_name

    First name

    user_last_name

    Last name

    user_company

    Company the new user belongs to.

    user_jabber_id

    Jabber ID of the new user.

    user_icq

    ICQ UIN of the new user.

    user_phone

    Phone number of the new user in the international format, for example: +7.4951234567.

    user_fax

    Fax number of the new user in the international format, for example: +7.4951234567

    user_addr

    Address of the new user: street, building, office/apartment.

    user_city

    Fax number of the new user in the international format, for example: +7.4951234567

    user_state

    Address of the new user: region/district/state.

    user_postcode

    Postal code.

    user_wmid

    Webmoney ID of the new user.

    user_website

    Web site of the new user.

    user_language

    Two-letter user language code. Only ru and en allowed

    Optional fields — other parameters
    Parameter Description

    user_subsribe

    Subscribe the user to REG.RU newsletters. Valid values: 1 or 0 (default).

    user_mailnotify

    Send a notification about registration in the REG.RU to the user. Valid values: 1 (default) or 0.

    set_me_as_referrer

    Mark the user as a referral. Valid values: 1 or 0 (default).

    check_only

    Do not register the user, just check the contacts. 1 or 0 (default). 1 or 0 (default). If the parameter is set to 1, the response will include user_id=777.

    white_list_ips

    One or more ranges of IP-addresses that will be available to work on the API for this user. Examples: Single IP-address: 192.168.0.1, 32-bit CIDR-notation: 192.168.0.1/32, with a subnet mask: 192.168.0.1/255.255.255.255, incomplete IP-address (empty bits are the network address): 192.168.
    Examples of the list:
    PLAIN: white_list_ips=192.168.0.1&white_list_ips=192.168.0.2&white_list_ips=192.168.0.3
    JSON: "white_list_ips":["192.168.0.1","192.168.0.2","192.168.0.3"]
    XML: 192.168.0.1192.168.0.2

    Response fields:
    Field Description

    user_id

    Identifier of the newly created user.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "user_id" : "777"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    USER_LOGIN_NOT_UNIQUE
    This login already is busy

    And also see the list of common error codes

    5.3. Function: user/get_statistics

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    Get user statistics.

    Request fields:
    Parameter Description

    date_from

    This field sets the statistics start date (optional parameter).

    date_till

    This field sets the statistics end date (optional parameter).

    Response fields:
    Field Description

    costs_for_period

    Amount of funds spent during the specified period.

    active_domains_cnt

    Number of active domains, including domains under partial management.

    active_domains_get_ctrl_cnt

    Number of domains under partial management.

    renew_domains_cnt

    Number of domains subject to renewal.

    renew_domains_get_ctrl_cnt

    Number of partially managed domains subject to renewal.

    trans_in_domains_cnt

    Number of domains pending transfer to REG.RU (if any).

    undelegated_domains_cnt

    Number of undelegated domains.

    reg_domains_cnt

    Number of domains registered during the period.

    domain_folders_cnt

    Number of domain folders.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "active_domains_cnt" : "5",
          "active_domains_get_ctrl_cnt" : "3",
          "domain_folders_cnt" : "2",
          "renew_domains_cnt" : "4",
          "renew_domains_get_ctrl_cnt" : "1",
          "undelegated_domains_cnt" : "6"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    5.4. Function: user/get_balance

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    View current balance.

    Request fields:
    Parameter Description

    currency

    Define the currency in which the balance is presented. Conversion is performed automatically in accordance with the current exchange rates. Available options: RUR (default), USD, EUR, UAH.

    Response fields:
    Field Description

    currency

    The currency into which the amounts were converted.

    prepay

    Amount of prepayments in the account.

    blocked

    The amount blocked in the account, for example, for taking part in a domain auction. Available when the amount is non-zero.

    credit

    The amount of available credit (for Partners only).

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "credit" : "10",
          "currency" : "RUR",
          "prepay" : "1000"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    5.5. Function: user/refill_balance

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    Add funds to the account. Allows sending invoices to WebMoney.

    Request fields:
    Parameter Description

    pay_type

    Payment method. Available options: WM — WebMoney, requires specifying of WMID.

    wmid

    WebMoney ID

    currency

    Currency of the transfer. USD, EUR and UAH for WebMoney.

    amount

    Amount of the invoice.

    Response fields:
    Field Description

    bill_id

    Invoice ID.

    pay_type

    Payment method.

    payment

    Advance payment amount.

    total_payment

    Total payment amount with consideration for currency conversion into roubles and additional charges for the transfer (if any).

    currency

    Currency, into which the funds were converted upon request.

    wm_invid

    WebMoney ID. 0 (zero) indicates that there probably have been a connection failure; make sure the advance payment was received.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "bill_id" : "123456",
          "currency" : "RUR",
          "pay_notes" : "Bill for prepay created",
          "pay_type" : "WM",
          "payment" : "1000",
          "total_payment" : "1000",
          "wm_invid" : "12345678"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    5.6. Function: user/set_reseller_url

    Accessibility:
    Partners
    Support of service list:
    No
    Designation:

    Sets reseller redirect URL for the external service

    Request fields:
    Parameter Description

    servtype

    Service type for URL setting. Available types:
    srv_seowizard

    url_type

    Type of the URL for the redirect. Available types:
    refill
    refund

    url

    URL for the redirect. Can contain next tokens:
    — service identifier
    — Email used while service creation.

    Response fields:

    no

    Example of a request:
    Example of a successful response:
    {
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    5.7. Function: user/get_reseller_url

    Accessibility:
    Partners
    Support of service list:
    No
    Designation:

    Gets reseller redirect URL for the external service

    Request fields:
    Parameter Description

    servtype

    Service type for URL setting. Available types:
    srv_seowizard

    url_type

    Type of the URL for the redirect. Available types:
    refill
    refund

    Response fields:

    no

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "url" : "http://test2.com"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    6. Invoice management functions (the category «bill»)

    6.1. Function: bill/nop

    Accessibility:
    Clients
    Support of invoice lists:
    Yes
    Designation:

    For testing purposes.

    Request fields:
    Parameter Description

    bill_id

    Invoice number in case of a single-invoice request.

    bills

    A list if invoice numbers.

    Response fields:
    Field Description

    bills

    A list of invoices.

    bill_id

    The number of the invoice.

    pay_status

    Payment status of the invoice (for the list of statuses see below).

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "bills" : [
             {
                "bill_id" : "12345",
                "pay_status" : "payed"
             },
             {
                "bill_id" : "12346",
                "error_code" : "BILL_ID_NOT_FOUND"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    6.2. Function: bill/get_not_payed

    Accessibility:
    Clients
    Support of invoice lists:
    Yes
    Designation:

    Use this function to obtain a list of unpaid invoices.

    Request fields:
    Parameter Description

    limit

    Defines the number of invoices to be included in the output at a time. Default value: 100. Maximum value: 1024.

    offset

    The offset from the starting point, if the number of invoices exceeds the defined limit.

    Response fields:
    Field Description

    bills

    The list of invoices.

    bill_id

    Invoice ID.

    bill_date

    Date of issue.

    currency

    Invoice currency (RUR, USD, EUR, UAH).

    payment

    Invoice amount in roubles (including the payment system interest).

    total_payment

    Total invoice amount in the currency you defined (includes the overall price of services included into the invoice, the interest of the payment system and the interest for currency conversion if the payment is made in the currency other than Russian roubles).

    pay_type

    Payment method. Available alternatives: prepay – advance payment, WM – WebMoney, bank – bank transfer, pbank – non-cash bank transfer, yamoney & ymbill – Yandex.Dengi, robox – ROBOXchange, cash – payment by cash in a Company’s office, alfacard – Alfa Bank card, chronopay – ChronoPay card, handybank – Handy Bank, rbkmoney – RBK-Money, osmp – QIWI terminal, paypal – PayPal.

    pay_status

    Payment status of the invoice, (only notpayed — unpaid).

    items

    Invoice items.

    itemtype

    Item type: prepayment or service – order of a service.

    dname

    Service domain name (if applicable).

    servtype

    Service type.

    service_id

    Service ID.

    action

    New service order or renewal of an existing service.

    Example of a request:
    Example of a successful response:
    
    {
        answer => {
            bills => [
                {
                    bill_id       => 12345,
                    bill_date     => '1917-10-16',
                    currency      => 'RUR',
                    payment       => 100.00,
                    total_payment => 100.00,
                    pay_type      => 'cash',
                    pay_date      => null,
                    pay_status    => 'notpayed',
                    items => [
                        {
                            dname      => 'october.org',
                            itemtype   => 'service',
                            action     => 'new',
                            servtype   => 'domain',
                            service_id => 12345
                        },
                        {
                            dname      => 'october.org',
                            itemtype   => 'service',
                            action     => 'new',
                            servtype   => 'srv_certificate',
                            service_id => 12346
                        }
                    ]
                }
            ]
        },
        result => 'success'
    }
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    6.3. Function: bill/get_for_period

    Accessibility:
    Partners
    Support of invoice lists:
    Yes
    Designation:

    Use this function to obtain a list of invoices for the defined period.

    Request fields:
    Parameter Description

    start_date

    Starting date of the requested period in the ISO format. Mandatory field.

    end_date

    End date of the requested period in the ISO format. Mandatory field.

    pay_type

    Payment method. For information about available alternatives refer to the description of response fields.

    limit

    Defines the number of invoices to be shown in the output at a time. Default value: 100. Maximum value: 1024.

    offset

    The offset from the starting point, if the number of invoices exceeds the defined limit.

    all

    Show inactive invoices, i.e. invoices for outdated services and invoices cancelled due to impossibility of order execution.

    Response fields:
    Field Description

    bills

    A list of invoices.

    bill_id

    Invoice ID.

    bill_date

    Date of issue.

    currency

    Invoice amount in roubles (including the payment system interest).

    payment

    Invoice amount in roubles (including the payment system interest).

    total_payment

    Total invoice amount in the currency you defined (includes the overall price of services included into the invoice, the interest of the payment system and the interest for currency conversion if the payment is made in other currency than Russian roubles).

    pay_type

    Payment method. Available alternatives: prepay – advance payment, WM – WebMoney, bank – bank transfer, pbank – non-cash bank transfer, yamoney & ymbill – Yandex.Dengi, robox – ROBOXchange, cash – payment by cash in a Company’s office, alfacard – Alfa Bank card, chronopay – ChronoPay card, handybank – Handy Bank, rbkmoney – RBK-Money, osmp – QIWI terminal, paypal – PayPal.

    pay_status

    Payment status of the invoice. Available alternatives: notpayed – unpaid, confirmed – the payment is confirmed but has not been received yet (e.g. bank transfer delay), payed – paid, cancelled – payment cancelled on the side of the payment system.

    items

    Invoice items.

    itemtype

    Item type: «prepayment» or «service» – order of a service.

    dname

    Service domain name (if applicable).

    servtype

    Service type.

    service_id

    Service ID.

    action

    New service order or renewal of an existing service.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "bills" : [
             {
                "bill_date" : "1917-10-16",
                "bill_id" : "12345",
                "currency" : "RUR",
                "items" : [
                   {
                      "action" : "new",
                      "dname" : "october.org",
                      "itemtype" : "service",
                      "service_id" : "12345",
                      "servtype" : "domain"
                   },
                   {
                      "action" : "new",
                      "dname" : "october.org",
                      "itemtype" : "service",
                      "service_id" : "12346",
                      "servtype" : "srv_certificate"
                   }
                ],
                "pay_date" : "1917-10-16",
                "pay_status" : "payed",
                "pay_type" : "cash",
                "payment" : "100",
                "total_payment" : "100"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    6.4. Function: bill/change_pay_type

    Accessibility:
    Clients
    Support of invoice lists:
    Yes
    Designation:

    You can use this function to change payment methods. Some of the methods allow issue of invoices in the defined payment systems, advance payments are made immediately.

    Request fields:
    Parameter Description

    bill_id

    Invoice ID (in case of single invoice request).

    bills

    A list of invoice IDs.

    pay_type

    New payment type. Mandatory field. Valid values: prepay — advance payment (to be made immediately); WM — WebMoney. With the WMID defined, the invoices are issued to the customer’s WM account; yamoney — Yandex.Dengi; bank — bank transfer

    currency

    Currency. Mandatory field. «Yandex.Dengi» allows RUR only, «bank» and «prepay» – RUR and USD, «WebMoney» also allows EUR and UAH.

    wmid

    WebMoney ID

    Response fields:
    Field Description

    bills

    List of invoices.

    bill_id

    Invoice ID.

    currency

    Currency (RUR, USD, EUR, UAH).

    payment

    Invoice amount in roubles (including the payment system interest).

    total_payment

    Total invoice amount in the currency you defined (includes the overall price of services included into the invoice, the interest of the payment system and the interest for currency conversion if the payment is made in other currency than Russian rubles).

    pay_type

    Payment method.

    pay_status

    Payment status of the invoice: «notpayed» – unpaid, «payed» – paid, «cancelled» – payment was cancelled on the side of the payment system.

    wm_invid

    WebMoney ID.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "bills" : [
             {
                "bill_id" : "123456",
                "currency" : "RUR",
                "old_pay_type" : "cash",
                "pay_status" : "payed",
                "pay_type" : "prepay",
                "payment" : "100",
                "result" : "success",
                "total_payment" : "100"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    6.5. Function: bill/delete

    Accessibility:
    Clients
    Support of invoice lists:
    Yes
    Designation:

    Delete unpaid invoices

    Request fields:
    Parameter Description

    bill_id

    Invoice ID (in case of a single-invoice request).

    bills

    A list of invoice IDs.

    Response fields:
    Field Description

    bills

    A list of invoices.

    bill_id

    Invoice ID.

    status

    Invoice status (assigned to real invoices only): deleted – for deleted invoices, active – for invoices that have been paid but cannot be deleted.

    pay_status

    Payment status of the invoice (for available alternatives, see the list above).

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "bills" : [
             {
                "bill_id" : "12345",
                "pay_status" : "notpayed",
                "result" : "success",
                "status" : "deleted"
             },
             {
                "bill_id" : "12346",
                "error_code" : "BILL_CAN_NOT_REMOVED",
                "pay_status" : "payed",
                "status" : "active"
             },
             {
                "bill_id" : "12347",
                "error_code" : "BILL_ID_NOT_FOUND"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7. Service management functions (the category «service»)

    7.1. Function: service/nop

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    This function serves for testing purposes. You can use it to check the availability of the list of services and get service IDs.

    Request fields:

    common service identification parameters and service list identification parameters.

    Response fields:
    Field Description

    service_id

    The service ID, if dname+servtype have been passed.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "services" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345",
                "servtype" : "domain"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.2. Function: service/get_prices

    Accessibility:
    Everyone
    Designation:

    Get serves registration/renewal prices.

    Request fields:
    Parameter Description

    You should undergo authentication to get the list of partners? prices.

    show_renew_data

    With this flag enabled the system will return the price of renewal (1/0). Optional field.

    currency

    Identifier of the currency in which the prices will be quoted: rur (default), uah, usd, eur. Optional field.

    Example of a request:
    Example of a successful response:
    {
        "answer" => {
          "currency" => "RUR",
          "pricegroup" => "0",
          "show_renew_data" => "0",
          "prices" => [
             {
                "servortld" => "srv_addip",
                "unit" => "month",
                "subtype" => "",
                "price" => "30"
             },
             {
                "servortld" => "srv_addip",
                "unit" => "month",
                "subtype" => "custom_net",
                "price" => "60"
             },
             ...
          ]
          "result" => "success"
        }
    }
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.3. Function: service/get_servtype_details

    Accessibility:
    Everyone
    Designation:

    Use this function to get prices for services and general data.

    Request fields:

    Parameter Description

    servtype

    Type of service: srv_webfwd — web forwarding
    srv_parking — domain parking
    srv_dns_both — DNS support
    srv_hosting_ispmgr — hosting
    srv_certificate — domain certificate
    srv_voucher — domain voucher
    srv_kvm — KVM access.

    subtype

    Service subtype.

    unroll_prices

    Show prices in expanded form.

    only_actual

    Show only actual subtypes

    Note: To obtain prices for several service types, you can define them in the servtype field delimiting them with commas or include several servtype fields into the request. In this case the field subtype is ignored.

    Response fields:

    A list of a service subtype. Each element of the list includes fields:

    Field Description

    servtype

    The type of a service.

    subtype

    The subtype of a service.

    unit

    Time unit for measuring periods: "YEAR" or "MONTH".

    extparams

    Additional parameters.

    is_renewable

    1 – service renewal is allowed
    0 – service cannot be renewed.

    commonname

    Description formats.

    Additional fields that can be used, when the parameter uroll_pricess is not used or its value is NULL:

    Parameter Description

    periods_new

    The available range of registration periods.

    periods_renew

    The available range of renewal periods.

    price_new

    The price of a new service.

    price_renew

    The price of service renewal.

    Additional fields that can be used, when the parameter uroll_pricess=1:

    Field Description

    prices_new

    A list of prices and periods for ordering new services.

    prices_renew

    A list of prices and periods for service renewal.

    Example of a request:

    request_sample method: service/get_servtype_details query: output_content_type: plain servtype: srv_hosting_ispmgr test_user: 1

    Example of a successful response:

    {
       "answer" : [
          {
             "commonname" : "Web-forwarding",
             "extparams" : {},
             "is_renewable" : "1",
             "periods_new" : "1-10",
             "periods_renew" : "1-10",
             "price_new" : "120.00",
             "price_renew" : "120.00",
             "servtype" : "srv_webfwd",
             "subtype" : "",
             "unit" : "year"
          }
       ],
       "result" : "success"
    }
    
    

    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.4. Function: service/create

    Accessibility:
    Everyone
    Support of service list:
    No
    Designation:

    Use the function to order new services.

    Request fields:
    Common
    Parameter Description

    domain_name

    Name of the domain, for which the service is ordered.

    servtype

    The type of the ordered service:
    srv_webfwd — web forwarding
    srv_parking — domain parking
    srv_dns_both — DNS support
    srv_hosting_ispmgr — ISPmanager hosting
    srv_hosting_cpanel — CPanel hosting
    srv_hosting_plesk — PLesk hosting
    srv_ssl_certificate — SSL certificate
    srv_certificate — Domain certificate
    srv_voucher — Domain voucher
    srv_vps — VPS server
    srv_license_isp — ISP Manager license
    srv_license_plesk — Parallels Plesk license
    srv_addip — additional IP address
    srv_disk_space — additional disk space,
    srv_antispam — advanced spam protection
    srv_dedicated — dedicated server
    srv_kvm — KVM access
    srv_jelastic — Jelastic cloud hosting
    srv_seowizard — Automatic SEO promotion
    srv_rs_joomla — Ready-made solutions based on Joomla
    srv_rs_wordpress — Ready-made solutions based on Wordpress
    srv_websitebuilder - REG.RU website builder,
    srv_mail_ru - Mail.Ru for business

    period

    The period for which the service is ordered, the unit of measurement (year or month) depends on the type of the service being ordered.
    To learn about the measurement units used for each service, use the service/get_servtype_details function.

    user_servid

    Domain ID set by the user. Allowed symbols: digits (from 0 through 9), Latin letters (from a through f). Maximum length: 32 symbols. This ID cannot be generated automatically; if it is not defined upon service ordering, the field will be empty. Optional field.

    Payment-related parameters (optional)
    Parameter Description

    point_of_sale
    pay_type
    ok_if_no_money

    Other common parameters (optional)
    Parameter Description

    folder_name
    or folder_id

    Defines the name of the folder, to which the services will be added (see the list of common folder identification parameters).

    no_new_folder

    If a non-existing folder name is defined:
    0 — (default) — create a folder with this name.
    1 — do not create the folder, return an error code.

    comment

    An arbitrary text describing the order. Optional field.

    admin_comment

    A comment for administrators. An arbitrary text describing the order. Optional field.

    ISPmanager hosting (srv_hosting_ispmgr)
    Parameter Description

    plan (deprecated)

    The rate plan. Currently available rate plans are:
    "Host-0-1019", "Host-1-1019", "Host-3-1019", "Host-A-1019", "Host-B-1019", "Host-Lite-1019". For defining a rate plan we recommend that you use the “subtype” parameter.

    subtype

    The rate plan. Currently available rate plans are:
    "Host-0-1019", "Host-1-1019", "Host-3-1019", "Host-A-1019", "Host-B-1019", "Host-Lite-1019".

    contype

    Type of contact data. Takes the value "hosting_pp" at the server registration to the individual person data and the value "hosting_org" at server registration to the legal person.

    email

    E-mail address for the created hosting account.

    phone

    Phone number. Optional field.

    country

    Two-letter ISO-code of the country, in which the individual person (organization) is registered.

    person_r

    It is indicated with "contype" parameter with the value "hosting_pp". Surname, name and patronymic of the server administrator in the Russian language according to the Passport data. For the foreigners the field contains the name in the original spelling (if not possible, use English transliteration).
    1st example: Пупкин Василий Николаевич
    2nd example: John Smith

    passport

    It is indicated with "contype" parameter with the value "hosting_pp". Passport series and number, the name of the authority, which issued the Passport, date of issuing (in the indicated order, separated by space). In writing Roman numerals, it’s possible to use Latin letters only. The date is written in DD.MM.YYYY format. The character denoting the number is not put before the passport number. UUSR passports (passports of the old sample) are not accepted. In case of using any other documents instead of the Passport (allowed ONLY for non-residents of Russia), indicate the document type at the beginning of the line. The writing can be multiline.
    Example: 34 02 651241 issued 48 p/d of Moscow, dd. 26.12.1990

    pp_code

    It is indicated with "contype" parameter with the value "hosting_pp". The identification number of a taxpayer (INN). The field can be left blank if the administrator is a non-resident of the Russian Federation and doesn’t have an identification number of a taxpayer. Optional field.
    Example: 7701107259

    org_r

    It is indicated with "contype" parameter with the value "hosting_pp". Full name of the Administrator’s organization in the Russian language according to the constituent document. For non-residents it is indicated in the national language (or in English). The writing can be multiline.
    1st example: Uryupinsk State University named after Karla-Marla
    2nd example: Limited Liability Compaby "Roga i Kopyta"

    code

    It is indicated with "contype" parameter with the value "hosting_pp". The identification number of a taxpayer (INN), which is assigned to the organization of the Administrator. The field can be left blank if the administrator is non-resident of the Russian Federation and doesn’t have an identification number of a taxpayer.
    Example: 7701107259

    Cpanel hosting (srv_hosting_cpanel)
    Parameter Description

    subtype

    Service plan, now available:
    "Host-0-1019", "Host-1-1019", "Host-3-1019", "Host-A-1019", "Host-B-1019".

    contype

    Contact data type. Takes the value "hosting_pp" at server registration to the individual person data and the value "hosting_org" at server registration to legal person.

    email

    E-mail address for the created hosting account.

    phone

    Phone number. Optional field.

    country

    Two-letter ISO code of the country, in which the person (organization) is registered.

    person_r

    It is indicated with "contype" parameter with the value "hosting_pp". Surname, name and patronymic of the server administrator in the Russian language according to the Passport data. For the foreigners the field contains the name in the original spelling (if not possible, use English transliteration).
    1st example: Пупкин Василий Николаевич
    2nd example: John Smith

    passport

    It is indicated with "contype" parameter with the value "hosting_pp". Passport series and number, the name of the authority, which issued the Passport, date of issuing (in the indicated order, separated by space). In writing Roman numerals, it’s possible to use Latin letters only. The date is written in DD.MM.YYYY format. The character denoting the number is not put before the passport number. UUSR passports (passports of the old sample) are not accepted. In case of using any other documents instead of the Passport (allowed ONLY for non-residents of Russia), indicate the document type at the beginning of the line. The writing can be multiline.
    Example: 34 02 651241 issued 48 p/d of Moscow, dd. 26.12.1990

    pp_code

    It is indicated with "contype" parameter with the value "hosting_pp". The identification number of a taxpayer (INN). The field can be left blank if the administrator is a non-resident of the Russian Federation and doesn’t have an identification number of a taxpayer. Optional field.
    Example: 7701107259

    org_r

    It is indicated with "contype" parameter with the value "hosting_pp". Full name of the Administrator’s organization in the Russian language according to the constituent document. For non-residents it is indicated in the national language (or in English). The writing can be multiline.
    1st example: Uryupinsk State University named after Karla-Marla
    2nd example: Limited Liability Compaby "Roga i Kopyta"

    code

    It is indicated with "contype" parameter with the value "hosting_pp". The identification number of a taxpayer (INN), which is assigned to the organization of the Administrator. The field can be left blank if the administrator is non-resident of the Russian Federation and doesn’t have an identification number of a taxpayer.
    Example: 7701107259

    Plesk hosting (srv_hosting_plesk)
    Parameter Description

    subtype

    Тарифный план, сейчас доступны:
    "Host-0-1019", "Host-1-1019", "Host-3-1019", "Host-A-1019", "Host-B-1019", "Host-Lite-1019", "Host-SB-0311", "Win-0-0618", "Win-1-0618", "Win-3-0618", "Win-A-0618", "Win-B", "Win-Lite".

    contype

    Тип контактных данных. Принимает значение "hosting_pp" при регистрации сервера на данные физического лица и значение "hosting_org" при регистрации сервера на данные юридического лица.

    email

    E-mail address for the created hosting account.

    phone

    Phone number. Optional field.

    country

    Two-letter ISO code of the country, in which the person (organization) is registered.

    person_r

    This parameter is valid only when the “contype” parameter is set to “pp”. It defines the last name, first name and patronymic of the server administrator in Russian in compliance with the passport data. For non-residents, this field should include the person name spelled in the national characters (or in the English transliteration).
    Example 1: Пупкин Василий Николаевич
    Example 2: John Smith

    passport

    This parameter is valid only when the “contype” parameter is set to “pp”. It defines the series and number of the passport, as well as the name of the authority that issued the passport and the date of issue (in the specified order and delimited by whitespaces). Roman numerals must include Latin letters only. The date must be specified in the YY.MM.YYYY format. Do not use the No symbol before the passport number. USSR passports are not valid. In case another document is used (allowed for NON-RESIDENTS ONLY), the type of the document should be specified at the beginning of the string. Multi-line records are allowed.
    Example: 34 02 651241 выдан 48 о/м г.Москвы 26.12.1990

    pp_code

    It is indicated with "contype" parameter with the value "hosting_pp". The identification number of a taxpayer (INN). The field can be left blank if the administrator is a non-resident of the Russian Federation and doesn’t have an identification number of a taxpayer. Optional field.
    Example: 7701107259

    org_r

    It is indicated with "contype" parameter with the value "hosting_pp". Full name of the Administrator’s organization in the Russian language according to the constituent document. For non-residents it is indicated in the national language (or in English). The writing can be multiline.
    1st example: Uryupinsk State University named after Karla-Marla
    2nd example: Limited Liability Compaby "Roga i Kopyta"

    code

    This parameter is valid only when the “contype” parameter is set to “org”. Taxpayer identification code (INN) assigned to the organization, the administrator of the domain. For non- resident organization having no INN an empty string is allowed.
    Example: 7701107259

    Ready-made solutions ( srv_rs_joomla и srv_rs_wordpress )
    Parameter Description

    subtype

    The rate plan.
    Currently available rate plans for Joomla based solutions are:
    corporate-0617
    eCommerce-0617.
    Currently available rate plans for Wordpress based solutions are:
    blog-0617
    corporate-0617
    eCommerce-0617
    ecwid-0617
    portfolio-0617

    theme

    Theme. Use "hosting/get_rs_themes" for list of available themes.

    contype

    Type of contact data. Takes the value "hosting_pp" at the server registration to the individual person data and the value "hosting_org" at server registration to the legal person.

    email

    E-mail address for the created hosting account.

    phone

    Phone number. Optional field.

    country

    Two-letter ISO-code of the country, in which the individual person (organization) is registered.

    person_r

    It is indicated with "contype" parameter with the value "hosting_pp". Surname, name and patronymic of the server administrator in the Russian language according to the Passport data. For the foreigners the field contains the name in the original spelling (if not possible, use English transliteration).
    1st example: Пупкин Василий Николаевич
    2nd example: John Smith

    passport

    It is indicated with "contype" parameter with the value "hosting_pp". Passport series and number, the name of the authority, which issued the Passport, date of issuing (in the indicated order, separated by space). In writing Roman numerals, it’s possible to use Latin letters only. The date is written in DD.MM.YYYY format. The character denoting the number is not put before the passport number. UUSR passports (passports of the old sample) are not accepted. In case of using any other documents instead of the Passport (allowed ONLY for non-residents of Russia), indicate the document type at the beginning of the line. The writing can be multiline.
    Example: 34 02 651241 issued 48 p/d of Moscow, dd. 26.12.1990

    pp_code

    It is indicated with "contype" parameter with the value "hosting_pp". The identification number of a taxpayer (INN). The field can be left blank if the administrator is a non-resident of the Russian Federation and doesn’t have an identification number of a taxpayer. Optional field.
    Example: 7701107259

    org_r

    It is indicated with "contype" parameter with the value "hosting_pp". Full name of the Administrator’s organization in the Russian language according to the constituent document. For non-residents it is indicated in the national language (or in English). The writing can be multiline.
    1st example: Uryupinsk State University named after Karla-Marla
    2nd example: Limited Liability Compaby "Roga i Kopyta"

    code

    It is indicated with "contype" parameter with the value "hosting_pp". The identification number of a taxpayer (INN), which is assigned to the organization of the Administrator. The field can be left blank if the administrator is non-resident of the Russian Federation and doesn’t have an identification number of a taxpayer.
    Example: 7701107259

    Parking (srv_parking)
    Parameter Description

    title

    A page element located at top of page (optional).

    content

    HTML-code of the page.

    counter_html_code

    HTML-code of counters (optional).

    template_name

    Template identifier. Available identifiers:

    private_property
    "Private property"
    under_construction
    "Site is under construction"
    for_sale
    "Domain is for sale"
    for_rent
    "Domain is for rent"
    for_you_gift
    "A gift for you"
    happy_new_year
    "Happy new Year!"
    happy_birthday1
    "Happy Birthday!" (1st variant)
    happy_birthday2
    "Happy Birthday!" (2nd variant)
    love_happiness
    "Love and happiness!"
    empty
    Empty page
    raw_html
    Your own HTML code (only for paid parking, without standard advertising block)

    html_title

    HTML meta tag «Title».

    html_description

    HTML meta tag «Description».

    html_keywords

    HTML meta tag «Keywords».

    opt_user_contacts

    Show block with domain owner contacts.

    opt_feedback_link

    Show information block with link "Contact domain owner" (link to domain Whois).

    Possible values:

  • «1» — the function is ON
  • «0» — the function is OFF

  • opt_domain_shop_link

    Show link to Domain Shop lot if possible.

    Possible values:

  • «1» — the function is ON
  • «0» — the function is OFF

  • opt_whois_link

    Show link to domain Whois.

    Possible values:

  • «1» — the function is ON
  • «0» — the function is OFF

  • opt_se_link

    Show links from search engines to domain.

    Possible values:

  • «1» — the function is ON
  • «0» — the function is OFF

  • opt_indexed_link

    Show links to pages of website indexed by search engines.

    Possible values:

  • «1» — the function is ON
  • «0» — the function is OFF

  • opt_blogs_link

    Show links to website from blogging engines.

    Possible values:

  • «1» — the function is ON
  • «0» — the function is OFF

  • subtype

    Optional. Set free for free parking

    Example of a request for parking:
    Example of a successful response:
    
    {
        'result' => 'success';
        'answer' => {
            'descr' => 'service srv_parking is ordered for domain qqq.ru',
            'payment' => '100',
            'pay_notes' => 'Amount successfully charged',
            'bill_id' => '1234',
            'service_id' => '987654'
         }
    }
    
    Example of a request for free parking:
    Example of a successful response:
    
    {
        'result' => 'success';
        'answer' => {
            'descr' => 'service srv_parking is ordered for domain qqq.ru',
            'payment' => '0',
            'pay_notes' => 'Amount successfully charged',
            'bill_id' => '1234',
            'service_id' => '987654'
         }
    }
    
    SSL certificate (srv_ssl_certificate)
    Parameter Description

    obligatory:
    org_org_name, org_address, org_city, org_state, org_postal_code, org_country, org_phone

    optional:
    org_first_name, org_last_name, org_fax

    Name, address, first name, last name city, state (province), postal code, country, phone, fax number of the organization.

    Required for all Thawte, Comodo, VeriSign SSL certificates. Required for GeoTrust True BusinessID, True BusinessID Wildcard, True BusinessID with EV.

    obligatory:
    admin_first_name, admin_last_name, admin_title, admin_address, admin_city, admin_state, admin_postal_code, admin_country, admin_phone, admin_email,

    optional:
    admin_fax, admin_org_name

    First name, last name, address, city, state, postal_code, country, phone number, e-mail address, fax and organization of the administrator.

    Required for all Thawte, GeoTrust, Trustwave and VeriSign SSL certificates and for Comodo EV SSL certificate.

    obligatory:
    billing_first_name, billing_last_name, billing_title, billing_address, billing_city, billing_state, billing_postal_code, billing_country, billing_phone, billing_email,

    optional:
    billing_fax, billing_org_name

    First name, last name, address, city, state, postal_code, country, phone number, e-mail address, fax and organization of the billing manager.

    Required for all Thawte, GeoTrust and VeriSign SSL certificates and for Comodo EV SSL certificate.

    obligatory:
    tech_first_name, tech_last_name, tech_title, tech_address, tech_city, tech_state, tech_postal_code, tech_country, tech_phone, tech_email,

    optional:
    tech_fax, tech_org_name

    First name, last name, address, city, state, postal_code, country, phone number, e-mail address, fax and organization of the technical specialist.

    Required for all Thawte, GeoTrust and VeriSign SSL certificates and for Comodo EV SSL certificate.

    obligatory:
    signer_first_name, signer_last_name, signer_title, signer_address, signer_city, signer_state, signer_postal_code, signer_country, signer_phone, signer_email,

    optional:
    signer_fax, signer_org_name

    First name, last name, address, city, state, postal_code, country, phone number, e-mail address, fax and organization of the SSL certificate signer manager.

    Required for Comodo EV SSL certificate.

    approver_email

    The e-mail address for certificate confirmation.

    server_type

    Software. Possible values:
    For Comodo SSL certificates:
    apachessl, citrix, domino, ensim, hsphere, iis4, iis6, iis7, iplanet, javawebserver, netscape, ibmhttp, novell, oracle, other, plesk, redhat, sap, tomcat, webstar, whmcpanel

    For Thawte, GeoTrust and VeriSign SSL certificates:
    apache2 apacheopenssl apacheraven apachessl apachessleay c2net cobaltseries cobaltraq3 cobaltraq2 cpanel domino dominogo4626 dominogo4625 ensim hsphere iis iis4 iis5 iplanet ipswitch netscape ibmhttp other plesk tomcat weblogic website webstar webstar4 zeusv3

    TrustWave SSL certificates does not require this parameter.

    csr_string

    Encoded CSR including starting and ending markers.

    subtype

    Type of the certificate. Possible values:

    GlobalSign:
    gs_alphassl, gs_alphassl_wildcard, gs_domainssl, gs_domainssl_wildcard,
    gs_organizationssl, gs_extendedssl, gs_organizationssl_wildcard,
    gs_alphassl_dns, gs_domainssl_dns, gs_alphassl_dns_wildcard,
    gs_domainssl_dns_wildcard
    gs_domainssl_free( only two parameters are enough for ordering: service_id и dname)

    Thawte:
    ssl123, sgcsuper_certs, sslwebserver, sslwebserver_wildcard, sslwebserver_ev

    Symantec:
    securesite, securesite_pro, securesite_ev, securesite_pro_ev

    GeoTrust:
    quickssl, quickssl_premium, truebizid, truebizid_wildcard, truebizid_ev

    TrustWave:
    trustwave_dv, trustwave_ev, trustwave_premiumssl, trustwave_premiumssl_wildcard

    Comodo:
    comodo_ev, comodo_instantssl, comodo_premiumssl, comodo_premiumssl_wildcard, comodo_ssl, comodo_wildcard

    Domain certificate (srv_certificate)
    Domain voucher (srv_voucher)
    Parameter Description

    obtain_cert

    The way to obtain the certificate:
    in_office — in the office of REG.RU
    Additional parameters: office, phone, remark free_mail — free shipping by mail to any city of the Russian federation
    Additional parameters: postcode, name, addr.
    paid_mail — Shipping by mail to any city of the world (fee- paying). Additional parameters: postcode, name, addr, city, country_code, state.

    office

    Allowed values: moscow, samara, kiev, piter

    phone

    Phone number in the international: the "+" symbol, country code, phone number.

    remark

    A note.

    p_postcode

    Postal code for certificate delivery (free shipping within Russia).

    p_addr

    The address in Russia.

    p_name

    Last name, First name, Patronymic (in Russian)

    a_postcode

    Postal code for international mail.

    a_addr

    Postal address for international mail (in Latin characters only).

    a_name

    Recipient name for international mail (in Latin characters only).

    a_state

    Region, state.

    a_city

    City for certificate delivery (international mail)

    a_country_code

    Country code (for example, UK)

    VPS server (srv_vps)
    Parameter Description

    subtype

    Rate plan. Currently available rate plans are:
    BX-VPS-1
    BX-VPS-2
    BX-VPS-3
    RH-1-1216
    RH-2-1216
    RH-3-1216
    SSD-VPS-1-1018
    SSD-VPS-2-1018
    SSD-VPS-3-1018
    SSD-VPS-4-1018
    SSD-VPS-5-1018
    SSD-XEN-1-1018
    SSD-XEN-2-1018
    SSD-XEN-3-1018
    SSD-XEN-4-1018
    SSD-XEN-5-1018
    VPS-1-1018
    VPS-2-1018
    VPS-3-1018
    VPS-4-1018
    VPS-5-1018
    WIN-1
    WIN-2
    WIN-3
    WIN-4
    WIN-5
    WIN-6
    WIN-7
    XEN-1-1018
    XEN-2-1018
    XEN-3-1018
    XEN-4-1018
    XEN-5-1018
    XEN-6-1018
    XEN-7-1018
    XEN-8-1018.

    vpsname

    Server name for identification in the service lists.

    ostmpl

    A template of pre-installed operating system. Currently available templates are:

    centos-x86
    centos-x86_64
    debian-x86
    debian-x86_64
    ubuntu-x86
    ubuntu-x86_64
    windows-2003-english (WIN only)
    windows-2008-english (WIN only)
    windows-2008-russian (WIN only)
    windows-2012-english (WIN only)
    windows-2012-russian (WIN only)
    windows-2016-english (WIN only)
    windows-2016-russian (WIN only).

    contype

    Type of contact data. Valid values: "pp" when registering a server to a private person and “org”, if the server is registered to a legal entity.

    email

    E-mail mail address for the hosting account being created.

    phone

    Phone number. Optional field.

    country

    Two-letter ISO code of the country, in which the person (organization) is registered.

    person_r

    This parameter is valid only when the “contype” parameter is set to “pp”. It defines the last name, first name and patronymic of the server administrator in Russian in compliance with the passport data. For non-residents, this field should include the person name spelled in the national characters (or in the English transliteration).
    Example 1: Пупкин Василий Николаевич
    Example 2: John Smith

    passport

    This parameter is valid only when the “contype” parameter is set to “pp”. It defines the series and number of the passport, as well as the name of the authority that issued the passport and the date of issue (in the specified order and delimited by whitespaces). Roman numerals must include Latin letters only. The date must be specified in the YY.MM.YYYY format. Do not use the No symbol before the passport number. USSR passports are not valid. In case another document is used (allowed for NON-RESIDENTS ONLY), the type of the document should be specified at the beginning of the string. Multi-line records are allowed.
    Example: 34 02 651241 выдан 48 о/м г.Москвы 26.12.1990

    org_r

    This parameter is valid only when the “contype” parameter is set to “org”. Use this parameter to define the full name of the organization registered as the domain administrator. The name should be defined in compliance with the articles of association. The names of non-resident organization should be defined in national language (or transliterated in English). is a non-resident, the name should be defined in the national language (or in the English transliteration). Multi-line records are allowed.
    Example 1: Общество с ограниченной ответственностью "Рога и Копыта" Example 2: Texas State University

    code

    This parameter is valid only when the “contype” parameter is set to “org”. Taxpayer identification code (INN) assigned to the organization, the administrator of the domain. For non- resident organization having no INN an empty string is allowed.
    Example: 7701107259

    ISP Manager license
    Parameter Description

    uplink_service_id

    ID of the parent service for which the ISP Manager is ordered. License ordering is allowed for VPS only (srv_vps).

    subtype

    License subtype: "lite", "pro". Optional parameter. Default value: "lite".

    installation_way

    Type of OS re-installation on VPS: “auto” – automatical OS re-installation; “manual” – license oredering only. Optional parameter. Default value: “manual”.

    ostmpl

    Pre-installed OS template.
    It is an optional parameter that can be instrumental in situations when the template of pre- installed OS is not supported by the ISP Manager. Below is the list of supported OS templates:

    centos-x86
    centos-x86_64
    debian-x86
    debian-x86_64
    ubuntu-x86
    ubuntu-x86_64.

    Additional IP address (srv_addip)
    Parameter Description

    uplink_service_id

    ID of the parent service, to which an additional IP address is ordered. Additional IP addresses are provided only for VPS (srv_vps), ISPmanager hosting (srv_hosting_ispmgr) and CPanel hosting (srv_hosting_cpanel).

    subtype

    Type of additional IP address. Valid values:
    "ipv4" - a random IP address.
    "other_subnet" - a class C IP address belonging to another subnet in relation to the main IP address of the VPS server.
    Optional parameter. Default value: "ipv4"

    Additional disk space (srv_disk_space)
    Parameter Description

    uplink_service_id

    ID of the parent service, to which an additional IP address is ordered. Additional IP addresses are provided only for VPS (srv_vps).

    disk_size

    Size for additional disk space for VPS in gigabytes.

    Advanced spam protection (srv_antispam)
    Parameter Description

    uplink_service_id

    ID of the parent service, for which the advanced spam protection is ordered. Adavanced spam protection can be ordered for a domain, ISPmanager hosting (srv_hosting_ispmgr), CPanel hosting (srv_hosting_cpanel) and Plesk hosting (srv_hosting_plesk).

    dname

    The name of the domain, for which the advanced spam protection is ordered. This parameter can be used as an alternative to the uplink_service_id parameter. Optional parameter.

    spam_action

    This parameter defines what should be done with e-mail considered to be spam. Valid values: "delete" (default) and "mark" (mark spam with the X-Spam-* headers ). Optional parameter.

    mx_list

    A comma-delimited list of MX servers used for transfer of filtered email.

    Dedicated server (srv_dedicated)
    Parameter Description

    server_name

    Server name for identification in the service lists.

    server_id

    Unique server id.

    ostmpl

    A template of pre-installed operating system. Currently available templates are: debian7-x86
    debian7-x86_64.

    disk_layout

    Preferred disk layout(in free form). Optional.

    client_comment

    Custom client setup (in free form). Optional.

    use_raid

    Use raid (if possible). Optional.

    contype

    Type of contact data. Valid values: "pp" when registering a server to a private person and “org”, if the server is registered to a legal entity.

    email

    E-mail mail address for the hosting account being created.

    phone

    Phone number. Optional field.

    country

    Two-letter ISO code of the country, in which the person (organization) is registered.

    person_r

    This parameter is valid only when the “contype” parameter is set to “pp”. It defines the last name, first name and patronymic of the server administrator in Russian in compliance with the passport data. For non-residents, this field should include the person name spelled in the national characters (or in the English transliteration).
    Example 1: Пупкин Василий Николаевич
    Example 2: John Smith

    passport

    This parameter is valid only when the “contype” parameter is set to “pp”. It defines the series and number of the passport, as well as the name of the authority that issued the passport and the date of issue (in the specified order and delimited by whitespaces). Roman numerals must include Latin letters only. The date must be specified in the YY.MM.YYYY format. Do not use the No symbol before the passport number. USSR passports are not valid. In case another document is used (allowed for NON-RESIDENTS ONLY), the type of the document should be specified at the beginning of the string. Multi-line records are allowed.
    Example: 34 02 651241 выдан 48 о/м г.Москвы 26.12.1990

    org_r

    This parameter is valid only when the “contype” parameter is set to “org”. Use this parameter to define the full name of the organization registered as the domain administrator. The name should be defined in compliance with the articles of association. The names of non-resident organization should be defined in national language (or transliterated in English). is a non-resident, the name should be defined in the national language (or in the English transliteration). Multi-line records are allowed.
    Example 1: Общество с ограниченной ответственностью "Рога и Копыта" Example 2: Texas State University

    code

    This parameter is valid only when the “contype” parameter is set to “org”. Taxpayer identification code (INN) assigned to the organization, the administrator of the domain. For non- resident organization having no INN an empty string is allowed.
    Example: 7701107259

    KVM access (srv_kvm)
    Parameter Description

    uplink_service_id

    ID of the parent service, to which an kvm access is ordered. KVM access are provided only for dedicated servers (srv_dedicated).

    Jelastic cloud hosting (srv_jelastic)
    Parameter Description

    email

    Email for Jelastic.

    Automatic SEO-promotion (srv_seowizard)
    Parameter Description

    email

    Email for the service.

    seo_name

    Name for service.

    Mail.Ru for business (srv_mail_ru)
    Parameter Description

    dname

    Domain for Mail.Ru for business.

    Example of a request for Mail.Ru for business:
    Example of a successful response for Mail.Ru for business:
    {
       "answer" : {
          "bill_id" : "123123123",
          "descr" : "service srv_mail_ru is ordered for domain test.ru",
          "pay_notes" : "No charge required",
          "payment" : "0.00",
          "regruadd_url" : "https://o2.mail.ru/login?response_type=code&client_id=reg.ru&redirect_uri=https%3A%2F%2Fwww.reg.ru%2Forder%2Fmailru%2Fmail_ru_login&scope=mail.biz&state=4d78b263aade9735f869399df23c5844&no_biz=1",
          "service_id" : "1234567",
          "uplink_service_id" : "12345678"
       },
       "charset" : "utf-8",
       "messagestore" : null,
       "result" : "success"
    }
    
    Example of a successful response for Mail.Ru for business, if the service is already created:
    {
       "answer" : {
          "descr" : "service srv_mail_ru is already created for domain makkaveii.ru, repeat authorization",
          "regruadd_url" : "https://o2.mail.ru/login?response_type=code&client_id=reg.ru&redirect_uri=https%3A%2F%2Fwww.reg.ru%2Forder%2Fmailru%2Fmail_ru_login&scope=mail.biz&state=1234567&no_biz=1",
          "service_id" : "1234567"
       },
       "charset" : "utf-8",
       "messagestore" : null,
       "result" : "success"
    }
    
    Response fields:
    Field Description

    descr

    General description of the order.

    bill_id

    Invoice ID.

    payment

    Invoice price.

    pay_notes

    Information about payment.

    service_id

    A numeric service identifier.

    regruadd_url

    A special hyperlink for the email account activation.

    uplink_service_id

    A numeric parent service identifier.

    Sitebuilder Reg.ru (srv_websitebuilder)
    Parameter Description

    dname

    Domain for sitebuilder Reg.ru.

    subtype

    The rate plan. Currently available rate plans are: "annual", "infinite", "start".

    email

    Email for the service.

    Example of a request for sitebuilder Reg.ru:
    Example of a successful response for sitebuilder Reg.ru:
    {
       "answer" : {
          "bill_id" : "37601633",
          "descr" : "service srv_websitebuilder is ordered for domain test.ru",
          "pay_notes" : "No charge required",
          "payment" : "0.00",
          "service_id" : "27249497",
          "uplink_service_id" : "0"
       },
       "charset" : "utf-8",
       "messagestore" : null,
       "result" : "success"
    }
    
    Response fields:
    Field Description

    descr

    General description of the order.

    bill_id

    Invoice ID.

    payment

    Invoice price.

    pay_notes

    Information about payment.

    service_id

    A numeric service identifier.

    uplink_service_id

    A numeric parent service identifier.

    Example of a request:
    Example of a successful response:
    {
      'result' => 'success';
      'answer' => {
          'descr' => 'service srv_hosting_ispmgr is ordered for domain qqq.ru',
          'payment' => '100',
          'pay_notes' => 'Amount successfully charged',
          'bill_id' => '1234',
          'service_id' => '987654'
       }
    }
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    NEEDS_CONFIRMATION
    Service already ordered and needs confirmation.
    WAITING
    Service already ordered but not processed.
    TRIAL_ACCOUNT_CREATION_ERROR
    Cannot create trial Jelastic account for $email
    CANNOT_GET_USER_ID
    Cannot get Jelastic UID for $email
    ACCOUNT_IS_NOT_TRIAL
    User account $uid is not trial. Account group: $group

    And also see the list of common error codes

    7.5. Function: service/check_create

    Accessibility:
    Everyone
    Support of service list:
    No
    Designation:

    Use the function to validate domain_name, subtype and period before ordering new service.

    Request fields:
    Common
    Parameter Description

    domain_name

    Name of the domain, for which the service is ordered.

    Additional
    Parameter Description

    servtype

    The type of the ordered service. Default value: srv_hosting_ispmgr

    subtype

    The rate plan. Default value: Host-0-1019

    period

    The period for which the service is ordered. Default value: 1

    Example of a request:
    Example of a successful response:
    {
        'result' => 'success';
        'answer' => {
            'descr' => 'everything is ok for creating',
            'param' =>  {
                'dname'     => 'qqq.ru',
                'servtype'  => 'srv_hosting_plesk',
                'subtype'   => 'Host-1-1019',
                'period'    => '1'
            }
         }
    }
    
    Possible errors:
    Error_code error_text
    ALREADY_EXISTS_ON_SERVER
    Domain already exist on hosting server
    ALREADY_EXISTS_ON_NSS
    Domain already exist on hosting ns servers
    INVALID_PERIOD
    Invalid period
    INVALID_PLAN
    Invalid service plan
    PARAMETER_MISSING
    $param required
    DOMAIN_BAD_NAME
    Domain $domain_name is reserved or disalowed by the registry, or is a premium domain offered by special price
    FIELD_VALUE_TOO_SHORT
    Value of field is too short

    And also see the list of common error codes

    7.6. Function: service/delete

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    Removes the service

    Request fields:

    Common service identification parameters as well as

    Parameter Available values Description

    servtype

    "srv_google_apps"
    "srv_webfwd"
    "srv_parking"
    "srv_jelastic"
    "srv_parallels_wpb"
    "srv_seowizard"
    "srv_websitebuilder"
    "srv_mail_ru"

    Service type, which is to be removed

    Response fields:

    no

    Example of a request:
    Example of a successful response:
    {
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    HAS_ACTIVE_PROJECTS

    And also see the list of common error codes

    7.7. Function: service/get_info

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Use this function to obtain information about all services.

    Request fields:

    Common service identification parameters, Service list identification parameters and also

    Parameter Available values Description

    show_folders

    0 and 1

    With this feature enabled the response will include the list of folders associated with the service. Valid values: 0 (default) and 1.

    Response fields:
    Field Description

    services

    A list service parameter hashes

    subtype

    Service subtype (for hosting: domain identifier)

    state

    Service status. Valid values:

  • «N» – the service is inactive (the domain is not registered/not delegated);
  • «A» – the service is active;
  • «S» – the service is suspended;
  • «D» – the service is deleted;
  • «O» – the domain was transferred to another registrar.
  • creation_date

    Service activation date.

    expiration_date

    Service expiration date.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "services" : [
             {
                "creation_date" : "2001-01-01",
                "expiration_date" : "2101-01-01",
                "result" : "success",
                "service_id" : "12345",
                "servtype" : "domain",
                "state" : "A",
                "subtype" : "test"
             },
             {
                "creation_date" : "2001-01-01",
                "expiration_date" : "2101-01-01",
                "result" : "success",
                "service_id" : "111111",
                "servtype" : "domain",
                "state" : "A",
                "subtype" : "test"
             }
          ]
       },
       "result" : "success"
    }
    
    

    If the request is performed with a partner account, an additional field is displayed user2_login. The value of the field is the login of the account to which the service is transferred to partial control.

    Example of a successful response:
    {
       "answer" : {
          "services" : [
             {
                "creation_date" : "2001-01-01",
                "expiration_date" : "2101-01-01",
                "result" : "success",
                "service_id" : "12345",
                "servtype" : "domain",
                "state" : "A",
                "subtype" : "test",
                "user2_login" : "test@test.com"
             },
             {
                "creation_date" : "2001-01-01",
                "expiration_date" : "2101-01-01",
                "result" : "success",
                "service_id" : "111111",
                "servtype" : "domain",
                "state" : "A",
                "subtype" : "test",
                "user2_login" : ""
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.8. Function: service/get_list

    Accessibility:
    Clients
    Designation:

    Use this function to obtain a list of active services.

    Request fields:
    Parameter Description

    servtype

    Type of service:
    domain — Domain,
    srv_webfwd — web forwarding,
    srv_parking — domain parking
    srv_dns_both — DNS support,
    srv_hosting_ispmgr — ISPManager hosting,
    srv_hosting_cpanel — CPanel hosting,
    srv_hosting_plesk — Plesk hosting,
    srv_antispam — Extended spam protection,
    srv_vps — VPS server,
    srv_addip — Additional IP address,
    srv_license_isp — ISPManager license,
    srv_certificate — Domain certificate,
    srv_voucher — Domain voucher.
    If nothing is defined, information about all types of services will be returned.

    Response fields:
    Field Description

    services

    A list of service parameter hashes.

    service_id

    Numeric service identifier.

    dname

    Domain name.

    subtype

    Service subtype (for hosting: rate plan identifier).

    state

    Service status. Valid values:

  • «N» – the service is inactive (the domain is not registered/not delegated);
  • «A» – the service is active;
  • «S» – the service is suspended.
  • creation_date

    Service activation date.

    expiration_date

    Service expiration date.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "services" : [
             {
                "creation_date" : "2009-04-18",
                "dname" : "test.ru",
                "expiration_date" : "2011-04-18",
                "service_id" : "111",
                "servtype" : "domain",
                "state" : "A",
                "subtype" : "test",
                "uplink_service_id" : "0"
             },
             {
                "creation_date" : "2009-04-29",
                "dname" : "foo-test.ru",
                "expiration_date" : "2011-04-29",
                "service_id" : "222",
                "servtype" : "srv_hosting_ispmgr",
                "state" : "A",
                "subtype" : "test",
                "uplink_service_id" : "0"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.9. Function: service/get_folders

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    Use this function to get the list of folders the service is associated with.

    Request fields:

    Common service identification parameters

    Response fields:
    Field Description

    folders

    A list of folders (it can be empty).

    folder_id

    Folder identifier.

    folder_name

    Folder name.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "folders" : [
             {
                "folder_id" : "12345",
                "folder_name" : "test_folder"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.10. Function: service/get_details

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Use this function to get detailed information about the service, including contact data for domains.

    Request fields:

    Common service identification parameters., Service list identification parameters, а также

    Parameter Available values Description

    separate_groups

    0 and 1

    If this parameter is set to “1”, the input data will be divided into groups, separate for each service/domain zone. Default value: 0.

    show_contacts_only

    0 and 1

    If this parameter is set to “1”, the response will include only contact data. This can be instrumental when working with domains, but have no sense for the rest of services.

    Response fields:
    Field Description

    services

    A list of domains with the fields dname, servtype, service_id, details and contacts OR the error_code field with the service identification error code.

    details

    A list of all additional data pertaining to the service. If the function is called with the parameter separate_groups, the data will be sorted by groups.

    contacts

    A list of contacts of a specific domain. For detailed description of contacts for all domain zones, refer to the section describing the domain/create function. This field is returned only when the function is called with the parameter show_contacts_only enabled.

    login

    The login of the hosting account.

    passwd

    The password of the hosting account.

    server_ip

    IP address of the sever from which the account is managed.

    nss

    The list of name servers.

    fwds

    A list of all web forwarding rules of a domain. Includes the fields: fwdfrom, fwdto, webfwd_type, title (window title, if webfwd_type = frames).

    title

    A page element located at top of page (optional).

    content

    HTML-code of the page.

    counter_html_code

    HTML-code of counters (optional).

    template_name

    Template identifier. Available identifiers:

    private_property
    "Private property"
    under_construction
    "Site is under construction"
    for_sale
    "Domain is for sale"
    for_rent
    "Domain is for rent"
    for_you_gift
    "A gift for you"
    happy_new_year
    "Happy new Year!"
    happy_birthday1
    "Happy Birthday!" (1st variant)
    happy_birthday2
    "Happy Birthday!" (2nd variant)
    love_happiness
    "Love and happiness!"
    empty
    Empty page
    raw_html
    Your own HTML code (only for paid parking, without standard advertising block)

    html_title

    HTML meta tag «Title».

    html_description

    HTML meta tag «Description».

    html_keywords

    HTML meta tag «Keywords».

    opt_user_contacts

    Show block with domain owner contacts.

    opt_feedback_link

    Show information block with link "Contact domain owner" (link to domain Whois).

    Possible values:

  • «1» — the function is ON
  • «0» — the function is OFF

  • opt_domain_shop_link

    Show link to Domain Shop lot if possible.

    Possible values:

  • «1» — the function is ON
  • «0» — the function is OFF

  • opt_whois_link

    Show link to domain Whois.

    Possible values:

  • «1» — the function is ON
  • «0» — the function is OFF

  • opt_se_link

    Show links from search engines to domain.

    Possible values:

  • «1» — the function is ON
  • «0» — the function is OFF

  • opt_indexed_link

    Show links to pages of website indexed by search engines.

    Possible values:

  • «1» — the function is ON
  • «0» — the function is OFF

  • opt_blogs_link

    Show links to website from blogging engines.

    Possible values:

  • «1» — the function is ON
  • «0» — the function is OFF

  • Example of a request:

    A request with several domains in the list

    A request that includes the separate_groups parameter

    A request that includes the show_contacts_only parameter

    Examples of successful responses:

    A response to the request with several domains

    {
        'answer' => {
            'services' => [
                {
                    'dname'      => 'vschizh.ru',
                    'servtype'   => 'domain',
                    'service_id' => '12345'
                    'details'    => {
                        'country'             => 'RU',
                        'e_mail'              => 'test@test.ru',
                        'person_r'            => 'Rjurik Svjatoslav Vladimirovich',
                        'id_state'            => 'VERIFIED',
                        'phone'               => '+7 495 1234567',
                        'birth_date'          => '01.01.1101',
                        'descr'               => 'test contacts',
                        'person'              => 'Svyatoslav V Ryurik',
                        'p_addr'              => '12345, g. Vshhizh, ul. Knjazheska, d.1, Rjuriku Svjatoslavu Vladimirovichu, knjazju Vshhizhskomu',
                        'passport'            => '22 44 668800, vydan po mestu pravlenija 01.09.1164'
                        'private_person_flag' => '1',
                    },
                    'result'     => 'success'
                },
                {
                    'dname'      => 'vschizh.org',
                    'servtype'   => 'domain',
                    'service_id' => '12346'
                    'details'    => {
                        'o_email'        => 'test@test.ru',
                        'o_addr'         => 'Vschizh Goverment, house 1, Knyazheska str',
                        'o_phone'        => '+7.4951234567',
                        'o_state'        => 'VSZ',
                        'o_postcode'     => '12345',
                        'o_city'         => 'Vschizh',
                        'o_first_name'   => 'Svyatoslav',
                        'o_last_name'    => 'Ryurik',
                        'o_company'      => 'Vschizh City',
                        'o_country_code' => 'RU',
                        'o_fax'          => '+7.4951234567'
                    },
                    'result'     => 'success'
                }
            ]
        },
        'result' => 'success'
    }
    

    A response to the request with the separate_groups parameter

    {
        'answer' => {
            'services' => [
                {
                    'dname'      => 'vschizh.ru',
                    'service_id' => '12345',
                    'servtype'   => 'domain',
                    'details'    => {
                        'ru_id' => {
                            'id_state'   => 'VERIFIED'
                        },
                        'ru_dd' => {
                            'descr'      => 'test user domain'
                        },
                        'ru_pp' => {
                            'country'    => 'RU',
                            'e_mail'     => 'test@test.ru',
                            'person_r'   => 'Rjurik Svjatoslav Vladimirovich',
                            'phone'      => '+7 495 1234567',
                            'birth_date' => '01.01.1101',
                            'person'     => 'Svyatoslav V Ryurik',
                            'p_addr'     => '12345, g. Vshhizh, ul. Knjazheska, d.1, Rjuriku Svjatoslavu Vladimirovichu, knjazju Vshhizhskomu',
                            'passport'   => '22 44 668800, vydan po mestu pravlenija 01.09.1164'
                        }
                    },
                    'result'     => 'success'
                }
            ]
        },
        'result' => 'success'
    

    A response to the request with the show_contacts_only parameter

    {
        'answer' => {
            'services' => [
                {
                    'contacts' => {
                        'country'    => 'RU',
                        'e_mail'     => 'test@test.ru',
                        'person_r'   => 'Rjurik Svjatoslav Vladimirovich',
                        'phone'      => '+7 495 1234567',
                        'birth_date' => '01.01.1101',
                        'descr'      => 'test user domain'
                        'person'     => 'Svyatoslav V Ryurik',
                        'p_addr'     => '12345, g. Vshhizh, ul. Knjazheska, d.1, Rjuriku Svjatoslavu Vladimirovichu, knjazju Vshhizhskomu',
                        'passport'   => '22 44 668800, vydan po mestu pravlenija 01.09.1164'
                    },
                    'dname'      => 'vschizh.ru',
                    'service_id' => '12345',
                    'servtype'   => 'domain',
                    'result'     => 'success'
                }
            ]
        },
        'result' => 'success'
    }
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.11. Function: service/get_dedicated_server_list

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    Get the dedicated server list.

    Request fields:

    Common service identification parameters

    Response fields:
    Field Description

    server_id

    Unique server id

    cpu_content

    Processor model

    cpu_count

    Processor count

    cpu_core

    Core count

    ram_content

    RAM type

    ram_count

    RAM count

    ram_size

    RAM size

    hdd_content

    HDD interface type

    hdd_count

    HDD count

    hdd_size

    HDD disk size

    month_traf

    Traffic, GB per month

    price_retail

    Rent per month

    Example of a request:
    Example of a successful response:
    {
      answer => {
          server_list => [
              {
                  server_id => "171",
                  cpu_content => "Intel Pentium 4 2.8Ghz",
                  cpu_count => "1",
                  cpu_core => "2",
                  hdd_content => "IDE",
                  hdd_count => "2",
                  hdd_size => "120Gb",
                  ram_content => "RAM"
                  ram_count => "2",
                  ram_size => "512Mb",
                  month_traf => "1000",
                  price_retail => "3080",
              }
          ]
      },
      result => "success"
    }
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.12. Function: service/update

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    Service configuration.

    Request fields:
    Common
    Parameter Description

    dname

    Domain name of the service being configured.

    servtype

    The type of the ordered service:
    srv_webfwd —"Web forwarding",
    srv_parking —"Web parking",
    srv_ssl_certificate—"SSL certificate",
    srv_vps —"VPS",
    srv_hosting_cpanel —"Cpanel hosting",
    srv_antispam —"Advanced spam protection",
    srv_dedicated —"Dedicated server"
    srv_rs_joomla -"Ready-made solutions based on Joomla",
    srv_rs_wordpress -"Ready-made solutions based on Wordpress".

    Web forwarding (srv_webfwd)
    Parameter Description

    fwd_action

    Action. Valid values:

  • addfwd ( add a forwarding rule )
  • rmfwd ( delete a forwarding rule )
  • rmall ( delete all forwarding rules )
  • edit_allow_se_indexing ( indexed by search engines )
  • add_favicon ( add the favicon for forwarding (valid only when address masking is used) )
  • rm_favicon ( remove the favicon for forwarding )
  • DEPRECATED. Use the subtask parameter.

    subtask

    Action. Valid values:

  • addfwd ( add a forwarding rule )
  • rmfwd ( delete a forwarding rule )
  • rmall ( delete all forwarding rules )
  • edit_allow_se_indexing ( indexed by search engines )
  • add_favicon ( add the favicon for forwarding (valid only when address masking is used) )
  • rm_favicon ( remove the favicon for forwarding )
  • fwdfrom

    "Forwarding from" - define a relative address (without the domain name), from which visitors should be forwarded ("/", if not defined).

    fwdto

    "Redirect to", specify the URL to which you want to redirect the visitors.

    allow_se_indexing

    Search engines indexing. At least one web-forwaring should be added to enable this feature. Possible values:

  • «1» — the feature is ON
  • «0» — the feature is OFF
  • The default value is "0".

    webfwd_type

    Forwarding type. Valid values:

  • redirect ( request redirect using 301 HTTP header response )
  • frames ( open distination URL in a frame )
  • The default value is "redirect".

    title

    Page title. Valid only when address masking is used. The defined value will be displayed in the title bar of browser windows.

    favicon

    Favicon for web-forwaring with masking in frame. Allowed image format is PNG encoded in base64. Maximum original image size is 16x16 pixels. Maximum original file size is 1536 bytes. This parameter is used together with the parameter subtask = add_favicon

    Parking (srv_parking)
    Parameter Description

    title

    A page element located at top of page (optional).

    content

    HTML-code of the page.

    counter_html_code

    HTML-code of counters (optional).

    template_name

    Template identifier. Available identifiers:

    private_property
    "Private property"
    under_construction
    "Site is under construction"
    for_sale
    "Domain is for sale"
    for_rent
    "Domain is for rent"
    for_you_gift
    "A gift for you"
    happy_new_year
    "Happy new Year!"
    happy_birthday1
    "Happy Birthday!" (1st variant)
    happy_birthday2
    "Happy Birthday!" (2nd variant)
    love_happiness
    "Love and happiness!"
    empty
    Empty page
    raw_html
    Your own HTML code (only for paid parking, without standard advertising block)

    html_title

    HTML meta tag «Title».

    html_description

    HTML meta tag «Description».

    html_keywords

    HTML meta tag «Keywords».

    opt_user_contacts

    Show block with domain owner contacts.

    opt_feedback_link

    Show information block with link "Contact domain owner" (link to domain Whois).

    Possible values:

  • «1» — the function is ON
  • «0» — the function is OFF

  • opt_domain_shop_link

    Show link to Domain Shop lot if possible.

    Possible values:

  • «1» — the function is ON
  • «0» — the function is OFF

  • opt_whois_link

    Show link to domain Whois.

    Possible values:

  • «1» — the function is ON
  • «0» — the function is OFF

  • opt_se_link

    Show links from search engines to domain.

    Possible values:

  • «1» — the function is ON
  • «0» — the function is OFF

  • opt_indexed_link

    Show links to pages of website indexed by search engines.

    Possible values:

  • «1» — the function is ON
  • «0» — the function is OFF

  • opt_blogs_link

    Show links to website from blogging engines.

    Possible values:

  • «1» — the function is ON
  • «0» — the function is OFF

  • subtype

    Optional. Set free for free parking

    SSL certificate (srv_ssl_certificate)
    Parameter Description

    obligatory:
    org_org_name, org_address, org_city, org_state, org_postal_code, org_country, org_phone

    optional:
    org_first_name, org_last_name, org_fax

    Name, address, first name, last name city, state (province), postal code, country, phone, fax number of the organization.

    Required for all Thawte, Comodo, VeriSign SSL certificates. Required for GeoTrust True BusinessID, True BusinessID Wildcard, True BusinessID with EV.

    obligatory:
    admin_first_name, admin_last_name, admin_title, admin_address, admin_city, admin_state, admin_postal_code, admin_country, admin_phone, admin_email,

    optional:
    admin_fax, admin_org_name

    First name, last name, address, city, state, postal_code, country, phone number, e-mail address, fax and organization of the administrator.

    Required for all Thawte, GeoTrust, Trustwave and VeriSign SSL certificates and for Comodo EV SSL certificate.

    obligatory:
    billing_first_name, billing_last_name, billing_title, billing_address, billing_city, billing_state, billing_postal_code, billing_country, billing_phone, billing_email,

    optional:
    billing_fax, billing_org_name

    First name, last name, address, city, state, postal_code, country, phone number, e-mail address, fax and organization of the billing manager.

    Required for all Thawte, GeoTrust and VeriSign SSL certificates and for Comodo EV SSL certificate.

    obligatory:
    tech_first_name, tech_last_name, tech_title, tech_address, tech_city, tech_state, tech_postal_code, tech_country, tech_phone, tech_email,

    optional:
    tech_fax, tech_org_name

    First name, last name, address, city, state, postal_code, country, phone number, e-mail address, fax and organization of the technical specialist.

    Required for all Thawte, GeoTrust and VeriSign SSL certificates and for Comodo EV SSL certificate.

    obligatory:
    signer_first_name, signer_last_name, signer_title, signer_address, signer_city, signer_state, signer_postal_code, signer_country, signer_phone, signer_email,

    optional:
    signer_fax, signer_org_name

    First name, last name, address, city, state, postal_code, country, phone number, e-mail address, fax and organization of the SSL certificate signer manager.

    Required for Comodo EV SSL certificate.

    approver_email

    The e-mail address for certificate confirmation.

    server_type

    Software. Possible values:
    For Comodo SSL certificates:
    apachessl, citrix, domino, ensim, hsphere, iis4, iis6, iis7, iplanet, javawebserver, netscape, ibmhttp, novell, oracle, other, plesk, redhat, sap, tomcat, webstar, whmcpanel

    For Thawte, GeoTrust and VeriSign SSL certificates:
    apache2 apacheopenssl apacheraven apachessl apachessleay c2net cobaltseries cobaltraq3 cobaltraq2 cpanel domino dominogo4626 dominogo4625 ensim hsphere iis iis4 iis5 iplanet ipswitch netscape ibmhttp other plesk tomcat weblogic website webstar webstar4 zeusv3

    TrustWave SSL certificates does not require this parameter.

    csr_string

    Encoded CSR including starting and ending markers.

    subtype

    Type of the certificate. Possible values:

    Thawte:
    ssl123, sgcsuper_certs, sslwebserver, sslwebserver_wildcard, sslwebserver_ev

    Symantec:
    securesite, securesite_pro, securesite_ev, securesite_pro_ev

    GeoTrust:
    quickssl, quickssl_premium, truebizid, truebizid_wildcard, truebizid_ev

    TrustWave:
    trustwave_dv, trustwave_ev, trustwave_premiumssl, trustwave_premiumssl_wildcard

    Comodo:
    comodo_ev, comodo_instantssl, comodo_premiumssl, comodo_premiumssl_wildcard, comodo_ssl, comodo_wildcard

    reissue

    Any non-zero value initiates the reissue of the certificate with the new fields csr_string, server_type, approver_email.
    The zero value or the absence of this flag result in the update of fields without certificate reissue.
    This mode is typically used to prepare fields for certificate renewal.

    VPS (srv_vps)
    Parameter Description

    subtask

    Action. Valid values:
    reboot(boot/reboot VPS),
    stop(stop VPS),
    change_password(change root password),
    change_hostname(change VPS hostname),
    reinstall(reinstall VPS VPS).

    new_ostmpl

    OS template, used during VPS reinstallation (the parameter subtask = reinstall). Valid template:

    centos-x86
    centos-x86_64
    debian-x86
    debian-x86_64
    ubuntu-x86
    ubuntu-x86_64
    windows-2003-english (WIN only)
    windows-2008-english (WIN only)
    windows-2008-russian (WIN only)
    windows-2012-english (WIN only)
    windows-2012-russian (WIN only)
    windows-2016-english (WIN only)
    windows-2016-russian (WIN only)

    new_hostname

    VPS domain name. This parameter is used together with the parameter subtask = change_hostname.

    reinstall_ispmgr

    This flag determines whether the reinstallation of the ISP Manager is required. This parameter is used during VPS reinstallations (the parameter subtask = reinstall).

    Cpanel hosting (srv_hosting_cpanel)
    Parameter Description

    subtask

    Action. Valid values:
    change_password(change the password to hosting).

    Advanced spam protection (srv_antispam)
    Parameter Description

    subtask

    Action. Valid values:

  • change_action(change the settings of the parameter “action” that defines the actions to be undertaken with email considered to be spam),
  • change_mx_list(change the list of MX servers used for transfer of filtered mail).
  • spam_action

    Actions with spam. Defines what should be done with email considered to be spam. Two variants are available:

  • "delete" (delete detected spam e-mail),
  • "mark" (mark detected spam e-mail with the X-Spam-* headers).
  • Optional parameter. Default value: "delete". Valid when subtask = change_action.

    mx_list

    A comma-delimited list of MX servers used for transfer of filtered email.
    Valid when subtask = change_mx_list.

    Dedicated server (srv_dedicated)
    Parameter Description

    subtask

    Action. Valid values:

  • change_hostname(change reverse dns record (PTR) for one of serverip).
  • revert_dns_ip

    One of server ip.

    new_hostname

    New domain name for server ip.

    Ready-made solutions based on Wordpress, Joomla (srv_rs_joomla, srv_rs_wordpress)
    Parameter Description

    subtask

    Action, valid values:

  • reinstall( reinstall ready-made solution ).
  • Note: For the SSL certificate service.

    Response fields:
    Field Description

    descr

    General description of the order.

    Example of a request:
    Example of a successful response:
    {
        'result' => 'success';
        'answer' => {
            'descr' => 'service srv_webfwd is updated for domain qqq.ru'
         }
    }
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.13. Function: service/renew

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Domain or service renewal.

    Request fields:
    Parameter Description

    period

    Renewal period.

    point_of_sale
    pay_type
    ok_if_no_money

    allow_create_bills

    The flag indicating that if the amount of funds in the account is insufficient, the request will be processed without error and the payment statement will be issued. OBSOLETE. DO NOT USE!

    See also common service identification parameters and service list identification parameters.

    Response fields:
    Field Description

    period

    Renewal period.

    bill_id

    Invoice ID.

    payment

    Price.

    currency

    Currency of the price.

    status

    Order status. Valid values: renew_success (successful service/domain renewal) and only_bill_created (not enough funds in the account).

    Example of a request:

    Identification by service_id

    Identification by servtype + domain_name

    Example of successful responses:

    Response to a "PLAIN" request

    {
        'answer' => {
            'period'   => '2',
            'payment'  => '100',
            'currency' => 'RUR',
            'status'   => 'renew_success',
            'dname'    => 'test12345.ru',
            'bill_id'  => '123456',
            'servtype' => 'domain'
        },
        'result' => 'success',
    }
    

    Response to a JSON request with two domains in the list

    {
        'answer' => {
            'currency' => 'RUR',
            'payment'  => '200',
            'period'   => '2',
            'services' => [
                {
                    'dname'      => 'test12345.ru',
                    'service_id' => '12345',
                    'servtype'   => 'domain',
                    'result'     => 'success'
                },
                {
                    'dname'      => 'test12346.ru',
                    'service_id' => '12346',
                    'servtype'   => 'domain',
                    'result'     => 'success'
                }
            ],
            'bill_id'  => '123456',
            'status'   => 'renew_success',
        },
        'result' => 'success',
    }
    

    Response to a request with the allow_create_bills flag (the situation, when there are not enough funds in the account and only a payment statement is issued):

    {
        'answer' => {
            'period'   => '1',
            'payment'  => '100',
            'currency' => 'RUR',
            'status'   => 'only_bill_created',
            'dname'    => 'test12345.ru',
            'bill_id'  => '123123',
            'servtype' => 'domain'
        },
        'result' => 'success',
    }
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    INCORRECT_STATE
    Operation allowed only for suspended or active services
    PROLONG_ERROR
    Prolong error: $error_detail

    And also see the list of common error codes

    7.14. Function: service/get_bills

    Accessibility:
    Partners
    Support of service list:
    Yes
    Designation:

    Use this function to get a list of invoices associated with the defined services.

    Request fields:

    Common domain and service identification parameters.

    Response fields:
    Field Description

    services

    A list of requested services.

    bills

    A list of IDs of invoices associated with this service.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "services" : [
             {
                "bills" : [
                   "123456",
                   "234567"
                ],
                "dname" : "qqq.ru",
                "service_id" : "12345",
                "servtype" : "domain"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.15. Function: service/set_autorenew_flag

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    Enables or disables automatic service renewal.

    Request fields:
    Parameter Description

    flag_value

    The flag that enables/disables automatic service renewal. Valid values: 0 and 1. Any value other than 0 is considered to be 1.

    See also common domain and service identification parameters .

    Response fields:

    Common fields included into responses about successful changes and change failures.

    Example of a request:
    Example of a successful response:
    {
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.16. Function: service/suspend

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    Use this function to suspend services (for domains – suspend delegation).

    Request fields:

    Common service identification parameters

    Response fields:

    no

    Example of a request:
    Example of a successful response:
    {
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    SERVICE_NOT_ACTIVE
    Service not active

    And also see the list of common error codes

    7.17. Function: service/resume

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    Use this function to resume services (for domains – resume domain delegation).

    Request fields:

    Common service identification parameters

    Response fields:

    no

    Example of a request:
    Example of a successful response:
    {
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    SERVICE_NOT_SUSPENDED
    Service not suspended
    SERVICE_EXPIRED
    Service expired

    And also see the list of common error codes

    7.18. Function: service/get_depreciated_period

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    Use this function to calculate the number of periods till the service expiration date.

    Request fields:

    Common domain and service identification parameters

    Response fields:
    Field Description

    depreciated_period

    The number of periods left till the service expiration date.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "depreciated_period" : "1"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.19. Function: service/upgrade

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    This function upgrades service subtypes (rate plans). It can be used for changes of rate plans for virtual hosting ("srv_hosting_ispmgr"), REG.RU website builder ("srv_websitebuilder"), VPS servers("srv_vps") and Additional Disk Space for VPS ("srv_disk_space").

    Request fields:
    Parameter Description

    subtype

    New service subtype (rate). For the hosting service ("srv_hosting_ispmgr") valid values are: "Host-0-1019", "Host-1-1019", "Host-3-1019", "Host-A-1019", "Host-B-1019", "Host-Lite-1019". For the VPS service ("srv_vps") valid values are: BX-VPS-1
    BX-VPS-2
    BX-VPS-3
    RH-1-1216
    RH-2-1216
    RH-3-1216
    SSD-VPS-1-1018
    SSD-VPS-2-1018
    SSD-VPS-3-1018
    SSD-VPS-4-1018
    SSD-VPS-5-1018
    SSD-XEN-1-1018
    SSD-XEN-2-1018
    SSD-XEN-3-1018
    SSD-XEN-4-1018
    SSD-XEN-5-1018
    VPS-1-1018
    VPS-2-1018
    VPS-3-1018
    VPS-4-1018
    VPS-5-1018
    WIN-1
    WIN-2
    WIN-3
    WIN-4
    WIN-5
    WIN-6
    WIN-7
    XEN-1-1018
    XEN-2-1018
    XEN-3-1018
    XEN-4-1018
    XEN-5-1018
    XEN-6-1018
    XEN-7-1018
    XEN-8-1018. For Additional disk space ("srv_disk_space") keep subtype empty. For ParallelsWPB ("srv_parallels_wpb") valid values are: "WPB-Lite", "WPB-Pro", "WPB-Standart". For REG.RU website builder ("srv_websitebuilder") valid values are: "start", "standart", "premium".

    servtype

    Type of service: srv_hosting_cpanel
    srv_hosting_ispmgr
    srv_hosting_plesk
    srv_vps
    srv_disk_space
    srv_google_apps

    period

    Number of periods, for which the new service is ordered.

    disk_size

    As well as common domain and service identification parameters

    Response fields:
    Field Description

    withdrawed_amount

    Debited amount.

    returned_amount

    Including amount credited to the personal account.

    new_service_id

    Identifier of the new service with the new subtype (rate plan).

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "bill_id" : "123",
          "new_service_id" : "-1",
          "returned_amount" : "100",
          "withdrawed_amount" : "100"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    SERVICE_UPGRADE_NOT_ALLOWED
    Service upgrade is not allowed
    DISK_SIZE_TOO_LARGE
    Additional disk space is too large
    SERVICE_BLOCKED
    Service blocked

    And also see the list of common error codes

    7.20. Function: service/partcontrol_grant

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    You can use this function to grant a part of service management rights to other users.

    Request fields:
    Parameter Description

    newlogin

    Login of the user to whom you grant the rights.

    As well as common domain and service identification parameters

    Response fields:
    Field Description

    newlogin

    Login of the user to whom the rights were granted.

    service_id

    Login of the user to whom the rights were granted.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "newlogin" : "test_user",
          "service_id" : "1"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.21. Function: service/partcontrol_revoke

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    Use this function to stop granting service management rights to other.

    Request fields:

    See the list of common domain and service identification parameters .

    Response fields:
    Field Description

    service_id

    Domain or service identifier.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "service_id" : "1"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.22. Function: service/resend_mail

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    resend mail to user.

    Request fields:

    Common service identification parameters.. For the services of the SSL certificate you should define mailtype.

    SSL certificate (srv_ssl_certificate)
    Parameter Description

    mailtype

    Email type:
    approver_email — approve ssl certificate order,
    certificate_email — certificate email.

    Response fields:
    Field Description

    service_id

    Domain or service identifier.

    dname

    Service domain name.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "dname" : "test.ru",
          "result" : "success",
          "service_id" : "111"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.23. Function: service/refill

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    You can use this function to refill balance of you service. Supported service types:

  • srv_jelastic
  • srv_seowizard (Minimum refill sum - $1).
  • Request fields:

    Common service identification parameters

    Response fields:
    Field Description

    bill_id

    The number of the invoice.

    pay_type

    Payment method.

    currency

    Currency, in which the returned prices are quoted.

    payment

    Order amount in roubles.

    pay_notes

    Notes pertaining to the payment method.

    service_id

    Numeric service identifier.

    Example of a request:

    Identification by service_id

    Example of a successful response:
    {
       "answer" : {
          "bill_id" : "1000000",
          "currency" : "RUR",
          "pay_notes" : "Amount successfully charged",
          "pay_type" : "prepay",
          "payment" : "36.88",
          "service_id" : "123456"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.24. Function: service/refund

    Accessibility:
    Partners
    Support of service list:
    No
    Designation:

    You can use this function to refund money from the external service's balance to the Reg.ru user account. Supported service types: srv_seowizard

    Request fields:

    Common service identification parameters

    Response fields:

    no

    Example of a request:

    Identification by service_id

    Example of a successful response:
    {
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.25. Function: service/get_balance

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    For external service's balance receiving. Supported service types: srv_seowizard

    Request fields:

    Common service identification parameters

    Response fields:

    no

    Example of a request:

    Identification by service_id

    Example of a successful response:
    {
       "answer" : {
          "balance" : "10",
          "currency" : "USD"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.26. Function: service/seowizard_manage_link

    Accessibility:
    Partners
    Support of service list:
    No
    Designation:

    Getting link for management panel of Automatic SEO-promotion service

    Request fields:

    Common service identification parameters

    Response fields:

    no

    Example of a request:

    Identification by service_id

    Example of a successful response:
    {
       "answer" : {
          "link" : "http://reg.ru/seowizard.html"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    7.27. Function: service/get_websitebuilder_link

    Accessibility:
    Partners
    Support of service list:
    No
    Designation:

    Getting link for publications sitebuilder Reg.ru

    Request fields:

    Common service identification parameters

    Response fields:

    no

    Example of a request:
    {
       "answer" : {
          "link" : "http://www.reg.ru/ru/?login_hash=123"
       },
       "result" : "success"
    }
    
    
    Possible errors:

    See the list of common error codes

    8. Domain management functions (the category «domain»)

    8.1. Function: domain/nop

    Accessibility:
    Everyone
    Support of service list:
    No
    Designation:

    For testing purposes. Also, with the help of this function you can check accessibility of a domain and get its ID. For this, pass username+password+dname.

    Request fields:

    Not used or common domain identification parameters

    Response fields:
    Field Description

    service_id

    Domain identifier, available only when the domain name is passed in the field domain_name/dname.

    Example of a request:

    API accessibility check

    Domain existence check and getting domain

    Example of a successful response:
    {
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    8.2. Function: domain/get_prices

    Accessibility:
    Everyone
    Support of service list:
    No
    Designation:

    Get domain registration/renewal prices in all zones available

    Request fields:
    Parameter Description

    You should undergo authentication to get the list of partners’ prices.

    show_renew_data

    With this flag enabled the System will return the price of registration renewal (1/0). Optional field.

    show_update_data

    Show price for update domain (1/0). Optional field.

    currency

    Identifier of the currency in which the prices will be quoted: RUR (default), UAH, USD, EUR. Optional field.

    Response fields:
    Field Description

    currency

    Currency, in which the returned prices are quoted.

    price_group

    Rate plan.

    prices

    Prices sorted by domain zones.
    The prices are quoted for the period of 1 year. For some of the zones the minimum registration period exceeds 1 year.
    If a zone allows Cyrillic domains and the price for them differ from the price for domains in Latin characters, for such a zone the system will return an additional record with the prefix '__idn.'.

    renew_price

    renewal price for your fare

    retail_renew_price

    renewal price for a user with "Retail" status

    reg_price

    register price for your fare

    retail_reg_price

    register price for a user with "Retail" status

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "currency" : "RUR",
          "price_group" : "Retail",
          "prices" : {
             "__idn.com" : {
                "reg_max_period" : "10",
                "reg_min_period" : "1",
                "reg_price" : "960"
             },
             "com" : {
                "reg_max_period" : "10",
                "reg_min_period" : "1",
                "reg_price" : "450"
             },
             "ru" : {
                "reg_max_period" : "1",
                "reg_min_period" : "1",
                "reg_price" : "590"
             },
             "рф" : {
                "reg_max_period" : "1",
                "reg_min_period" : "1",
                "reg_price" : "1200"
             }
          }
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    8.3. Function: domain/get_suggest

    Accessibility:
    Partners
    Support of service list:
    No
    Designation:

    Suggest a domain name using keywords. The function is similar to the Reg.Choice service.

    Request fields:
    Parameter Description

    word

    Main keyword. For example, «domain». Mandatory field.

    additional_word

    Additional keyword. For example, «new» or «best». Optional field.

    category

    The category of picked up names. Valid values: ‘pattern’ — names matching defined patterns («name + prefix»), ‘search_trends’ – current search trends, ‘all’ (default) – all categories.

    tlds

    The zone in which the domain name should be checked for availability. Valid zones: 'com', 'info', 'name', 'net', 'org', 'ru', 'ru.com', 'su', 'рф'. To define several zones at a time, add a separate field for each zone, for example: "...&tlds=ru&tlds=su&tlds=com". If a request does not contain a single ‘tlds’ field, the domains will be searched in all the above-mentioned zones.

    use_hyphen

    Use hyphens to delimit words in domain names (for example, “best- domain”). Valid values: 0 (do not use hyphens) and 1 (use hyphens). By default hyphens are not used (“bestdomain”).

    Response fields:
    Field Description

    suggestions

    An array with domain name alternatives. Each element includes the field “name” (name alternative) and the array “avail_in” with a list of zones in which this name is available for registration. Maximum array size: 100.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "suggestions" : [
             {
                "avail_in" : [
                   "рф",
                   "su"
                ],
                "name" : "дом"
             },
             {
                "avail_in" : [
                   "ru",
                   "su"
                ],
                "name" : "dom"
             },
             {
                "avail_in" : [
                   "рф",
                   "su"
                ],
                "name" : "новый"
             },
             {
                "avail_in" : [
                   "ru",
                   "su",
                   "org"
                ],
                "name" : "novii"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    8.4. Function: domain/get_premium_prices

    Accessibility:
    Partners
    Support of service list:
    No
    Designation:

    return rates for these premium domains

    Request fields:
    Parameter Description

    domains

    List of domains (no more than 100 pieces)

    currency

    Currency

    Response fields:
    Field Description

    domains

    An hash array with premium domains. Each hash in the array contains a field \" domain_name \ "(domain), the field \" register_price \ "(registration fee), renew_price, register_period, renew_period

    currency

    Currency

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "currency" : "USD",
          "domains" : [
             {
                "domain_name" : "007.academy",
                "register_period" : "1",
                "register_price" : "238.16",
                "renew_period" : "1",
                "renew_price" : "238.16"
             },
             {
                "domain_name" : "ua.ae.org",
                "register_period" : "1",
                "register_price" : "280.51",
                "renew_period" : "0",
                "renew_price" : "0.000"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Possible errors:

    See the list of common error codes

    8.5. Function: domain/get_deleted

    Accessibility:
    Partners
    Support of service list:
    No
    Designation:

    Get a list of deleted domains. The function is similar to the Deleted Domains page.

    Request fields:
    Parameter Description

    tlds

    The zones in which search for deleted domains. Valid zones: : 'ru', 'рф', 'su'. To define several zones at a time, add a separate value for each zone, for example: "...&tlds=ru&tlds=su&tlds=рф". If a request does not contain a single ‘tlds’ value, the domain name will be searched in all the above-mentioned zones.

    deleted_from

    Domain delete date from which to select domains in result list. Should be in format 'YYYY-MM-DD'. Defaults to last date of domain deletion.

    deleted_to

    Domain delete date till which to select domains in result list. Should be in format 'YYYY-MM-DD'. Defaults to last date of domain deletion. 'deleted_to' value can not be later more than two months than 'deleted_from' value.

    created_from

    Domain first registration date from which to select domains in result list. Should be in format 'YYYY-MM-DD'.

    created_to

    Domain first registration date till which to select domains in result list. Should be in format 'YYYY-MM-DD'.

    hidereg

    When set to 1 only not registered domains are returned. Defaults to 0.

    min_pr

    The minimum value of Google PR of the domain

    min_cy

    The minimum value of Yandex CY of the domain

    Response fields:
    Field Description

    domains

    A list of deleted domains. Each element contains these fields: domain_name — domain name, date_delete — date of domain deletion, registered — current status of domain: 'NOT REGISTERED' or 'REGISTERED', first_create_date — domain first registration date, yandex_tic — value of Google PR of the domain, google_pr — value of Yandex CY of the domain. Maximum list size: 50000.

    Example of a request:
    Example of a successful response:
    
    {
       "answer" => {
          "domains" => [
             {
                "domain_name" => "apmatypa.ru",
                "registered" => "NOT REGISTERED",
                "yandex_tic" => 0,
                "first_create_date" => "2006-05-18",
                "google_pr" => "2",
                "date_delete" => "2013-09-26"
             },
             {
                "domain_name" => "hudojnick.ru",
                "registered" => "NOT REGISTERED",
                "yandex_tic" => 0,
                "first_create_date" => "2004-10-19",
                "google_pr" => "1",
                "date_delete" => "2013-09-26"
             },
             {
                "domain_name" => "dpr-ryazan.ru",
                "registered" => "NOT REGISTERED",
                "yandex_tic" => 0,
                "first_create_date" => "2007-07-23",
                "google_pr" => "1",
                "date_delete" => "2013-09-26"
             }
          ]
       }
       "result" => "success"
    }
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    8.6. Function: domain/check

    Accessibility:
    Partners
    Support of service list:
    Yes
    Designation:

    This function serves to check availability of domains for registration.

    Request fields:
    Parameter Description

    domain_name

    Domain name, the field is incompatible with the “domains” list

    domains

    An array with a lsit of domain name alternatives. Each array element is a hash with the dname or domain_name key. The field can be used in JSON and XML requests only.

    is_transfer

    When set to 1, the system checks the possibility of transfer of the domain to REG.RU. When set to 0 (default), the system just checks the availability of the domain for registration.

    premium_as_taken

    All premium_domain get answer that the domain is not available (0/1). Optional field

    currency

    Currency for show of the prices (RUR, UAH, USD, EUR). Optional field, default is RUR

    Response fields:
    Field Description

    domains

    An array of hashes providing data about domain names and their availability. If a response is successful, the result field will have the Available value.

    is_premium

    Premium domain flag, if set premium_as_taken=1 that this flag that this flag will have all premiums

    price

    The domain price of registration for 1 year, it is displayed only at the premium domain, available to registration

    renew_price

    The domain price of renewal for 1 year, it is displayed only at the premium domain, available to registration

    currency

    Price currency

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "ya.ru",
                "error_code" : "DOMAIN_ALREADY_EXISTS",
                "result" : "Domain already exists, use whois service"
             },
             {
                "dname" : "yayayayayaya.ru",
                "result" : "Available"
             },
             {
                "dname" : "xn--000.com",
                "error_code" : "INVALID_DOMAIN_NAME_PUNYCODE",
                "result" : "Invalid punycode value for domain_name"
             },
             {
                "dname" : "china.cn",
                "error_code" : "TLD_DISABLED",
                "result" : "Registration in .cn TLD is not available"
             },
             {
                "dname" : "ййй.me",
                "error_code" : "DOMAIN_BAD_NAME",
                "result" : "Invalid domain name=> ййй.me"
             },
             {
                "dname" : "wwww.ww",
                "error_code" : "INVALID_DOMAIN_NAME_FORMAT",
                "result" : "domain_name is invalid or unsupported zone"
             },
             {
                "dname" : "a.ru",
                "error_code" : "DOMAIN_INVALID_LENGTH",
                "result" : "Invalid domain name length, You have entered too short or too long name"
             },
             {
                "dname" : "qqйй.com",
                "error_code" : "HAVE_MIXED_CODETABLES",
                "result" : "You can not mix latin and cyrillic letters in domain names"
             },
             {
                "currency" : "RUR",
                "dname" : "rr.ru.com",
                "is_premium" : "1",
                "price" : "60000",
                "renew_price" : "600",
                "result" : "Available"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    8.7. Function: domain/create

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    Apply for domain name registration.

    Request fields:
    Field Name Min Length Max Length Field Description
    domain_name
    Depends on the zone.
    The name of the domain being registered. Allowed symbols (IDNs) and the length of the field depend on the domain zone. Mandatory field.
    P.S. Privileged clients can register multiple domain names in the same zone by a single request.
    domains
    Массив со списком доменов; каждый элемент массива является хешем с ключами dname — имя домена и дополнительными сервисами для каждого домена (srv_certificate, srv_parking, srv_webfwd), если они нужны. Несовместимо с передачей имени домена через domain_name.
    period
    1
    2
    The period for which the domain name is registered. Allowed values: depend on the selected domain zone, for example the .ru and .su zones allow only «1». Mandatory field.
    enduser_ip
    11
    15
    IP-address of enduser (user that made an order). It is mandatory field.
    contacts
    A hash of contact data fields. The list of fields depends on the domain zone and/or the type of applicant (physical or legal body). This field can be used in JSON and XML requests only.
    profile_type
    Type of the user contact data profile. This parameter cannot be used together with the parameters that explicitly define user contact data (this data will be overwritten by the data from the profile). Currently, the following profile types are available: GTLD, EU, TJ, RU.PP, RU.ORG, NEWTCI.ORG, NEWTCI.PP. There are plans to add some new profile types to this list.
    profile_name
    Name of the contact data profile. This parameter is used together with the profile_type parameter and cannot be used together with the parameters that explicitly define user contact data (this data will be overwritten by the data from the profile).
    nss
    A hash of names and IP addresses of NS servers. Applicable only to JSON and XML requests.
    not_delegated
    1
    With this flag enabled the system wil ignore the values of the NS server-related fields and NSS hash for the .ru, .su and .рф zones and register domains undelegated. This parameter is not applicable to other zones. Valid values: 0 and 1.
    user_servid
    32
    32
    Domain ID set by the user. Allowed symbols: digits (from 0 through 9), Latin letters (from a through f). This ID cannot be generated automatically. If it is not defined upon service ordering, the field will be empty. Optional field.
    comment
    0
    255
    Comment. Not required field.
    admin_comment
    0
    255
    Admins comment. Not required field.
    point_of_sale
    pay_type
    ok_if_no_money
    subtype
    0
    15
    Registration type. Optional field. Valid value (except for default null): «preorder» – domain reservation in the .РФ zone.
    reg_premium
    1
    Registration of the premium domain. Optional field. Valid value (except for default 0): «1» – shows that the client knows that it is a premium the domain and knows its price. The price of the premium domain can be from 10 to 1000 times more, than usual registration. Check the price using /choose/domain/ or by means of the domain/get_premium_prices function
    Description of folder management fields

    All the fields in this category are optional.

    Parameter Description

    folder_name

    Folder name, in which domain will be added. If folder not exist and no_new_folder is not set then new folder will be created.

    folder_id

    Numeric folder identifier, in which domain will be added.

    no_new_folder

    Do not create folder if not exist.

    Description of contact data fields
    Contact data for .RU/.SU/.РФ domains

    There are two mutually exclusive sets of contact data fields: contact data of an organization (if the domain is registered to a legal entity) and contact data of a private person (if the domain is registered to a private person). Please note that you can use only one set of contact data fields. Also, some of the fields allow multiple lines.

    Common fields
    Parameter Min length Max length Description

    sms_security_number

    8

    25

    The SMS-Security numbers of domain administrator.
    Example: +7 927 1234567

    p_addr

    15

    255
    multi-
    line

    The postal address of domain administrator in russian language. Could be multiline.
    The record must contain:
    for individuals: postal code, city name, address including street name and house number (possible additional information in the form of building/apartment number, etc.), recipient name
    for legal entities: postal code, city name, address including street name and house number (possible additional information in the form of building/office number, etc.), recipient (individual or Department name)

    Example: 101000, Москва, ул.Пупкина, 1, стр. 2, отдел мебели, офис 433 (для В. Лоханкина)

    phone

    8

    255
    multi-
    line

    The phone numbers of domain administrator.
    Format: international code (including +) and phone number.
    International code, local code and phone number should be splitted by spaces. No parentheses and dashes allowed. Could be multiline.
    Example: +7 495 8102233\n+7 3432 811221

    fax

    8

    255
    multi-
    line

    The fax numbers of domain administrator.
    Format: international code (including +) and phone number.
    International code, local code and phone number should be splitted by spaces. No parentheses and dashes allowed. Could be multiline.
    Example: +7 3432 811221

    e_mail

    6

    255
    multi-
    line

    The email addresses of domain administrator according to RFC-822. Could be multiline. Example: ncc@test.ru\ntest@test.ru

    Contact data for organization only
    Parameter Min length Max length Description

    org

    6

    255
    multi-
    line

    Organization name in latin letters - domain administrator.
    Will be used as WHOIS data of domain. Could be multiline. Example: Karla-Marla Uryupinsk State University Example2: "ROGA I KOPYTA", LTD.

    org_r

    10

    255
    multi-
    line

    Full organization name in russian language - domain administrator, according to constituent documents. For non-residents filled in native or english language.Could be multiline.
    Example: Общество с ограниченной ответственностью "Рога и Копыта" Example2: Общество с ограниченной ответственностью "Рога и Копыта"

    code

    10

    10

    Organization INN code (for Russian organizations) - domain administrator.
    Could be empty, if domain administrator is non-resident of Russia and have no INN code. Example: 7701107259

    kpp

    9

    9

    Organization KPP code (for Russian organizations). Required field.
    Example: 632946014

    country

    2

    2

    2-letter ISO-code of country where company is registered.
    Example: RU

    address_r

    15

    255
    multi-
    line

    The legal address of organization in russian language. Could be multiline.
    Example: 101000, Москва, УЛ.Пупкина, 1, стр. 2

    Contact data for Private Person only
    Parameter Min length Max length Description

    person

    8

    64

    First name, first letter of patronymic (without point) and last name of domain administrator. Will be used as WHOIS data of domain. For non-residents this field contains name in native language or in english transliteration.
    Example: Vassily N Pupkin

    person_r

    9

    64

    First name, first letter of patronymic (without point) and last name of domain administrator in russian language, according to passport.
    For non-residents this field contains name in native language or in english transliteration. Example: Василий Николаевич Пупкин Example2: John Smith

    passport

    20

    255
    multi-
    line

    The serie, number, issuer and issue date of passport.
    Date format: DD.MM.YYYY
    For non-residents its possible to use another document, drivers' licence for example. In this case document type should be stated in the first line. Field could be multiline. Example: 32 02 651241 выдан 48 о/м г.Москвы 26.12.1990 Example2: driver's licence\n AA 1234 BB John Smith

    birth_date

    10

    10

    The birth date of domain administrator in DD.MM.YYYY format.
    Example: 07.11.1917

    country

    2

    2

    2-letter ISO-code of country.
    Example: RU

    code

    12

    12

    INN code of domain administrator - private businessmen.
    Only for private businessmen.
    Example: 789012345678

    Contact data for the .tj domain zone

    Currently all contact data should be specified in Latin characters.

    Parameter Min length Max length Description

    o_type

    1

    1

    Owner type: "1" – private person, "2" – legal entity.

    o_whois

    2

    64

    Domain description. Displayed in the WHOIS request.

    o_full_name

    2

    64

    Domain owner: full name of the organization/private person.

    o_email

    6

    90

    Domain owner e-mail address in the RFC-822 format.

    o_phone

    10

    16

    Domain owner phone number in the international format; country code, city code and local number should be delimited with whitespaces.
    (Example: +7 495 1234567 or +662 22 1234567)

    o_fax

    10

    16

    Fax number of the domain owner in the international format; country code, city code and local and extension number should be delimited with whitespaces.
    (Example: +7 495 1234567 or +662 22 1234567)

    o_addr

    2

    128

    Address of the domain owner: legal address of the organization in compliance with the articles of association or the domain owner postal address.

    o_city

    2

    64

    Address of the domain owner: city.

    o_country_code

    2

    2

    Two-letter ISO code of the domain owner’s country. Click here for the list of country codes.

    a_full_name

    2

    64

    Full name of the domain administrator

    a_nic_name

    2

    32

    Short/nickname of the administrator (single word)

    a_email

    6

    90

    Domain administrator e-mail address in the RFC-822 format.

    a_fax

    10

    16

    Domain administrator phone (!) number in the international format; country code, city code, local and extension numbers should be delimited with whitespaces.
    Example: +7 495 1234567 or +662 22 1234567

    a_addr

    2

    128

    Address of the domain administrator.

    a_city

    Address of the domain administrator: city.

    a_postcode

    3

    10

    Address of the domain administrator: postal code.

    a_country_code

    2

    2

    Two-letter ISO code of the country, the administrator of the domain is the citizen of. Click here for the list of country codes.

    t_full_name

    2

    64

    Domain technical administrator contacts

    t_nic_name

    2

    32

    Short/nickname of the technical administrator (single word).

    t_email

    6

    90

    Domain technical administrator e-mail address in the RFC-822 format.

    t_fax

    10

    16

    Technical administrator phone (!) number in the international format; country code, city code, local and extension numbers should be delimited with whitespaces.
    Example: +7 495 1234567 or +662 22 1234567

    t_addr

    2

    128

    Address of the domain technical administrator.

    t_city

    2

    64

    Address of the domain technical administrator: city.

    t_postcode

    3

    10

    Address of the domain technical administrator: postal code

    t_country_code

    2

    2

    Two-letter ISO code of the country, the technical administrator of the domain is the citizen of.
    Click here for the list of country codes.

    Domain registration in the com.ua, kiev.ua zones

    Currently all contact data should be defined in Latin letters. There are tow types of contacts for the com.ua, kiev.ua domain zones: domain owner (administrator) contacts and contacts of technical specialists. Changes in the contact data of the domain owner after the domain registration cannot be made in the automatic mode.

    Parameter Min length Max length Description

    o_company

    5

    80

    Domain organisation contacts. Set to "Private person" if domain owner is Private person.

    o_first_name

    2

    40

    First name

    o_last_name

    2

    40

    Last name

    o_email

    6

    80

    The email address of domain contact person.

    o_phone

    8

    20

    The phone numbers of contact person.
    Format: international code (including +) and phone number.
    (Example: +7.4952171179).

    o_fax

    8

    20

    The fax numbers of contact person.
    Format: international code (including +) and phone number.
    (Example: +7.4952171179).

    o_addr

    8

    80

    Address of contact person: street, building, apartment (office)

    o_city

    2

    80

    Address of contact person: city

    o_state

    2

    40

    Address of contact person: region/state

    o_postcode

    3

    10

    Postal code of contact person

    o_country_code

    2

    2

    2-letter ISO-code of country. List of coutry ISO code can be found here

    t_company

    5

    80

    Specify the name of the Organization to which the technical contact belongs.

    t_first_name

    2

    40

    First name

    t_last_name

    2

    40

    Last name

    t_email

    6

    80

    The email address of domain contact person.

    t_phone

    8

    20

    The phone numbers of contact person.
    Format: international code (including +) and phone number.
    (Example: +7.4952171179).

    t_fax

    8

    20

    The fax numbers of contact person.
    Format: international code (including +) and phone number.
    (Example: +7.4952171179).

    t_addr

    8

    80

    Address of contact person: street, building, apartment (office)

    t_city

    2

    80

    Address of contact person: city

    t_state

    2

    40

    Address of contact person: region/state

    t_postcode

    3

    10

    Postal code of contact person

    t_country_code

    2

    2

    2-letter ISO-code of country. List of coutry ISO code can be found here

    Domain registration in the pp.ua zone

    Currently all contact data should be defined in Latin letters. When registering domains in the pp.ua zone you should define the number of the mobile phone in the domain owner contact data. After the stration, an SMS message with a domain activation code will be sent to this number. This code, as well as the domain name, should be entered here: http://www.pp.ua/rus/confirm.html . No more than three domain names can be registered to the same mobile number. Click here for details about domain registration the pp.ua zone. The rest of the of the domain registration rules in the pp.ua zone comply with the domain registration rules in other zones.

    Domain registration in the *.kz zone (all Kazakhstan domains)

    Starting from September 10, 2010, in compliance with the KazNIC rules , domain contact data should include address of the server hosting the domain. Domains registered after September 10, 2010, must be hosted on the Kazakhstan-based servers. To define the location of servers when registering a domain or changing contact data, the following fields should be added to the hashes of contact.

    Parameter Min length Max length Description

    srvloc_state

    2

    40

    State / Province

    srvloc_city

    2

    40

    City

    srvloc_street

    2

    255

    Street address

    If you are not planning to tie your domain to a specific host you can use the following values for the server address fields:

    srvloc_state
    KAR
    srvloc_city
    Karaganda
    srvloc_street
    Chizhevskogo, 17
    Domain registration in the .es zone
    Parameter Min length Max length Description

    es_form_juridica

    1

    3

    Domain owner juridical form
    1 - Natural person or individual
    39 - Economic Interest Grouping
    47 - Association
    59 - Sports Association
    68 - Trade Association
    124 - Savings Bank
    150 - Community Property
    152 - Condominium
    164 - Religious Order or Institution
    181 - Consulate
    197 - Public Law Association
    203 - Embassy
    229 - Municipality
    269 - Sports Federation
    286 - Foundation
    365 - Mutual Insurance Company
    434 - Provincial Government Body
    436 - National Government Body
    439 - Political Party
    476 - Trade Union
    510 - Farm Partnership
    524 - Public Limited Company / Corporation
    525 - Sports Public Limited Company
    554 - Partnership
    560 - General Partnership
    562 - Limited Partnership
    566 - Cooperative
    608 - Worker-owned Company
    612 - Limited Liability Company
    713 - Spanish (company) Branch
    717 - Temporary Consortium / Joint Venture
    744 - Worker-owned Limited Company
    745 - Provincial Government Entity
    746 - National Government Entity
    747 - Local Government Entity
    877 - Others
    878 - Designation of Origin Regulatory Council
    879 - Natural Area Management Entity

    es_identificacion

    3

    30

    Identification document ID

    es_tipo_identificacion

    1

    1

    Identification document type
    1 - DNI or NIF
    3 - NIE
    0 - Other ID

    Domain registration in the .jobs zone
    Parameter Min length Max length Description

    company_url

    4

    255

    Company URL

    ind_classification

    1

    2

    Industry Classification|
    2 - "Accounting/Banking/Finance (2)"
    3 - "Agriculture/Farming (3)"
    21 - "Biotechnology/Science (21)"
    5 - "Computer/Information Technology (5)"
    4 - "Construction/Building Services (4)"
    12 - "Consulting (12)"
    6 - "Education/Training/Library (6)"
    7 - "Entertainment (7)"
    13 - "Environmental (13)"
    19 - "Hospitality (19)"
    10 - "Government/Civil Service (10)"
    11 - "Healthcare (11)"
    15 - "HR/Recruiting (15)"
    16 - "Insurance (16)"
    17 - "Legal (17)"
    18 - "Manufacturing (18)"
    20 - "Media/Advertising (20)"
    9 - "Parks & Recreation (9)"
    26 - "Pharmaceutical (26)"
    22 - "Real Estate (22)"
    14 - "Restaurant/Food Service (14)"
    23 - "Retail (23)"
    8 - "Telemarketing (8)"
    9 - "Transportation (24)"
    25 - "Other (25)"

    hra_name

    2

    3

    Human Resource Association
    no - No
    yes - Yes

    job_title

    4

    255

    Title of contact in organization (e.g. CEO)

    admin_type

    1

    1

    Title is administrative contact
    0 - No
    1 - Yes

    Domain registration in the .travel zone

    To register .TRAVEL domain you must pass the authentication and get ".travel UIN" from one of authentication providers . If You have already passed the authentication, enter your .travel UIN in the field below:

    Parameter Min length Max length Description

    travel_uin

    1

    100

    TRAVEL UIN

    Domain registration in the .us zone
    Parameter Max length Description

    RselnexusAppPurpose

    2

    Purpose of domain name
    P1 - for Business for profit
    P2 - for Business for non profit
    P3 - for Personal Use
    P4 - for Educational Purposes
    P5 - for Government Purposes

    RselnexusCategory

    3

    Registrant's category
    C11 - U.S. Citizen
    C12 - Permanent resident of the U.S. or any of its possessions or territories
    C21 - U.S. organization incorporated within one of the 50 states or a U.S. Territory.
    C31 - if regularly engages in lawful activities (sales of goods or services or other business, commercial or non-commercial, including not-for-profit relations in the United States)
    C32 - if entity has an office or other facility in the U.S

    Domain registration in the .МОСКВА, .MOSCOW, .ДЕТИ, .TATAR, .RU.NET, .COM.RU, .MSK.RU, SPB.RU and other geodomain zones for organization

    For .RU.NET, .COM.RU, .EXNET.SU and geodomains .ABKHAZIA.SU, .ADYGEYA.RU, .ADYGEYA.SU, .AKTYUBINSK.SU, .ARKHANGELSK.SU, .ARMENIA.SU, .ASHGABAD.SU, .AZERBAIJAN.SU, .BALASHOV.SU, .BASHKIRIA.RU, .BASHKIRIA.SU, .BIR.RU, .BRYANSK.SU, .BUKHARA.SU, .CBG.RU, .CHIMKENT.SU, .DAGESTAN.RU, .DAGESTAN.SU, .EAST-KAZAKHSTAN.SU, .EXNET.SU, .GEORGIA.SU, .GROZNY.RU, .GROZNY.SU, .IVANOVO.SU, .JAMBYL.SU, .KALMYKIA.RU, .KALMYKIA.SU, .KALUGA.SU, .KARACOL.SU, .KARAGANDA.SU, .KARELIA.SU, .KHAKASSIA.SU, .KRASNODAR.SU, .KURGAN.SU, .KUSTANAI.RU, .KUSTANAI.SU, .LENUG.SU, .MANGYSHLAK.SU, .MARINE.RU, .MORDOVIA.RU, .MORDOVIA.SU, .MSK.RU, .MSK.SU, .MURMANSK.SU, .MYTIS.RU, .NALCHIK.RU, .NALCHIK.SU, .NAVOI.SU, .NORTH-KAZAKHSTAN.SU, .NOV.RU, .NOV.SU, .OBNINSK.SU, .PENZA.SU, .POKROVSK.SU, .PYATIGORSK.RU, .RU.NET, .SOCHI.SU, .SPB.RU, .SPB.SU, .TASHKENT.SU, .TERMEZ.SU, .TOGLIATTI.SU, .TROITSK.SU, .TSELINOGRAD.SU, .TULA.SU, .TUVA.SU, VLADIKAVKAZ.RU, .VLADIKAVKAZ.SU, .VLADIMIR.RU, .VLADIMIR.SU, .VOLOGDA.SU zones need set Registrant Contacts only, without admin and tech contacts

    Registrant Contacts
    Parameter Min length Max length Description

    o_first_name

    2

    40

    First name.
    Example: Ivan

    o_first_name_ru

    2

    40

    First name (in russian).
    Example: Иван

    o_last_name

    2

    40

    Last name.
    Example: Sidorov

    o_last_name_ru

    2

    40

    Last name (in russian).
    Example: Иванов

    o_patronimic

    2

    25

    First letter of patronimic.
    Example: Sidorovich

    o_patronimic_ru

    2

    25

    Patronimic.
    Example: Иванович

    o_city

    2

    40

    City.
    Example: Moscow

    o_city_ru

    3

    80

    City (in russian).
    Example: г. Москва

    o_addr

    8

    80

    Address.
    Example: Koshkina str, 15-4

    o_addr_ru

    10

    255

    Address (in russian).
    Example: ул. Кошкина, д.15, кв.4

    o_state

    2

    40

    State/Province.
    Example: Moscow

    o_state_ru

    2

    40

    State/Province (in russian).
    Example: Московская обл.

    o_phone

    8

    20

    Phone.
    Example: +7 495 1234567
    +7 495 1234569

    o_email

    6

    90

    EMail.
    Example: adm-group@newtime.ru
    sidor@newtime.msk.su

    o_postcode

    3

    10

    Zip code.
    Example: 123456

    o_country_code

    2

    2

    Country.
    Example: RU

    o_company

    5

    80

    Company.
    Example: Novye vremena, CJSC

    o_company_ru

    5

    255

    Company (in russian).
    Example: ООО Новые времена

    o_code

    6

    12

    Organization INN.
    Example: 1234567890

    o_l_addr_ru

    10

    255

    Address (in russian).
    Example: ул. Кошкина, д.15, кв.4

    o_l_addr

    10

    255

    Address (in russian).
    Example: Koshkina str, 15-4

    o_l_city

    2

    40

    City.
    Example: Moscow

    o_l_city_ru

    3

    80

    City (in russian).
    Example: г. Москва

    o_l_postcode

    3

    8

    Zip code.
    Example: 123456

    o_l_state

    2

    40

    State/Province.
    Example: Moscow

    o_l_state_ru

    2

    40

    State/Province (in russian).
    Example: Московская обл.

    Admin Contacts
    Parameter Min length Max length Description

    a_first_name

    2

    40

    First name.
    Example: Ivan

    a_first_name_ru

    2

    40

    First name (in russian).
    Example: Иван

    a_last_name

    2

    40

    Last name.
    Example: Sidorov

    a_last_name_ru

    2

    40

    Last name (in russian).
    Example: Иванов

    a_patronimic

    2

    25

    First letter of patronimic.
    Example: Sidorovich

    a_patronimic_ru

    2

    25

    Patronimic.
    Example: Иванович

    a_city

    2

    40

    City.
    Example: Moscow

    a_city_ru

    3

    80

    City (in russian).
    Example: г. Москва

    a_addr

    8

    80

    Address.
    Example: Koshkina str, 15-4

    a_addr_ru

    10

    255

    Address (in russian).
    Example: ул. Кошкина, д.15, кв.4

    a_state

    2

    40

    State/Province.
    Example: Moscow

    a_state_ru

    2

    40

    State/Province (in russian).
    Example: Московская обл.

    a_phone

    8

    20

    Phone.
    Example: +7 495 1234567
    +7 495 1234569

    a_email

    6

    90

    EMail.
    Example: adm-group@newtime.ru
    sidor@newtime.msk.su

    a_postcode

    3

    10

    Zip code.
    Example: 123456

    a_country_code

    2

    2

    Country.
    Example: RU

    a_company

    5

    80

    Company.
    Example: Novye vremena, CJSC

    a_company_ru

    5

    255

    Company (in russian).
    Example: ООО Новые времена

    a_code

    6

    12

    Organization INN.
    Example: 1234567890

    a_l_addr_ru

    10

    255

    Address (in russian).
    Example: ул. Кошкина, д.15, кв.4

    a_l_addr

    10

    255

    Address (in russian).
    Example: Koshkina str, 15-4

    a_l_city

    2

    40

    City.
    Example: Moscow

    a_l_city_ru

    3

    80

    City (in russian).
    Example: г. Москва

    a_l_postcode

    3

    8

    Zip code.
    Example: 123456

    a_l_state

    2

    40

    State/Province.
    Example: Moscow

    a_l_state_ru

    2

    40

    State/Province (in russian).
    Example: Московская обл.

    Tech Contacts
    Parameter Min length Max length Description

    t_first_name

    2

    40

    First name.
    Example: Ivan

    t_first_name_ru

    2

    40

    First name (in russian).
    Example: Иван

    t_last_name

    2

    40

    Last name.
    Example: Sidorov

    t_last_name_ru

    2

    40

    Last name (in russian).
    Example: Иванов

    t_patronimic

    2

    25

    First letter of patronimic.
    Example: Sidorovich

    t_patronimic_ru

    2

    25

    Patronimic.
    Example: Иванович

    t_city

    2

    40

    City.
    Example: Moscow

    t_city_ru

    3

    80

    City (in russian).
    Example: г. Москва

    t_addr

    8

    80

    Address.
    Example: Koshkina str, 15-4

    t_addr_ru

    10

    255

    Address (in russian).
    Example: ул. Кошкина, д.15, кв.4

    t_state

    2

    40

    State/Province.
    Example: Moscow

    t_state_ru

    2

    40

    State/Province (in russian).
    Example: Московская обл.

    t_phone

    8

    20

    Phone.
    Example: +7 495 1234567
    +7 495 1234569

    t_email

    6

    90

    EMail.
    Example: adm-group@newtime.ru
    sidor@newtime.msk.su

    t_postcode

    3

    10

    Zip code.
    Example: 123456

    t_country_code

    2

    2

    Country.
    Example: RU

    t_company

    5

    80

    Company.
    Example: Novye vremena, CJSC

    t_company_ru

    5

    255

    Company (in russian).
    Example: ООО Новые времена

    t_code

    6

    12

    Organization INN.
    Example: 1234567890

    t_l_addr_ru

    10

    255

    Address (in russian).
    Example: ул. Кошкина, д.15, кв.4

    t_l_addr

    10

    255

    Address (in russian).
    Example: Koshkina str, 15-4

    t_l_city

    2

    40

    City.
    Example: Moscow

    t_l_city_ru

    3

    80

    City (in russian).
    Example: г. Москва

    t_l_postcode

    3

    8

    Zip code.
    Example: 123456

    t_l_state

    2

    40

    State/Province.
    Example: Moscow

    t_l_state_ru

    2

    40

    State/Province (in russian).
    Example: Московская обл.

    Domain registration in the .МОСКВА, .MOSCOW, .ДЕТИ, .TATAR, .RU.NET, .COM.RU, .MSK.RU, SPB.RU and other geodomain zones for private person

    For .RU.NET, .COM.RU, .EXNET.SU and geodomains .ABKHAZIA.SU, .ADYGEYA.RU, .ADYGEYA.SU, .AKTYUBINSK.SU, .ARKHANGELSK.SU, .ARMENIA.SU, .ASHGABAD.SU, .AZERBAIJAN.SU, .BALASHOV.SU, .BASHKIRIA.RU, .BASHKIRIA.SU, .BIR.RU, .BRYANSK.SU, .BUKHARA.SU, .CBG.RU, .CHIMKENT.SU, .DAGESTAN.RU, .DAGESTAN.SU, .EAST-KAZAKHSTAN.SU, .EXNET.SU, .GEORGIA.SU, .GROZNY.RU, .GROZNY.SU, .IVANOVO.SU, .JAMBYL.SU, .KALMYKIA.RU, .KALMYKIA.SU, .KALUGA.SU, .KARACOL.SU, .KARAGANDA.SU, .KARELIA.SU, .KHAKASSIA.SU, .KRASNODAR.SU, .KURGAN.SU, .KUSTANAI.RU, .KUSTANAI.SU, .LENUG.SU, .MANGYSHLAK.SU, .MARINE.RU, .MORDOVIA.RU, .MORDOVIA.SU, .MSK.RU, .MSK.SU, .MURMANSK.SU, .MYTIS.RU, .NALCHIK.RU, .NALCHIK.SU, .NAVOI.SU, .NORTH-KAZAKHSTAN.SU, .NOV.RU, .NOV.SU, .OBNINSK.SU, .PENZA.SU, .POKROVSK.SU, .PYATIGORSK.RU, .RU.NET, .SOCHI.SU, .SPB.RU, .SPB.SU, .TASHKENT.SU, .TERMEZ.SU, .TOGLIATTI.SU, .TROITSK.SU, .TSELINOGRAD.SU, .TULA.SU, .TUVA.SU, VLADIKAVKAZ.RU, .VLADIKAVKAZ.SU, .VLADIMIR.RU, .VLADIMIR.SU, .VOLOGDA.SU zones need set Registrant Contacts only, without admin and tech contacts

    Registrant Contacts
    Parameter Min length Max length Description

    o_first_name

    2

    40

    First name.
    Example: Ivan

    o_first_name_ru

    2

    40

    First name (in russian).
    Example: Иван

    o_last_name

    2

    40

    Last name.
    Example: Sidorov

    o_last_name_ru

    2

    40

    Last name (in russian).
    Example: Иванов

    o_patronimic

    2

    25

    First letter of patronimic.
    Example: Sidorovich

    o_patronimic_ru

    2

    25

    Patronimic.
    Example: Иванович

    o_city

    2

    40

    City.
    Example: Moscow

    o_city_ru

    3

    80

    City (in russian).
    Example: г. Москва

    o_addr

    8

    80

    Address.
    Example: Koshkina str, 15-4

    o_addr_ru

    10

    255

    Address (in russian).
    Example: ул. Кошкина, д.15, кв.4

    o_state

    2

    40

    State/Province.
    Example: Moscow

    o_state_ru

    2

    40

    State/Province (in russian).
    Example: Московская обл.

    o_phone

    8

    20

    Phone.
    Example: +7 495 1234567
    +7 495 1234569

    o_email

    6

    90

    EMail.
    Example: adm-group@newtime.ru
    sidor@newtime.msk.su

    o_postcode

    3

    10

    Zip code.
    Example: 123456

    o_country_code

    2

    2

    Country.
    Example: RU

    o_code

    6

    12

    INN.
    Example: 1234567890

    o_birth_date

    10

    10

    Birth date.
    Example: 08.05.1965

    o_passport_date

    10

    30

    Date of reception of the passport.
    Example: 30.01.1992

    o_passport_number

    6

    30

    Passport number.
    Example: 12 34 567890

    o_passport_place

    10

    200

    Place of reception of the passport.
    Example: выдан 123 отделением милиции г.Москвы

    Admin Contacts
    Parameter Min length Max length Description

    a_first_name

    2

    40

    First name.
    Example: Ivan

    a_first_name_ru

    2

    40

    First name (in russian).
    Example: Иван

    a_last_name

    2

    40

    Last name.
    Example: Sidorov

    a_last_name_ru

    2

    40

    Last name (in russian).
    Example: Иванов

    a_patronimic

    2

    25

    First letter of patronimic.
    Example: Sidorovich

    a_patronimic_ru

    2

    25

    Patronimic.
    Example: Иванович

    a_city

    2

    40

    City.
    Example: Moscow

    a_city_ru

    3

    80

    City (in russian).
    Example: г. Москва

    a_addr

    8

    80

    Address.
    Example: Koshkina str, 15-4

    a_addr_ru

    10

    255

    Address (in russian).
    Example: ул. Кошкина, д.15, кв.4

    a_state

    2

    40

    State/Province.
    Example: Moscow

    a_state_ru

    2

    40

    State/Province (in russian).
    Example: Московская обл.

    a_phone

    8

    20

    Phone.
    Example: +7 495 1234567
    +7 495 1234569

    a_email

    6

    90

    EMail.
    Example: adm-group@newtime.ru
    sidor@newtime.msk.su

    a_postcode

    3

    10

    Zip code.
    Example: 123456

    a_country_code

    2

    2

    Country.
    Example: RU

    a_code

    6

    12

    INN.
    Example: 1234567890

    a_birth_date

    10

    10

    Birth date.
    Example: 08.05.1965

    a_passport_date

    10

    30

    Date of reception of the passport.
    Example: 30.01.1992

    a_passport_number

    6

    30

    Passport number.
    Example: 12 34 567890

    a_passport_place

    10

    200

    Place of reception of the passport.
    Example: выдан 123 отделением милиции г.Москвы

    Tech Contacts
    Parameter Min length Max length Description

    t_first_name

    2

    40

    First name.
    Example: Ivan

    t_first_name_ru

    2

    40

    First name (in russian).
    Example: Иван

    t_last_name

    2

    40

    Last name.
    Example: Sidorov

    t_last_name_ru

    2

    40

    Last name (in russian).
    Example: Иванов

    t_patronimic

    2

    25

    First letter of patronimic.
    Example: Sidorovich

    t_patronimic_ru

    2

    25

    Patronimic.
    Example: Иванович

    t_city

    2

    40

    City.
    Example: Moscow

    t_city_ru

    3

    80

    City (in russian).
    Example: г. Москва

    t_addr

    8

    80

    Address.
    Example: Koshkina str, 15-4

    t_addr_ru

    10

    255

    Address (in russian).
    Example: ул. Кошкина, д.15, кв.4

    t_state

    2

    40

    State/Province.
    Example: Moscow

    t_state_ru

    2

    40

    State/Province (in russian).
    Example: Московская обл.

    t_phone

    8

    20

    Phone.
    Example: +7 495 1234567
    +7 495 1234569

    t_email

    6

    90

    EMail.
    Example: adm-group@newtime.ru
    sidor@newtime.msk.su

    t_postcode

    3

    10

    Zip code.
    Example: 123456

    t_country_code

    2

    2

    Country.
    Example: RU

    t_code

    6

    12

    INN.
    Example: 1234567890

    t_birth_date

    10

    10

    Birth date.
    Example: 08.05.1965

    t_passport_date

    10

    30

    Date of reception of the passport.
    Example: 30.01.1992

    t_passport_number

    6

    30

    Passport number.
    Example: 12 34 567890

    t_passport_place

    10

    200

    Place of reception of the passport.
    Example: выдан 123 отделением милиции г.Москвы

    Domain registration in other zones
    Parameter Min length Max length Description

    o_company

    5

    80

    Domain organisation contacts. Set to "Private person" (without parenthises) if domain owner is Private person.

    o_first_name

    2

    40

    First name

    o_last_name

    2

    40

    Last name

    o_email

    6

    90

    The email address of domain owner.

    o_phone

    8

    20

    The phone numbers of domain owner.
    Format: international code (including +) and phone number.
    (Example: +7.4952171179).

    o_fax

    8

    20

    The phone numbers of domain owner.
    Format: international code (including +) and phone number. Optional.
    (Example: +7.4952171179).

    o_addr

    8

    80

    Address of domain owner: street, building, apartment (office)

    o_city

    2

    80

    Address of domain owner: city

    o_state

    2

    40

    Address of domain owner: region/state

    o_postcode

    3

    10

    Postal code of domain owner

    o_country_code

    2

    2

    2-letter ISO-code of country. List of coutry ISO code can be found here

    a_company

    5

    80

    Domain organisation contacts. Set to "Private person" if domain owner is Private person.

    a_first_name

    2

    40

    First name

    a_last_name

    2

    40

    Last name

    a_email

    6

    80

    The email address of domain contact person.

    a_phone

    8

    20

    The phone numbers of contact person.
    Format: international code (including +) and phone number.
    (Example: +7.4952171179).

    a_fax

    8

    20

    The fax numbers of contact person.
    Format: international code (including +) and phone number.
    (Example: +7.4952171179).

    a_addr

    8

    80

    Address of contact person: street, building, apartment (office)

    a_city

    2

    80

    Address of contact person: city

    a_state

    2

    40

    Address of contact person: region/state

    a_postcode

    3

    10

    Postal code of contact person

    a_country_code

    2

    2

    2-letter ISO-code of country. List of coutry ISO code can be found here

    t_company

    5

    80

    Specify the name of the Organization to which the technical contact belongs.

    t_first_name

    2

    40

    First name

    t_last_name

    2

    40

    Last name

    t_email

    6

    80

    The email address of domain contact person.

    t_phone

    8

    20

    The phone numbers of contact person.
    Format: international code (including +) and phone number.
    (Example: +7.4952171179).

    t_fax

    8

    20

    The fax numbers of contact person.
    Format: international code (including +) and phone number.
    (Example: +7.4952171179).

    t_addr

    8

    80

    Address of contact person: street, building, apartment (office)

    t_city

    2

    80

    Address of contact person: city

    t_state

    2

    40

    Address of contact person: region/state

    t_postcode

    3

    10

    Postal code of contact person

    t_country_code

    2

    2

    2-letter ISO-code of country. List of coutry ISO code can be found here

    b_company

    5

    80

    Specify the name of the Organization to which the billing contact belongs.

    b_first_name

    2

    40

    First name

    b_last_name

    2

    40

    Last name

    b_email

    6

    80

    The email address of domain contact person.

    b_phone

    8

    20

    The phone numbers of contact person.
    Format: international code (including +) and phone number.
    (Example: +7.4952171179).

    b_fax

    8

    20

    The fax numbers of contact person.
    Format: international code (including +) and phone number.
    (Example: +7.4952171179).

    b_addr

    8

    80

    Address of contact person: street, building, apartment (office)

    b_city

    2

    80

    Address of contact person: city

    b_state

    2

    40

    Address of contact person: region/state

    b_postcode

    3

    10

    Postal code of contact person

    b_country_code

    2

    2

    2-letter ISO-code of country. List of coutry ISO code can be found here

    private_person_flag

    1

    1

    This flag enables the privacy protection feature.

    RselnexusAppPurpose

    2

    2

    Domain usage area Allowed options:
    P1 - Commercial purpose
    P2 - Non commercial purpose
    P3 - Personal usage
    P4 - Educational purpose
    P5 - Government purpose

    RselnexusCategory

    3

    3

    Domain owner: Allowed options:
    C11 - Private individual, USA citizen
    C12 - Private individual, resident of USA
    C21 - A legal person or organization, incorporated in any US state
    C31 - A legal person or organization, legally operating in US
    C32 - A legal person or organization who ownes office or other real estate in US

    pro_profession

    1

    100

    Profession of domain owner Allowed options:

  • Acupuncturists
  • Allied Health Professionals
  • Ambulance Services
  • Architects
  • Asbestos Removal Professionals
  • Barbers and Barber Shops
  • Certified Financial Analysts
  • Certified Financial Planners
  • Certified Public Accountants
  • Check Cashers
  • Chiropractors
  • Contractors, Home Improvement
  • Cosmetologists and Aestheticians
  • Debt Collectors
  • Dentists and Dental Hygienists
  • Dieticians and Nutritionists
  • Doctors
  • Educators
  • Electricians
  • Electrologists
  • Emergency Medical Technician
  • Engineers and Land Surveyors
  • Finance Companies
  • Financial Professional
  • Funeral Services
  • Health Care
  • Hearing Instrument Specialists
  • Home Inspectors
  • HVAC Technicians
  • Insurance
  • Investment Advisors
  • Landscape Architects
  • Lawyers
  • Lead Paint Inspectors
  • Manufactured Building Producers
  • Massage Therapy
  • Money Transmitters
  • Mortgage Lenders and Brokers
  • Municipal Building Inspectors
  • Nurses and Nurse Aides
  • Nursing Home Administrators
  • Nutritionists
  • Opticians
  • Optometrists
  • Perfusionist
  • Pharmacists
  • Physical Therapists
  • Physician Assistants
  • Physicians
  • Plumbers and Gas Fitters
  • Podiatrists
  • Psychologists
  • Public Relations
  • Radio and TV Technicians
  • Real Estate
  • Real Estate Appraisers
  • Respiratory Therapists
  • Sanitarians
  • Social Workers
  • Speech Pathologists and Audiologists
  • Veterinarians
  • Water Plant Operator
  • X-Ray Technicians
  • Internet Professional
  • Medical Professional
  • Legal Professional
  • Other
  • idnumber

    3

    100

    Unified registration number

    vatid

    3

    100

    VAT ID

    registrant_type

    10

    12

    Type of registrant. Allowed options:
    individual
    organization

    Additional fields for registration in .САЙТ and .ОНЛАЙН

    Additional fileds should have only сyrillic characters, 4 contact types are required: admin, owner, billing and tech.

    Contact type is defined by initial prefix: a, t, o, b

    Contact fields ( administration contact example )

    Parameter Min length Max length Description

    a_first_name_r

    2

    25

    First name

    a_last_name_r

    2

    25

    Last name

    a_company_r

    5

    255

    Organization

    a_city_r

    3

    80

    City

    a_addr_r

    15

    255

    Address

    Domain DNS servers

    Required at least 2 DNS servers.

    Parameter Min length Max length Description

    ns0

    6

    80

    Primary DNS server.

    ns1

    6

    80

    Secondary DNS server.

    ns2

    6

    80

    Third DNS server.

    ns3

    6

    80

    Fourth DNS server.

    ns0ip

    8

    15

    Specify the IP-address of Primary name server hostname (only if hostname is based on the domain name). Optional.

    ns1ip

    8

    15

    Specify the IP-address of Secondary name server hostname (only if hostname is based on the domain name). Optional.

    ns2ip

    8

    15

    Specify the IP-address of Third name server hostname (only if hostname is based on the domain name). Optional.

    ns3ip

    8

    15

    Specify the IP-address of Fourth name server hostname (only if hostname is based on the domain name). Optional.

    Note: For the support of DNS you can use free REG.RU domains. For this, define ns1.reg.ru and ns2.reg.ru as DNS servers. Your domain zone will be registered on these servers. You will be able to manage the zone through the reg.ru site web interface.

    Support of processing of the list of services:

    VIP clients only.

    Support of unicode-domains

    Many TLDs support registration of domain names which consist of the big list of different languages and symbols

    .SU supports Armenian, Greek, Georgian and other languages, the complete list of all symbols is available at registry website.

    .САЙТ and .ОНЛАЙН support symbols of the Ukrainian, Belarusian and Bulgarian languages.

    .UA and *.UA TLDs support Ukrainian symbols and other Cyrillic symbols. The complete list of symbols is available at cctld ua and uanic.

    Verisign maintains .COM, .NET and other TLDs. All of them support registration of domain names in European languages, Cyrillic, Chinese, Korean, Japanese hieroglyphs, Arab, Thai and other languages. The complete list of symbols is available here.

    The comlete list of all symbols for domains in TLDs maintained by CentralNic is available at registry website. Choose the language, see the list of TLDs in which this language is supported.

    The complete list of languages for .INFO, .ORG TLDs is available at IANA website.

    Requests for registration of domains can be made both in Unicode and in punycode. If our system does not accept any symbol in a domain name kindly check the language with the registry before raising the issue.

    Response fields:
    Field Description

    bill_id

    Identifier of the invoice created upon the request..

    payment

    Order amount in roubles.

    pay_type

    Payment method. Currently, the only supported method is prepayment (“prepay”).

    pay_notes

    Notes pertaining to the payment method.

    domains

    The list of domains with the following fields: dname — domain name, result — the field of results, service_id — internal domain ID, if the application is successful. The field result can have the following values:
    success — registration order accepted;
    Invalid TLD — error in the name of the domain zone;
    Registraion in this TLD unavailable — domain registration in this zone is not available yet;
    Invalid punycode input — a error in the punycode;
    Domain_name is invalid or unsupported zone — an error in the domain name or unsupported zone;
    Unavailable domain name — this domain name is not available for registration.

    Examples of requests:

    Ordering a .ru domain using a request in the “PLAIN” format:

    Please note that if your library/program does not ensure full data conversion, the «+» symbol should be transferred as «%2B». Below is an example of a similar request in the JSON format. For clarity, at first transferred data is presented as a Perl structure.

    
    $jsondata = {
        contacts => {
            descr => 'Vschizh site',
            person => 'Svyatoslav V Ryurik',
            person_r => 'Рюрик Святослав Владимирович',
            passport => '22 44 668800, выдан по месту правления 01.09.1164',
            birth_date => '01.01.1101',
            p_addr => '12345, г. Вщиж, ул. Княжеска, д.1, Рюрику Святославу Владимировичу, князю Вщижскому',
            phone => '+7 495 1234567',
            e_mail => 'test@test.ru',
            country => 'RU',
        },
        nss => {
            ns0 => 'ns1.reg.ru',
            ns1 => 'ns2.reg.ru',
        },
        domain_name => 'vschizh.su',
    };
    
    $jsondata = JSON::XS->new->utf8->encode( $jsondata );
    
    

    The request will look as follows:

    A similar example, but it is assumed that contact data is stored the profile my_like_ru_profile:

    
    $jsondata = {
        profile_type => 'RU.PP',
        profile_name => 'my_like_ru_profile',
        nss => {
            ns0 => 'ns1.reg.ru',
            ns1 => 'ns2.reg.ru',
        },
        domain_name => 'vschizh.su',
    };
    
    $jsondata = JSON::XS->new->utf8->encode( $jsondata );
    
    

    The request will look as follows:

    similar to the first example but bulk request:

    
    $jsondata = {
        contacts => {
            descr => 'Vschizh site',
            person => 'Svyatoslav V Ryurik',
            person_r => 'Рюрик Святослав Владимирович',
            passport => '22 44 668800, выдан по месту правления 01.09.1164',
            birth_date => '01.01.1101',
            p_addr => '12345, г. Вщиж, ул. Княжеска, д.1, Рюрику Святославу Владимировичу, князю Вщижскому',
            phone => '+7 495 8102233',
            e_mail => 'test@test.ru',
            country => 'RU',
        },
        nss => {
            ns0 => 'ns1.reg.ru',
            ns1 => 'ns2.reg.ru',
        },
        domains => [
            { dname => 'vschizh.ru', srv_certificate => 'free', srv_parking => 'free' },
            { dname => 'vschizh.su', srv_webfwd => '' },
        ],
    };
    
    $jsondata = JSON::XS->new->utf8->encode( $jsondata );
    
    

    The request will look as follows:

    Example of a request for create domains in .МОСКВА и .MOSCOW zones:
    {
       "input_format" : "json",
       "username" : "test",
       "password" : "test",
       "input_data" : {
          "output_content_type" : "plain",
          "io_encoding" : "utf8",
          "show_input_params" : 1,
          "lang" : "en",
          "output_format" : "json",
          "contacts" : {
             "o_first_name_ru" : "Иван",
             "a_first_name_ru" : "Иван",
             "t_code" : "6663058366",
             "t_first_name" : "Ivan",
             "o_patronimic" : "Ivanovich",
             "t_phone" : "+7.953535385",
             "t_first_name_ru" : "Иван",
             "o_l_state" : "Moscow",
             "t_city" : "Moscow",
             "o_state" : "Moscow",
             "a_last_name_ru" : "Иванов",
             "o_addr" : "Bolshoy sobachiy, 33",
             "a_addr_ru" : "Большой собачий переулок, 33",
             "o_l_state_ru" : "Москва",
             "o_company_ru" : "ООО \"Лунтик\"",
             "t_patronimic" : "Ivanovich",
             "t_last_name_ru" : "Иванов",
             "a_l_city_ru" : "Москва",
             "a_city_ru" : "Москва",
             "o_l_city" : "Moscow",
             "o_first_name" : "Ivan",
             "a_state" : "Moscow",
             "o_l_city_ru" : "Москва",
             "t_country_code" : "RU",
             "t_addr_ru" : "Большой собачий переулок, 33",
             "a_company_ru" : "ООО \"Лунтик\"",
             "t_email" : "srs-devel@reg.ru",
             "a_l_state" : "Moscow",
             "o_patronimic_ru" : "Иванович",
             "t_company_ru" : "ООО \"Лунтик\"",
             "o_code" : "6663058366",
             "a_l_city" : "Moscow",
             "a_l_addr" : "Bolshoy sobachiy, 33",
             "t_patronimic_ru" : "Иванович",
             "o_phone" : "+7.953535385",
             "a_company" : "Luntik, LLC",
             "o_email" : "srs-devel@reg.ru",
             "o_addr_ru" : "Большой собачий переулок, 33",
             "o_last_name_ru" : "Иванов",
             "t_l_postcode" : "191000",
             "a_postcode" : "191000",
             "a_addr" : "Bolshoy sobachiy, 33",
             "t_l_city" : "Moscow",
             "a_phone" : "+7.953535385",
             "a_patronimic_ru" : "Иванович",
             "a_first_name" : "Ivan",
             "t_l_city_ru" : "Москва",
             "t_state_ru" : "Москва",
             "a_city" : "Moscow",
             "o_company" : "Luntik, LLC",
             "o_city_ru" : "Москва",
             "o_l_addr" : "Bolshoy sobachiy, 33",
             "o_l_postcode" : "191000",
             "o_last_name" : "Ivanoww",
             "a_country_code" : "RU",
             "a_l_state_ru" : "Москва",
             "a_patronimic" : "Ivanovich",
             "t_state" : "Moscow",
             "t_last_name" : "Ivanoww",
             "o_country_code" : "RU",
             "t_l_addr_ru" : "Большой собачий переулок, 33",
             "a_email" : "srs-devel@reg.ru",
             "o_city" : "Moscow",
             "a_code" : "6663058366",
             "t_l_state" : "Moscow",
             "o_state_ru" : "Москва",
             "t_addr" : "Bolshoy sobachiy, 33",
             "t_company" : "Luntik, LLC",
             "a_state_ru" : "Москва",
             "t_l_addr" : "Bolshoy sobachiy, 33",
             "t_city_ru" : "Москва",
             "t_postcode" : "191000",
             "a_l_addr_ru" : "Большой собачий переулок, 33",
             "t_l_state_ru" : "Москва",
             "o_l_addr_ru" : "Большой собачий переулок, 33",
             "a_last_name" : "Ivanoww",
             "a_l_postcode" : "191000",
             "o_postcode" : "191000"
          },
          "nss" : {
             "ns1" : "ns2.reg.ru",
             "ns0" : "ns1.reg.ru"
          },
          "domains" : [
             {
                "dname" : "белыйторшер.москва"
             },
             {
                "dname" : "whitelamp.moscow"
             }
          ]
       }
    }
    
    Example of a request for create domains in .САЙТ и .ОНЛАЙН zones:
    {
       "input_format" : "json",
       "username" : "test",
       "password" : "test",
       "input_data" : {
          "io_encoding" : "utf8",
          "output_content_type" : "plain",
          "lang" : "en",
          "show_input_params" : 1,
          "domains" : [
             {
                "dname" : "белыйторшер.онлайн"
             },
             {
                "dname" : "белыйторшер.сайт"
             }
          ],
          "contacts" : {
             "b_fax" : "+7.953535385",
             "a_addr_r" : "Большой собачий переулок, 33",
             "t_addr" : "Bolshoy sobachiy, 33",
             "t_last_name_r" : "Иванов",
             "a_state" : "Moscow",
             "o_fax" : "+7.953535385",
             "a_company_r" : "ООО \"Лунтик\"",
             "o_company_r" : "ООО \"Лунтик\"",
             "o_postcode" : "91000",
             "t_phone" : "+7.953535385",
             "a_fax" : "+7.953535385",
             "o_addr" : "Bolshoy sobachiy, 33",
             "b_last_name_r" : "Иванов",
             "o_first_name_r" : "Иван",
             "a_email" : "srs-devel@reg.ru",
             "a_addr" : "Bolshoy sobachiy, 33",
             "t_company" : "Luntik, LLC",
             "b_phone" : "+7.953535385",
             "o_company" : "Luntik, LLC",
             "o_city" : "Moscow",
             "b_first_name" : "Ivan",
             "b_addr_r" : "Большой собачий переулок, 33",
             "t_city" : "Moscow",
             "b_state" : "Moscow",
             "o_last_name_r" : "Иванов",
             "a_postcode" : "91000",
             "t_first_name" : "Ivan",
             "t_state" : "Moscow",
             "b_state_r" : "Москва",
             "t_email" : "srs-devel@reg.ru",
             "a_country_code" : "RU",
             "o_phone" : "+7.953535385",
             "t_company_r" : "ООО \"Лунтик\"",
             "a_city" : "Moscow",
             "t_country_code" : "RU",
             "b_last_name" : "Ivanoww",
             "a_phone" : "+7.953535385",
             "t_postcode" : "91000",
             "b_first_name_r" : "Иван",
             "a_last_name_r" : "Иванов",
             "t_state_r" : "Москва",
             "t_last_name" : "Ivanoww",
             "a_city_r" : "Москва",
             "a_state_r" : "Москва",
             "b_addr" : "Bolshoy sobachiy, 33",
             "a_first_name_r" : "Иван",
             "b_company" : "Luntik, LLC",
             "o_city_r" : "Москва",
             "o_last_name" : "Ivanoww",
             "b_country_code" : "RU",
             "a_company" : "Luntik, LLC",
             "b_email" : "srs-devel@reg.ru",
             "a_last_name" : "Ivanoww",
             "t_addr_r" : "Большой собачий переулок, 33",
             "b_city" : "Moscow",
             "o_state" : "Moscow",
             "o_first_name" : "Ivan",
             "b_company_r" : "ООО \"Лунтик\"",
             "t_city_r" : "Москва",
             "t_fax" : "+7.953535385",
             "o_state_r" : "Москва",
             "o_addr_r" : "Большой собачий переулок, 33",
             "b_postcode" : "91000",
             "o_country_code" : "RU",
             "o_email" : "srs-devel@reg.ru",
             "a_first_name" : "Ivan",
             "b_city_r" : "Москва",
             "t_first_name_r" : "Иван"
          },
          "nss" : {
             "ns0" : "ns1.reg.ru",
             "ns1" : "ns2.reg.ru"
          },
          "output_format" : "json"
       }
    }
    
    Examples of successful responses:

    A response to the first request (the request in the “PLAIN” format):

    {
       "answer" : {
          "bill_id" : "1234",
          "domains" : [
             {
                "dname" : "vschizh.ru",
                "result" : "success",
                "service_id" : "12345"
             }
          ],
          "pay_notes" : "Amount successfully charged",
          "pay_type" : "prepay",
          "payment" : "600"
       },
       "result" : "success"
    }
    
    

    A response to the second request (the request in the JSON format):

    {
       "answer" : {
          "bill_id" : "1234",
          "domains" : [
             {
                "dname" : "vschizh.su",
                "result" : "success",
                "service_id" : "12345"
             }
          ],
          "pay_notes" : "Amount successfully charged",
          "pay_type" : "prepay",
          "payment" : "600"
       },
       "result" : "success"
    }
    
    

    A response to the third request (the bulk request in the JSON format):

    {
       "answer" : {
          "bill_id" : "1234",
          "domains" : [
             {
                "dname" : "vschizh.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "vschizh.su",
                "result" : "success",
                "service_id" : "12346"
             }
          ],
          "pay_notes" : "Amount successfully charged",
          "pay_type" : "prepay",
          "payment" : "1300"
       },
       "result" : "success"
    }
    
    
    Possible errors:

    See the list of common error codes

    8.8. Function: domain/transfer

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    With the help of this function you can apply for a transfer of a domain from another registrar

    Request fields:

    The same fields as of the domain/create function. For the domains of the .RU / .SU / .РФ zones there is no need to define the domain owner and DNS server data, i.e. you can leave the fields and empty. These data will be automatically obtained from the registry upon the domain transfer. Also, for the domains of the .RU / .SU / .РФ zones the field can take the value “0” (domain transfer without renewal). For the most part of international domains (.com, .net, .org, .info, .biz, .mobi, .name, .asia, .tel, .in, .mn, .bz, .cc, .tv, .us, .me, .cn, .nz, .co, .ca, etc.) you should define.

    Parameter Min length Max length Description

    authinfo

    5

    48

    Authentication key for domain transfer (applicable to international domains). The key should be obtained from the previous domain registrar. For .RU/.РФ zones min_length is 6 signs

    Contact data for .RU/.SU/.РФ domains

    It will be used for a dataful check which were entered in the registry by the current registrar

    Contact data for Private Person only
    Parameter Min length Max length Description

    person_r

    9

    64

    First name, first letter of patronymic (without point) and last name of domain administrator in russian language, according to passport.
    For non-residents this field contains name in native language or in english transliteration. Example: Василий Николаевич Пупкин Example2: John Smith

    birth_date

    10

    10

    The birth date of domain administrator in DD.MM.YYYY format.
    Example: 07.11.1917

    passport

    20

    255
    multi-
    line

    The serie, number, issuer and issue date of passport.
    Date format: DD.MM.YYYY
    For non-residents its possible to use another document, drivers' licence for example. In this case document type should be stated in the first line. Field could be multiline. Example: 32 02 651241 выдан 48 о/м г.Москвы 26.12.1990 Example2: driver's licence\n AA 1234 BB John Smith

    p_addr

    15

    255
    multi-
    line

    The postal address of domain administrator in russian language. Could be multiline.
    Example: 101000, Москва, ул.Пупкина, 1, стр. 2, отдел мебели, офис 433 (для В. Лоханкина)

    country

    2

    2

    2-letter ISO-code of country.
    Example: RU

    Contact data for organization only
    Parameter Min length Max length Description

    org_r

    10

    255
    multi-
    line

    Full organization name in russian language - domain administrator, according to constituent documents. For non-residents filled in native or english language.Could be multiline.
    Example: Общество с ограниченной ответственностью "Рога и Копыта" Example2: Общество с ограниченной ответственностью "Рога и Копыта"

    code

    10

    10

    Organization INN code (for Russian organizations) - domain administrator.
    Could be empty, if domain administrator is non-resident of Russia and have no INN code. Example: 7701107259

    country

    2

    2

    2-letter ISO-code of country where company is registered.
    Example: RU

    Response fields:

    Similar to the domain/create

    Example of a request:
    Possible errors:
    Error_code error_text
    AUTHINFO_NOT_FOUND
    Transfer secretkey not found
    INVALID_AUTHINFO
    Inadmissible chars in authinfo

    And also see the list of common error codes

    8.9. Function: domain/get_transfer_status

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation::

    check of a status of transfer of domains, works only for zones in which REG.RU is a registrar, the status in other zones watch in whois

    Request fields:

    common service identification parameters and service list identification parameters.

    Response fields:
    Field Description

    domains

    The array with list of hashes containing names of domains dname and their status.

    status

    Status of transfer, possible answers: pendingPayment — the order waits for payment, transfer didn't begin still; pendingConfirmation — transfer confirmation is required; authinfoError — the incorrect key of transfer, is required the correct key; clientTransferProhibited — the current registrar locked transfer of the domain; transferProhibited — the domain has the status locking transfer; transferError — some other error of transfer; pendingTransfer — the pending transfer of the domain; alreadyTransfered — the domain is already transferred; notAvailable — the status isn't available.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "ya.ru",
                "error_code" : "DOMAIN_NOT_FOUND",
                "error_params" : {
                   "domain_name" : "ya.ru"
                },
                "error_text" : "Domain ya.ru not found or not owned by You",
                "result" : "error"
             },
             {
                "dname" : "qwerty.ooo",
                "result" : "success",
                "service_id" : "12345",
                "status" : "notAvailable"
             },
             {
                "dname" : "я.com",
                "result" : "success",
                "service_id" : "12346",
                "status" : "pendingTransfer"
             },
             {
                "dname" : "zzz.рф",
                "error_code" : "INVALID_DOMAIN_NAME_FORMAT",
                "error_params" : {
                   "domain_name" : "zzz.xn--p1ai"
                },
                "error_text" : "domain_name is invalid or unsupported zone",
                "result" : "error"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    8.10. Function: domain/set_new_authinfo

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    change of an incorrect domain transfer key (authinfo), available before request info registry only

    Request fields:
    Parameter Min length Max length Description

    authinfo

    5

    32

    domain transfer key, for .RU/.РФ tlds min_length is 6 signs

    And see common service identification parameters

    Response fields:

    no

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "dname" : "test.com",
          "service_id" : "12345"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    AUTHINFO_NOT_FOUND
    Transfer secretkey not found
    INVALID_AUTHINFO
    Inadmissible chars in authinfo
    WAITING
    Service already ordered but not processed.
    NOT_A_TRANSFER_ORDER
    Domain was created on your account without transfer

    See the list of common error codes

    8.11. Function: domain/get_rereg_data

    Accessibility:
    Partners
    Support of service list:
    No
    Designation:

    Use this function to get a list of “to be released” domains and their details. The data is updated every 90 minutes.

    Request fields:
    Parameter Description

    domains

    A list of domains

    dname_matching

    Search patter of domain name

    search_query

    Searches

    max_chars

    The maximum number of characters in domain

    min_pr

    The minimum value of Google PR

    min_cy

    The minimum value of Yandex CY

    kley

    1 - show only those domains where the mirror not detected

    zone

    Domain zone (ru, su, рф)

    views

    Page views per month

    vis

    The number of unique visitors per month

    traf

    Search traffic

    price

    Maximum current price

    registrar

    Registrar

    delete_date

    Delete day

    sortcol

    Sort by: name - by name, price - by blitz price, fdate - by first create date, date - by delete date, pr - by Google PR, cy - by Yandex CY, views - by page views per month, vis - by unique visitors per month, sch - by search traffic for the entire period, reg - by registrator

    premium

    1 - show only premium domains

    limit

    Description

    limit_from

    The position (record) from which data will be transferred upon request. Default value: 0.

    Click here to download the full list of “to- be-released” domains in a single CSV file.

    Response fields:
    Field Description

    dname

    Domain name

    tld

    Domain zone

    first_create_date

    First create date

    delete_date

    Delete date

    start_price

    Min price (for large customers)

    bid

    Last bid (for large customers)

    price

    Max price

    uni_avg_attendance

    Average daily number of visitors

    avg_viewings

    Average dialy number of views

    all_avg_traffic

    Average daily traffic

    search_query_list

    List of search queries

    yandex_tic

    Yandex TIC

    tic_mirrors

    Mirrors of Yandex TIC

    google_pr

    Google Page Rank

    registrar

    Registrar

    is_recommended

    Premium domain

  • Additional response fields are available for users, who have 256 or more active domains on the account. Recalculation of active domains performs once a month in automatic mode.
  • Example of a request:
    Example of a successful response:
    {
       "answer" : [
          {
             "dname" : "test.ru",
             "tld" : "ru",
             "yandex_tic" : "1000",
             "tic_mirrors" : "null",
             "uni_avg_attendance" : "100",
             "search_query_list" : "слово дело",
             "start_price" : "2500.00",
             "bid" : "2500.00",
             "avg_viewings" : "2",
             "google_pr" : "9",
             "price" : "2500.00",
             "blitz_price" : "2500.00",
             "first_create_date" : "2001-01-01",
             "delete_date" : "2020-01-01",
             "is_recommended" : "1",
             "all_avg_traffic" : "3"
             "registrar" : "REGRU-RU"
          },
          {
             "dname" : "test.su",
             "tld" : "su",
             "yandex_tic" : "0",
             "tic_mirrors" : "www.test.su",
             "uni_avg_attendance" : "0",
             "search_query_list" : null,
             "start_price" : "600.00",
             "bid" : "600.00",
             "avg_viewings" : "0",
             "google_pr" : "0",
             "price" : "600.00",
             "blitz_price" : "2500.00",
             "first_create_date" : "1991-08-21",
             "delete_date" : "2020-01-01",
             "is_recommended" : "0",
             "all_avg_traffic" : "0"
             "registrar" : "REGRU-RU"
          }
       ],
       "result" : "success"
    }
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    8.12. Function: domain/set_rereg_bids

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Use this function to place bids for “to be released” domains.

    Data are updated around 8:00. In update time order of bids is blocked for 10-20 minutes, it depends on the amount of updating, at the same time CREATION_IS_TEMPORARILY_LOCKED error code comes back,

    See here for details.

    Accessibility notes

    REG.RU Company’s partners can make an advance payment in the amount of 225 rub. and to pay the balance upon the successful fulfillment of the application for registration within 10 days of its execution (see the instalment parameter below). In case of choosing this payment procedure the domain will be registered in REG.RU, and after payment of the full amount it will be re-registered automatically on the specified data. In case of payment violation of the full amount by the due date, the pre-payment will be considered as firfeit and will not be refunded. See more information Clauses 2.16, 2.17, 3.2.9, 6.11 of the agreement

    Request fields:
    Parameter Description

    contacts

    A hash of contact data. For the description of contact data, which is the hash key, see the section describing the domain/create function.

    nss

    A hash of NS-servers. For the description of the NS servers’ format, which is the hash key, see the section describing the domain/create function.

    domains

    An array with the list of domains. Each array element is a hash with dname keys – domain name and price/bid for the domain. The order by instalments is accessible for resellers, key instalment, available parameters is 0 and 1, in this case it is possible to establish automatic payment after domain activation in the presence of money on the account, autopay key, possible values is 0 and 1.

    Response fields:
    Field Description

    bill_id

    ID of the invoice generated upon request.

    payment

    Order amount in roubles.

    pay_type

    Payment method. Currently, the only supported method is prepayment (prepay).

    pay_notes

    Notes pertaining to the payment method.

    domains

    A list of domains with results for each domain. The field of results can include the following values:
    success — the bid has been placed;
    invalid domain zone — you cannot order “to be released” domains in this zone;
    domain not found — this domain is beyond reg.ru competence;
    rereg not found — the domain was not found in the list of accessible “to be released” domains;
    invalid bid — invalid bid;
    more bid found — the same or a bigger bid found.

    Example of a request:

    An example of transferred data (a Perl structure converted into the JSON format):

        $jsondata = {
            contacts => {
                descr      => 'Vschizh site',
                person     => 'Svyatoslav V Ryurik',
                person_r   => 'Рюрик Святослав Владимирович',
                passport   => '22 44 668800, выдан по месту правления 01.09.1164',
                birth_date => '01.01.1101',
                p_addr     => '12345, г. Вщиж, ул. Княжеска, д.1, Рюрику Святославу Владимировичу, князю Вщижскому',
                phone      => '+7 495 1234567',
                e_mail     => 'test@test.ru',
                country    => 'RU',
            },
            nss => {
                ns0 => 'ns1.reg.ru',
                ns1 => 'ns2.reg.ru',
            },
            domains => [
                { dname => 'vschizh.ru', price => 225 },
                # or order by instalments: { dname => 'vschizh.ru', price => 2500, instalment => 1 },
                { dname => 'vschizh.su', price => 400 },
            ],
        };
    
        $jsondata = JSON::XS->new->utf8->encode( $jsondata );
    

    The query:

    An example with the same data but with the use of wget for a post-request (the parameter --post-data) and response output into the console:

    wget -O - https://api.reg.ru/api/regru2/domain/set_rereg_bids --post-data='username=test&password=test&input_format=json&\
    input_data={"contacts":{"country":"RU","e_mail":"test@test.ru","person_r":"Рюрик Святослав Владимирович","phone":"%2B7 495 1234567","birth_date":"01.01.1101", \
    "descr":"Vschizh site","person":"Svyatoslav V Ryurik","p_addr":"12345, г. Вщиж, ул. Княжеска, д.1, Рюрику Святославу Владимировичу, князю Вщижскому",\
    "passport":"22 44 668800, выдан по месту правления 01.01.1164"},"domains":[{"dname":"vschizh.ru","price":225},{"dname":"vschizh.su","price":400}],\
    "nss":{"ns0":"ns1.reg.ru","ns1":"ns2.reg.ru"}}'
    
    

    Please note that if your library/program does not ensure full data conversion, the «+» symbol should be transferred as «%2B».

    Example of a successful response:

    A response to the wget request:

    {
       "answer" : {
          "bill_id" : "1234",
          "domains" : [
             {
                "dname" : "vschizh.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "vschizh.su",
                "result" : "success",
                "service_id" : "12346"
             }
          ],
          "pay_notes" : "Amount successfully charged",
          "pay_type" : "prepay",
          "payment" : "625"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    CONTACTS_NOT_FOUND
    Contacts list not found
    INVALID_CONTACTS
    Contacts user data is invalid
    UNKNOWN_CONTYPE
    Can't guess registrant type: person or organization
    DOMAINS_NOT_FOUND
    Domains list not found
    REREG_NOT_FOUND
    Domain $domain_name in expiring list not found
    INVALID_BID
    Invalid bid
    SAME_OR_MORE_BID_FOUND
    The same or big rate is found
    YOUR_SAME_OR_MORE_BID_FOUND
    Your same or big rate is found
    CREATION_IS_TEMPORARILY_LOCKED
    Orders on create services is temporarily locked

    And also see the list of common error codes

    8.13. Function: domain/get_user_rereg_bids

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    Use this function to get the list with information about bids placed on them. The list also includes domains with overbids.

    Request fields:

    no

    Response fields:
    Field Description

    dname

    Domain name.

    tld

    Domain zone.

    is_active

    The lot is available for auction.

    is_recommended

    Premium domain.

    uni_avg_attendance

    Average daily number of vistiros.

    avg_viewings

    Average dialy nuber of views.

    all_avg_traffic

    Average daily traffic.

    search_query_list

    List of search queries.

    first_creation_date

    Date of the first domain registration according to statonline.ru.

    delete_date

    Date of deletion from the registry

    yandex_tic

    Yandex TIC.

    google_pr

    Google Page Rank

    registrar

    Registrar currently managing the domain.

    user_bid

    Your latest bid.

    max_bid

    The maximum bid currently placed on this domain. If the lot is still available, you can overbid it. It does not matter who placed the previous bid.

    next_price

    Minimum size of the next bid. NULL means that the lot is inactive.

    blitz_price

    Maximum bid. When reached, the domain is withdrawn from the auction (is_active = 0), but it will be included into the list until the domain is released by the registry.

    rereg_bids

    The list of all allowed bids for each domain zone (for referential use).

    Example of a request:
    Example of a successful response:
    
    {
        answer => {
            domains => [
                {
                    delete_date        => '2099-12-31',
                    yandex_tic         => null,
                    max_bid            => 225.00,
                    next_price         => 590.00,
                    uni_avg_attendance => null,
                    blitz_price        => 8000.00,
                    user_bid           => 225.00,
                    search_query_list  => null,
                    tld                => 'ru',
                    dname              => 'test.ru',
                    registrar          => 'REGRU',
                    is_active          => 1,
                    avg_viewings       => null,
                    first_create_date  => '2000-01-01',
                    google_pr          => null,
                    is_recommended     => 1,
                    all_avg_traffic    => null
                },
                {
                    delete_date        => '2099-01-01',
                    yandex_tic         => 2000,
                    max_bid            => 5000.00,
                    next_price         => null,
                    uni_avg_attendance => null,
                    blitz_price        => 5000.00,
                    user_bid           => 5000.00,
                    search_query_list  => null,
                    tld                => 'su',
                    dname              => 'test.su',
                    registrar          => 'REGRU',
                    is_active          => 0,
                    avg_viewings       => null,
                    first_create_date  => '2001-01-01',
                    google_pr          => 9,
                    is_recommended     => 1,
                    all_avg_traffic    => null
                }
            ],
            rereg_bids => {
                рф => [ 0, 225, 590, 750, 2500, 5000, 8000 ],
                su => [ 0, 400, 590, 750, 2500, 5000, 8000 ],
                ru => [ 0, 225, 590, 750, 2500, 5000, 8000 ]
            }
        },
        result => 'success'
    }
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    8.14. Function: domain/get_docs_upload_uri

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    Use this function to get a hyperlink for uploading documents on .RU/.SU/.РФ domains.

    Request fields:

    Common domain identification fields.

    Response fields:
    Field Description

    docs_upload_sid

    Uploaded document ID.

    url

    An URL for uploading of the document, includes the docs_upload_sid identifier.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "docs_upload_sid" : "123456",
          "url" : "http://www.reg.ru/user/docs/add?userdoc_secretkey=123456"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    CANT_GET_DOCS_UPLOAD_SID
    Can't get documents upload sid.

    And also see the list of common error codes

    8.15. Function: domain/update_contacts

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    With the help of this function you can make changes in the domain contact data.

    Request fields:
    Parameter Description

    contacts

    A hash of contact data. For details about contact data, which is the hash key, refer to the section describing the domain/create function. The field is used in JSON and XML requests only

    domains

    An array with a list of domains. Each array element is a hash with the dname (domain name) or service_id key. The domains in the list must be of the same type: i.e. belong to the same domain zone or one of the groups below:
    – .ru, .su and the contact data type is “person”;
    – .ru, .su and thecontact data type is “org”;
    – .com.ua, .kiev.ua;
    – .com, .net, .org, .biz, .info, .name, .mobi.
    The field is used in JSON and XML requests only.

    payout_agreement

    The client's consent to withdraw funds from account to cover expenses. Applies for domain zones with chargable updating of the contact details for domain. At the moment, only for MD domain zone in which the operation on updating the contact details will be charged at 4800 RUR. For the EU zone a domain name renewal for 1 year required.

    Response fields:
    Field Description

    domains

    A list of domains with the parameters dname, service_id and/or error_code.

    Example of a request:

    Single-domain request

    A request with a list of domains

    Example of a successful response:
    
    {
        answer => {
            domains => [
                {
                    dname      => 'vschizh.ru',
                    service_id => '12345',
                    result     => 'success'
                },
                {
                    dname      => 'vschizh.su',
                    service_id => '12346',
                    result     => 'success'
                }
            ],
       },
      result => 'success'
    }
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    INCOMPATIBLE_CONTYPES
    Incompatible .ru/.su/.рф domain contypes
    INCOMPATIBLE_ZONES
    Incompatible domain zones
    PP_UPDATE_FAIL
    Update Private Person is fail: $error_detail

    And also see the list of common error codes

    8.16. Function: domain/update_private_person_flag

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Use this function to change settings of the Private Person and Total Private Person flags (show/hide contact data in WHOIS)

    Request fields:
    Parameter Available values Description

    private_person_flag

    0 and 1

    Disables/enables the feature of partial hiding of personal data. Valid values: 0 and 1.

    as well as the standard fields to identify the domain list

    Response fields:
    Field Description

    domains

    A list of domains with the parameters dname, service_id and/or error_code.

    pp_flag

    Use this function to change settings of the Private Person and Total Private Person flags (show/hide contact data in WHOIS)

    Example of a request:
    Example of a successful response:
    {
      answer => {
          domains => [
              {
                  dname      => 'vschizh.ru',
                  service_id => '12345',
                  result     => 'success'
              },
              {
                  dname      => 'vschizh.su',
                  service_id => '12346',
                  result     => 'success'
              }
          ],
          pp_flag => 'is set'
      }
      result => 'success'
    }
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    8.17. Function: domain/register_ns

    Accessibility:
    Everyone
    Support of service list:
    No
    Designation:

    Domain registration in the NSI registry (for internatonal domains only).

    Request fields:
    Parameter Description

    domain_name

    The domain, whose nameserver will be added.

    ns0

    nameserver

    ns0ip

    IP address of the nameserver being added.

    Response fields:
    Field Description

    resp

    A detailed response from the NSI registry, typically a hash. Available in sussessful resposnses only.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "resp" : {
             "actionstatus" : "success",
             "actionstatusdesc" : "Addition Completed Successfully",
             "actiontype" : "AddCns",
             "actiontypedesc" : "Addition of Child Nameserver ns0.test.com with IP [1.2.3.4]",
             "description" : "test.com",
             "status" : "success"
          }
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    8.18. Function: domain/delete_ns

    Accessibility:
    Everyone
    Support of service list:
    No
    Designation:

    Deletion of a domain from the NSI registry (for international domains only).

    Request fields:
    Parameter Description

    domain_name

    The domain whose nameserver will be deleted.

    ns0

    nameserver

    ns0ip

    The domain whose nameserver will be deleted.

    Response fields:
    Field Description

    resp

    A detailed response from the NSI registry, typically a hash. Available in sussessful resposnses only.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "resp" : {
             "actionstatus" : "success",
             "actionstatusdesc" : "Modification Completed Successfully",
             "actiontype" : "DelCnsIp",
             "actiontypedesc" : "Deletion of IP Address [1.2.3.4] from Child Nameserver ns0.test.com",
             "description" : "test.com",
             "status" : "success"
          }
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    8.19. Function: domain/get_nss

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    You can use this function to get DNSs for domains.

    Request fields:

    Common service identification parameters ,

    Common service list identification parameters

    Response fields:
    Field Description

    domains

    A list of domains with the parameters dname, service_id and/or an error_code.

    nss

    A list of DNSs with the ns and ip parameters.

    Example of a request:

    Single domain

    Several domains

    Examples of a successful response:
    {
        answer => {
            domains => [
                {
                    dname      => 'test.ru',
                    nss        => [
                        {
                            ns => 'ns1.reg.ru'
                        },
                        {
                            ns => 'ns2.reg.ru'
                        }
                    ],
                    service_id => 12345
                }
            ]
        },
        result => 'success'
    }
    
    {
        answer => {
            domains => [
                {
                    dname      => 'test.ru',
                    nss        => [
                        {
                            ns => 'ns1.reg.ru'
                        },
                        {
                            ns => 'ns2.reg.ru'
                        }
                    ],
                    service_id => 12345
                },
                {
                    dname      => 'test.su',
                    nss        => [
                        {
                            ns => 'ns1.reg.ru'
                        },
                        {
                            ns => 'ns2.reg.ru'
                        }
                    ],
                    service_id => 12346
                }
            ]
        },
        result => 'success'
    }
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    8.20. Function: domain/update_nss

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Use this function to change DNS servers of the domain. Also this function enables/disables domain delegation (for partners only).

    Request fields:
    Parameter Description

    domain_name

    Domain name.

    ns0...ns3

    DNS server names ordered by priority.

    ns0ip...ns3ip

    IP addresses of DNS servers. Optional fields. To be used only when the name of the DNS server includes the name of the domain being registered.
    For some areas are allowed to specify more than one IP address for the DNS server. List of IP addresses can be passed as a single string with separator ',' or as an array.

    nss

    A hash of NS servers and, if necessary, IP addresses. The fields ns0...ns3 and ns0ip...ns3ip described above will serve as hash keys. This field can be used in the JSON and XML requests only.

    undelegate

    Use this function to enable or suspend domain delegation. 0 — Delegate, 1 — Suspend delegation.

    payout_agreement

    The client's consent to withdraw funds from account to cover expenses. Applies for domain zones with chargable updating of the nameservers for domain. At the moment, only for MD domain zone in which the operation on updating the DNS servers will be charged at 4800 RUR.

    See also service list identification parameters .

    Note:

    To ensure the DNS support, you can use free REG.RU servers. For this, define and as DNS servers. Your domain zone will be registered on these servers. You will be able to manage the zone through the reg.ru site web interface or via API.

    Response fields:
    Field Description

    domains

    A list of domains with the parameters dname, service_id and/or a service identification error_code.

    Example of a request:

    Single-domain DNS changes. PLAIN:

    JSON:

    Multiple-domain DNS changes. The request includes an invalid domain name (see the reposnse below) data.

    Suspension of domain delegation without NS servers’ transfer.

    Examples of successful responses:

    Single-domain changes

    {
        answer => {
            domains => [
                {
                    dname      => 'test.ru',
                    service_id => 12345,
                    result     => 'success'
                }
            ]
        },
        result => 'success'
    }
    

    Multiple-domain changes (the reponse to the request with invalid data):

    {
        answer => {
            domains => [
                {
                    dname      => 'test.ru',
                    service_id => 12345,
                    result     => 'success'
                },
                {
                    dname      => 'test.su',
                    service_id => 12346,
                    result     => 'success'
                },
                {
                    dname      => '----.ru',
                    result     => 'domain_name is invalid or unsupported zone',
                    error_code => 'INVALID_DOMAIN_NAME_FORMAT'
                }
            ]
        },
        result => 'success'
    }
    

    A successful response to the request to suspend domain delegation (see above)

    {
        answer     => {
            services => [
                {
                    dname      => 'test.ru',
                    service_id => 12345,
                    result     => 'success'
                }
            ]
        },
        result     => 'success',
    }
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    INVALID_NSS
    Invalid name servers
    UNDELEGATION_NOT_SUPPORTED_BY_TLD
    Delegation/undelegation is not supported in this tld
    UNDELEGATION_NOT_SUPPORTED_BY_DOMAIN_STATE
    Delegation/undelegation locked. Contact technical support for more information.

    And also see the list of common error codes

    8.21. Function: domain/delegate

    Accessibility:
    Partners
    Support of service list:
    Yes
    Designation:

    Use this this function to set the domain delegation flag.

    Request fields:

    Common service identification parameters ,

    Common service list identification parameters

    Response fields:
    Field Description

    services

    A list of services with the parameters dname, service_id or a service identification error_code.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.su",
                "result" : "success",
                "service_id" : "12346"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    8.22. Function: domain/undelegate

    Accessibility:
    Partners
    Support of service list:
    Yes
    Designation:

    Use this flag to clear the domain delegation flag.

    Request fields:

    Common service identification parameters ,

    Common service list identification parameters

    Response fields:
    Field Description

    services

    A list of services with the parameters dname, service_id or a service identification error_code.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.su",
                "result" : "success",
                "service_id" : "12346"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    8.23. Function: domain/transfer_to_another_account

    Accessibility:
    Partners
    Support of service list:
    Yes
    Designation:

    Full transfer of a domain to another account.

    Request fields:
    Parameter Description

    new_user_name

    The login name of the client to whom the domains are transferred.

    set_me_as_referrer

    Use this field to make youself a referrer of the transferred domain (for details, see the Referral Program). Vaild values: 0 and 1.

    As well as common service identification parameters .

    Response fields:
    Field Description

    domains

    A list of domains transferred to another account. In case of success, the field “result” there will be the “request_is_sent” value for each domain in the “result” field, otherwise an error code will be returned.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "request_is_sent",
                "service_id" : "12345"
             },
             {
                "dname" : "test.su",
                "error_code" : "NOT_TRANSFERED_DOMAIN_STATUS",
                "service_id" : "12346"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    OPERATION_FOR_SERVISE_OWNER_ONLY
    Only owner can have access to this function
    NOT_TRANSFERED_DOMAIN_STATUS
    The status of the domain doesn't admit transfer, probably at first it is necessary to prolong the domain
    TRANSFER_DELAY
    The domain cannot be transferred still. Perhaps, term did not end after the previous transfer or change of the owner

    And also see the list of common error codes

    8.24. Function: domain/look_at_entering_list

    Accessibility:
    Partners
    Support of service list:
    Yes
    Designation:

    Use this function to view the list of domains transferred to this account.

    Request fields:

    no

    Response fields:
    Field Description

    messages

    A list of messages about domain transfer. Each message contains an ID and the name of the transferred domain. Upon each transfer domains are assigned new IDs.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "messages" : [
             {
                "domain_name" : "test.ru",
                "id" : "123456"
             },
             {
                "domain_name" : "test.su",
                "id" : "123457"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    8.25. Function: domain/accept_or_refuse_entering_list

    Accessibility:
    Partners
    Support of service list:
    Yes
    Designation:

    Accept or decline domains transferred to this account.

    Request fields:
    Parameter Description

    domain_name

    Name of the transferred domain.

    id

    ID of the domain transfer message. To get an ID, use the domain/look_at_entering_list function.

    action_type

    Use this field to define what should be done with a domain: “accept” or “refuse”. The following values are also allowed: yes/no, 1/ 0.

    Response fields:
    Field Description

    domains

    A list of domains with results for each domain.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "action_type" : "accept",
                "domain_name" : "test.ru",
                "id" : "123456",
                "result" : "accepted"
             }
          ]
       },
       "result" : "success"
    }
    
    
    {
        answer => {
            domains => [
                {
                    domain_name => 'test.ru',
                    id          => 123456,
                    action_type => 'accept',
                    result      => 'accepted'
                },
            ]
        },
        result => 'success'
    }
    
    
    {
        answer => {
            domains => [
                {
                    domain_name => 'test.ru',
                    id          => 123456,
                    action_type => 'yes',
                    result      => 'accepted'
                },
                {
                    domain_name => 'test.su',
                    id          => 123457
                    action_type => 'refuse',
                    result      => 'refused'
                },
                {
                    domain_name  => 'test.com',
                    id           => 123458
                    action_type  => 'xxx',
                    result       => 'action_type has incorrect format or data',
                    error_params => {
                        param => 'action_type'
                    },
                    error_code  => 'PARAMETER_INCORRECT'
                }
            ]
        },
        result => 'success'
    }
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    8.26. Function: domain/request_to_transfer

    Accessibility:
    Partners with plan Partner 2 or higher
    Support of service list:
    No
    Designation:

    Send request to domain transfer

    Request fields:
    Parameter Description

    domain_name

    Domain name, the field is incompatible with the “domains” list

    domains

    An array with a lsit of domain name alternatives. Each array element is a hash with the dname or domain_name key. The field can be used in JSON and XML requests only.

    Response fields:
    Field Description

    domains

    A list of domains with results for each domain.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "reg.ru",
                "result" : "success",
                "service_id" : "123"
             },
             {
                "dname" : "test0.ru",
                "error_code" : "BELONGS_TO_ANOTHER_REGISTRAR",
                "error_params" : {
                   "domain_name" : "test0.ru"
                },
                "result" : "Domain is belong to another registrar"
             },
             {
                "dname" : "test1.ru",
                "error_code" : "CHECK_DOMAIN_ERROR",
                "error_params" : {
                   "domain_name" : "test1.ru"
                },
                "result" : "Transfer is not possible"
             },
             {
                "dname" : "test2.ru",
                "error_code" : "FREE_DOMAIN",
                "error_params" : {
                   "domain_name" : "test2.ru"
                },
                "result" : "Free domain"
             },
             {
                "dname" : "test3.ru",
                "error_code" : "INCORRECT_DOMAIN_OWNER_SERVICE_PLAN",
                "error_params" : {
                   "domain_name" : "test3.ru"
                },
                "result" : "Domain owner has incorrect service plan or not partner"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    INCORRECT_DOMAIN_OWNER_SERVICE_PLAN
    Domain owner has incorrect service plan or not partner
    BELONGS_TO_ANOTHER_REGISTRAR
    Domain is belong to another registrar
    FREE_DOMAIN
    Free domain
    CHECK_DOMAIN_ERROR
    Transfer is not possible
    NO_DOMAINS_TO_TRANSFER
    Not available to transfer domains
    BAD_SERVICE_PLAN
    Incorrect partner service plan
    REQUEST_TO_TRANSFER_DISABLED
    You are not allowed to use request to transfer

    And also see the list of common error codes

    8.27. Function: domain/get_tld_info

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Request for information about the zone

    Request fields:
    Parameter Description

    tld

    Zone name

    And also: Common service identification parameters, Common service list identification parameters

    Response fields:
    Field Description

    tld

    Zone name

    email_verification

    Needed of email verification, 1 -- needed, 0 -- not required

    idn_allowed

    Enable/disable IDN. 1 -- IDN enable, 0 -- IDN disable

    max_dname_length

    The maximum length of a domain name

    min_dname_length

    The minimum length of a domain name

    min_nss_count

    The minimum permitted number of DNS-servers

    max_nss_count

    The maximum permitted number of DNS-servers

    privacy_protection_allowed

    Is it permitted to privacy protection

    regperiods

    registration periods

    reject_days_of_renew_after_create

    The number of days from the date of registration of the domain for which the extension is forbidden

    renew_grace_period_before_expdate

    The number of days for the extension before expiration_date

    renew_grace_period_after_expdate

    The number of days for the extension after expiration_date

    renewperiods

    Extension periods

    restoration_grace_period

    Number of days to recover from expiration_date + renew_grace_period_after_expdate

    Example of a request:
    Examples of a successful response:
    {
       answer => {
          tld_info => {
             email_verification                => '0',
             idn_allowed                       => '0',
             max_dname_length                  => '63',
             max_nss_count                     => '13',
             min_dname_length                  => '2',
             min_nss_count                     => '0',
             privacy_protection_allowed        => '0',
             regperiods                        => '1',
             reject_days_of_renew_after_create => '0',
             renew_grace_period_after_expdate  => '31',
             renew_grace_period_before_expdate => '60',
             renewperiods                      => '1',
             restoration_grace_period          => '0',
             tld                               => 'ru'
          }
       },
       charset => 'utf-8',
       messagestore => null,
       result => 'success'
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    NO_TLD
    tld not given or empty
    UNAVAILABLE_DOMAIN_ZONE
    $tld is unavailable domain zone

    See the list of common error codes

    8.28. Function: domain/send_email_verification_letter

    Accessibility:
    Partners
    Support of service list:
    Yes
    Designation:

    Sending letters requesting gtld domain verification confirmation mail and checking email to accredited zones

    Request fields:
    Parameter Description

    dname

    Domain name

    check_only

    Flag prohibit send letters only need to check the confirmation email to the zone

    And also: Common service identification parameters, Common service list identification parameters

    Response fields:
    Field Description

    status

    ALREADY_VERIFIED -- zone must be confirmed by email, email for the domain is already confirmed

    status

    NOT_VERIFIED -- zone must be confirmed by email, but the email for the domain has not been confirmed

    status

    SENT -- zone must be confirmed by email, confirmation email already sent

    status

    NOT_REQUIRED -- zone email confirmation is not required

    Example of a request:

    Request for information about the need to confirm the email and sending email to verify

    Request for information about the need to confirm the email without sending email to verify

    Examples of a successful response:
    {
        answer => {
           status => 'ALREADY_VERIFIED'
        },
        charset => 'utf-8',
        messagestore => null,
        result => 'success'
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    9. DNS management functions (the category «zone»)

    9.1. Function: zone/nop

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    This function serves for testing purposes. You can check if you can manage DNS zones of domains. DNS zone management is possible only with domains associated with REG.RU DNS servers.

    Request fields:

    Common service identification parameters. ,

    Service list identification parameters

    Response fields:
    Field Description

    domains

    A list of domains. Domains that allow DNS zone management will have the “success” value in the “result” field, otherwise the “result” field will feature an error code explaining the error reason.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "result" : "success",
                "service_id" : "12346"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    9.2. Function: zone/add_alias

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Use this function to tie subdomains to IP addresses.

    Request fields:
    Parameter Description

    subdomain

    Name of the subdomain assigned an IP address. To assign an IP address to a domain, transfer the “@” value. To assign an IP address to all subdomains, which are not explicitly defined in other records, use the “*” value.

    ipaddr

    IP address assigned to the subdomain.

    See also common service identification parameters and service list identification parameters .

    Response fields:
    Field Description

    domains

    A list of domains with results.

    Example of a request:

    Assign the IP address 111.111.111.111 to the domains test.ru and test.com.

    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "result" : "success",
                "service_id" : "12346"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    9.3. Function: zone/add_aaaa

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Use this function to tie subdomains to IPv6 addresses.

    Request fields:
    Parameter Description

    subdomain

    Name of the subdomain assigned an IPv6 address. To assign an IP address to a domain, transfer th “@” value. To assign an IP address to all subdomains, which are not explicitly defined in other records, use the “*” value.

    ipaddr

    The IPv6 address assigned to the subdomain.

    See also common service identification parameters and service list identification parameters .

    Response fields:
    Field Description

    domains

    A list of domains with results.

    Example of a request:

    Assign the IPv6 address 111.111.111.111 to the domains test.ru and test.com.

    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "result" : "success",
                "service_id" : "12346"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    9.4. Function: zone/add_caa

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    specify rules for SSL certificate issue

    Request fields:
    Parameter Description

    subdomain

    subdomain name for the rule

    flags

    Flags for rule as number: 0 or 128

    tag

    Tag for rule. One of: isssue, issuewild, iodef

    value

    Record value depends on specified tag: for "issue" and "issuewild" - domain name of certification authority, which is allowed to issue certificate for subdomain; for "iodef" - email or http(s) URL, which will be used by certification authority to send information about certificate issue requests conflicts while checking CAA records

    See also common service identification parameters and service list identification parameters

    Response fields:
    Field Description

    domains

    A list of domains with results.

    Example of a request:

    Allow ca.example.com certification authority to issue wildcard-certificates for test.ru

    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    CAA_INVALID
    CAA record is incorrect
    FLAGS_INVALID
    flags field is incorrect
    TAG_INVALID
    tag field is incorrect

    And also see the list of common error codes

    9.5. Function: zone/add_cname

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Use this function to tie a subdomain to another’s domain IP address

    Request fields:
    Parameter Description

    subdomain

    Name of the subdomain assigned an IP address.

    canonical_name

    Name of the domain assigned a synonym.

    See also common service identification parameters and service list identification parameters .

    Response fields:
    Field Description

    domains

    A list of domains with results.

    Example of a request:

    Tie the third-level domains mail.test.ru and mail.test.com to mx10.test.ru.

    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "result" : "success",
                "service_id" : "12346"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    CNAME_INVALID
    Invalid CNAME
    CNAME_ANDOTHERDATA
    For this CNAME have other data already

    And also see the list of common error codes

    9.6. Function: zone/add_mx

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Use this function to define the IP address or domain name of the mail server, which will received email destined to your domain

    Request fields:
    Parameter Description

    subdomain

    Name of the subdomain, to which the address is assigned. The default value is “@”, i.e. the main domain.

    priority

    Mail server priority: from 0 (highest) through 10 (lowest)

    mail_server

    Domain name or IP address of the mail server (domain name is more preferable because not all mail servers admit IP addresses).

    See also common service identification parameters and service list identification parameters .

    Response fields:
    Field Description

    domains

    A list of domains with results.

    Example of a request:

    Tie the the domains test.ru and test.com to the mail servers mail.test.ru and mail.test.com

    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "result" : "success",
                "service_id" : "12346"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    MAILHOST_INVALID
    Error in mail_server IP address or domain name

    And also see the list of common error codes

    9.7. Function: zone/add_ns

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    You can use this function to hand over a subdomain to other DNS servers.

    Request fields:
    Parameter Description

    subdomain

    Name of the subdomain that will be handed over to other DNS servers.

    dns_server

    Domain name of the DNS-server.

    record_number

    Order number of the NS record that determines relative arrangement of NS records for the subdomain.

    See also common service identification parameters and service list identification parameters .

    Response fields:
    Field Description

    domains

    A list of domains with results.

    Example of a request:

    Hand over domains tt.test.ru and tt.test.com to the DNS server ns1.test.ru.

    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "result" : "success",
                "service_id" : "12346"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    NSADDR_INVALID
    Invalid DNS-server address

    And also see the list of common error codes

    9.8. Function: zone/add_txt

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Add an arbitrary note about the subdomain.

    Request fields:
    Parameter Description

    subdomain

    Name of the subdomain, about which the record is added.

    text

    Text of the note. Only ASCII alphanumeric characters are allowed.

    See also common service identification parameters and service list identification parameters .

    Response fields:
    Field Description

    domains

    A list of domains with results.

    Example of a request:

    Add notes about the mail.test.ru and mail.test.com domains.

    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "result" : "success",
                "service_id" : "12346"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    TEXT_NOT_FOUND
    Text for record not found
    TEXT_TOOLONG
    Text too long
    TEXT_CONTAINS_INVALID_CHARACTERS
    Text contains invalid characters

    And also see the list of common error codes

    9.9. Function: zone/add_srv

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Add service record

    Request fields:
    Parameter Description

    service

    The service that will be matched against the defined server. For example, to make the sip.test.ru server handle SIP calls over UDP, you should specify the following string: sip.udp.

    priority

    Record priority.

    weight

    The load that the servers can handle. Optional field. Default value: 0.

    target

    The server used by the service.

    port

    The port used by the service.

    See also common service identification parameters and service list identification parameters .

    Response fields:
    Field Description

    domains

    A list of domains with results.

    Example of a request:

    Make the sip.test.ru server handle SIP calls destined to xxx@test.ru and xxx@test.com on port 5060 over UDP.

    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "result" : "success",
                "service_id" : "12346"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    SERVICE_INVALID
    Service not found or have incorrect data
    PRIORITY_INVALID
    Priority not found or have not digital data
    WEIGHT_INVALID
    Weight have not digital data
    PORT_INVALID
    Port not found or have not digital data

    And also see the list of common error codes

    9.10. Function: zone/get_resource_records

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Use this fuction to get zone resource records for each domains.

    Request fields:

    common service identification parameters and service list identification parameters .

    Response fields:
    Field Description

    domains

    A list of domains, where domains that allow zone management will have the “success” value in the “result” field. Otherwise the “result” field will include the error code explaining the reason of error.

    rrs

    Domain resource records.

    subname

    The name of the subdomain, for which the resource record is created. Use “*” for all subdomains except for those explicitly specified; “@” for the main domain or specify the exact name of the subdomain.

    rectype

    The type/class of the record: A, AAAA, CNAME, MX, NS, etc.

    state

    The status of the record: A — active (deprecated and exists for backward compatibility reason only).

    priority

    The priority of the record.

    content

    The content of the record: an IP address for А records, an IPv6 address for АААА records, etc.

    soa

    Zone cache TTL

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "rrs" : [
                   {
                      "content" : "111.222.111.222",
                      "prio" : "0",
                      "rectype" : "A",
                      "state" : "A",
                      "subname" : "www"
                   }
                ],
                "service_id" : "12345",
                "soa" : {
                   "minimum_ttl" : "12h",
                   "ttl" : "1d"
                }
             },
             {
                "dname" : "test.com",
                "result" : "success",
                "rrs" : [
                   {
                      "content" : "111.222.111.222",
                      "prio" : "0",
                      "rectype" : "A",
                      "state" : "A",
                      "subname" : "www"
                   }
                ],
                "service_id" : "12346",
                "soa" : {
                   "minimum_ttl" : "12h",
                   "ttl" : "1d"
                }
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    INVALID_ZONE_RECORD_TYPE
    Zone record type is invalid

    And also see the list of common error codes

    9.11. Function: zone/update_records

    Accessibility:
    Partners
    Support of service list:
    Yes
    Designation:

    You can use this function to add and/or delete several resource records by means of a single request. The order of elements in the transferred array is important. Records can interrelate with each other, and if an error is found in one of the records from the action_list fields, the rest of the records will be ignored.

    Request fields:
    Parameter Description

    action_list

    A hash array, where every hash provides parameters for creation/deletion of a resource record. The class/type of the created records is defined in the “action” field, allowed values are: add_alias, add_aaaa, add_caa, add_cname, add_mx, add_ns, add_txt, add_srv, add_spf, remove_record. The rest of hash fields depend on the “action” value and correspond to the functions add_alias, add_aaaa, remove_record etc. which are described below.
    For the example given below the structure of action_list will look as follows:

    
    action_list => [
        {
            action          => 'add_alias',
            subdomain       => 'www',
            ipaddr          => '11.22.33.44'
        },
        {
            action          => 'add_cname',
            subdomain       => '@',
            canonical_name  => 'www.test.ru'
        },
        {
            action          => 'remove_record',
            subdomain       => 'mail',
            record_type     => 'MX',
            priority        => '10',
            content         => 'mail-relay.example.com'
        }
    ]
    
    
    The action_list array can be both common for the whole domain list (see Example 1), and individual for each domain in the list (see Example 2).

    See also common service identification parameters and service list identification parameters .

    Response fields:
    Field Description

    domains

    A list of domains with results.

    Example of a request:

    Tie the IP address 11.22.33.44 to the www.test.ru domain and assign the test.ru alias to it.

    The same task, but the request is arranged as a list and there is an error in the name of the first action.

    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    INVALID_ACTION
    Action is invalid or not found: $action

    And also see the list of common error codes

    9.12. Function: zone/update_soa

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    You can use this function to change a zone cache TTL.

    Request fields:
    Parameter Description

    ttl

    Cache TTL of a zone. Valid values: a number for seconds or a number with a suffix (m – for months, w – for weeks, d – for days, h – for hours). Example: 600 (seconds), 5m (months).

    minimum_ttl

    Cache TTL for negative responses. The format is the same as for the “ttl” field.

    See also common service identification parameters and service list identification parameters .

    Response fields:
    Field Description

    domains

    A list of domains with results.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "result" : "success",
                "service_id" : "12346"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    SOA_RECORD_INVALID
    Invalid time for SOA record

    And also see the list of common error codes

    9.13. Function: zone/tune_forwarding

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Use this function to add resource records required for web forwarding.

    Request fields:

    common service identification parameters and service list identification parameters .

    Response fields:
    Field Description

    domains

    A list of domains with results.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "result" : "success",
                "service_id" : "12346"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    9.14. Function: zone/clear_forwarding

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Use this function to delete resource records required for web forwarding.

    Request fields:

    common service identification parameters and service list identification parameters .

    Response fields:
    Field Description

    domains

    A list of domains with results.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "result" : "success",
                "service_id" : "12346"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    9.15. Function: zone/tune_parking

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Use this function to add resource records required for domain parking.

    Request fields:

    common service identification parameters and service list identification parameters .

    Response fields:
    Field Description

    domains

    A list of domains with results.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "result" : "success",
                "service_id" : "12346"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    9.16. Function: zone/clear_parking

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Use this function to delete resource records required for domain parking.

    Request fields:

    common service identification parameters and service list identification parameters .

    Response fields:
    Field Description

    domains

    A list of domains with results.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "result" : "success",
                "service_id" : "12346"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    9.17. Function: zone/remove_record

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Use this function to delete resource records.

    Request fields:
    Parameter Description

    subdomain

    The subdomain for which the resource record will be deleted.

    record_type

    The class/type of the deleted record. Mandatory field.

    priority

    Optional field. Default value: 0. Not applicable to the request for removal of an A-record (and similar records)

    content

    The content of the record. Optional field. If it is not available, all records satisfying the settings of the rest of parameters will be deleted.

    See also common service identification parameters and service list identification parameters .

    Response fields:
    Field Description

    domains

    A list of domains with results.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "result" : "success",
                "service_id" : "12346"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:
    Error_code error_text
    INVALID_ZONE_RECORD_TYPE
    Zone record type is invalid

    And also see the list of common error codes

    9.18. Function: zone/clear

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Delete all resource records.

    Request fields:

    common service identification parameters and service list identification parameters .

    Response fields:
    Field Description

    domains

    A list of domains with results.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "result" : "success",
                "service_id" : "12346"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    10. DNSSEC management functions

    10.1. Function: dnssec/nop

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    This function serves for testing purposes. You can check if you can manage DNSSEC of domains

    Request fields:

    common service identification parameters, service list identification parameters

    Response fields:
    Field Description

    domains

    A list of domains. Domains that allow DNSSEC management will have the “success” value in the “result” field, otherwise the “result” field will feature an error code explaining the error reason.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.net",
                "domain_name" : "test.net",
                "error_params" : null,
                "error_text" : "This domain doesn't support DNSSEC",
                "result" : "error"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    10.2. Function: dnssec/get_status

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Gets DNSSEC status for domain.

    Request fields:

    common service identification parameters, service list identification parameters

    Response fields:
    Field Description

    domains

    A list of domains with results

    status

    DNSSEC status for domain, one of: enabled, disabled, updating (DNSSEC updating in progress)

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345",
                "status" : "enabled"
             },
             {
                "dname" : "test.com",
                "result" : "success",
                "service_id" : "6789",
                "status" : "updating"
             },
             {
                "dname" : "test.net",
                "error_params" : {
                   "domain_name" : "test.net"
                },
                "error_text" : "This domain doesn't support DNSSEC",
                "result" : "error"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    10.3. Function: dnssec/enable

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Enables DNSSEC for domain, that uses REG.RU nameservers. Later you can use get_status function to check that operation finished successfully.

    Request fields:

    common service identification parameters, service list identification parameters

    Response fields:
    Field Description

    domains

    A list of domains with results

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "error_params" : {
                   "domain_name" : "test.com"
                },
                "error_text" : "DNSSEC updating for domain already in progress",
                "result" : "error"
             },
             {
                "dname" : "test.net",
                "error_params" : {
                   "domain_name" : "test.net"
                },
                "error_text" : "This domain not use REG.RU name services",
                "result" : "error"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    10.4. Function: dnssec/disable

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Disables DNSSEC for domain, that uses REG.RU nameservers. Later you can use get_status function to check that operation finished successfully.

    Request fields:

    common service identification parameters, service list identification parameters

    Response fields:
    Field Description

    domains

    A list of domains with results

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "error_params" : {
                   "domain_name" : "test.com"
                },
                "error_text" : "DNSSEC updating for domain already in progress",
                "result" : "error"
             },
             {
                "dname" : "test.net",
                "error_params" : {
                   "domain_name" : "test.net"
                },
                "error_text" : "This domain not use REG.RU name services",
                "result" : "error"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    10.5. Function: dnssec/renew_ksk

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Regenerates and updates KSK key for domain, that uses REG.RU nameservers. Later you can use get_status function to check that operation finished successfully.

    Request fields:

    common service identification parameters, service list identification parameters

    Response fields:
    Field Description

    domains

    A list of domains with results

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "error_params" : {
                   "domain_name" : "test.com"
                },
                "error_text" : "DNSSEC updating for domain already in progress",
                "result" : "error"
             },
             {
                "dname" : "test.net",
                "domain_name" : "test.net",
                "error_params" : null,
                "error_text" : "This domain not use REG.RU name services",
                "result" : "error"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    10.6. Function: dnssec/renew_zsk

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Regenerates and updates ZSK key for domain, that uses REG.RU nameservers. Later you can use get_status function to check that operation finished successfully.

    Request fields:

    common service identification parameters, service list identification parameters

    Response fields:
    Field Description

    domains

    A list of domains with results

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "error_params" : {
                   "domain_name" : "test.com"
                },
                "error_text" : "DNSSEC updating for domain already in progress",
                "result" : "error"
             },
             {
                "dname" : "test.net",
                "domain_name" : "test.net",
                "error_params" : null,
                "error_text" : "This domain not use REG.RU name services",
                "result" : "error"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    10.7. Function: dnssec/get_records

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Gets list of DNSSEC records of a domain. These are DNSKEY and DS records for domains those use REG.RU nameservers. For other domains it will return DNSSEC records from the parent zone.

    Request fields:

    common service identification parameters, service list identification parameters

    Response fields:
    Field Description

    domains

    A list of domains with results

    records

    A list of DNSSEC records

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "records" : [
                   {
                      "DNSKEY" : "test.ru. IN DNSKEY 256 3 13 CPaFmHh6q/b1zQbXp4w8J3sXUp+YK6BfxzSam/qgps/i5JSiXSQ4kD5v433qdnbnocSyZIDw9EqiAQUbVE/M4g=="
                   },
                   {
                      "DNSKEY" : "test.ru. IN DNSKEY 257 3 13 X2ehOZBEVxU6baEa58fQx/6Y+gckDeq85XGFW8o6jWFB19wtv6aqdc8ycpIrQaZ4bSLYM7ZyLPJtP6UOkzslDg==",
                      "DS" : "test.ru. IN DS 55528 13 2 cbb775347bdbdff6e1d832595df06add7e610732db131c0f5d3d295e85ae0bef"
                   }
                ],
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "records" : [
                   {
                      "alg" : "13",
                      "digest" : "17F3E3F4E7FD813432C8E989BD74728BFE9BCA6B518BE2F1155D9EA352067997",
                      "digtype" : "2",
                      "keytag" : "2371"
                   }
                ],
                "result" : "success",
                "service_id" : "6789"
             },
             {
                "dname" : "test.net",
                "domain_name" : "test.net",
                "error_params" : null,
                "error_text" : "This domain doesn't support DNSSEC",
                "result" : "error"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    10.8. Function: dnssec/add_keys

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    Adds information about KSK keys to the parent zone. Can be used only for domains which don't use REG.RU nameservers. Later you can use get_status, get_records functions to check that operation finished successfully.

    Request fields:
    Parameter Description

    records

    list of DNSKEY or DS records, will get records from authoritative DNS server if parameter missed

    See also common service identification parameters, service list identification parameters

    Response fields:
    Field Description

    domains

    A list of domains with results

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "domains" : [
             {
                "dname" : "test.ru",
                "result" : "success",
                "service_id" : "12345"
             },
             {
                "dname" : "test.com",
                "result" : "success",
                "service_id" : "6789"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    11. Hosting management functions (the category «hosting»)

    11.1. Function: hosting/nop

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    For testing purposes.

    Example of a request:
    Example of a successful response:
    {
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    11.2. Function: hosting/get_jelastic_refill_url

    Accessibility:
    Partners
    Support of service list:
    No
    Designation:

    View Jelastic URL

    Response fields:
    Field Description

    url

    URL for Jelastic account balance refill.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "url" : "https://test1.ru"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    11.3. Function: hosting/set_jelastic_refill_url

    Accessibility:
    Partners
    Support of service list:
    No
    Designation:

    Set Jelastic URL

    Request fields:
    Parameter Description

    url

    URL for the Jelastic account balance refill. You can use the keywords and , which will be replaced with the identifier of service for balance refill, and the email address used for the Jelastic account registration.

    Example of a request:
    Example of a successful response:
    {
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    11.4. Function: hosting/get_parallelswpb_constructor_url

    Accessibility:
    Clients
    Support of service list:
    No
    Designation:

    get URL to the ParallelsWPB constructor

    Request fields:
    Parameter Description

    service_id

    Numeric service identifier.

    Response fields:
    Field Description

    url

    URL for ParallelsWPB constructor.

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "url" : "https://test1.ru"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    11.5. Function: hosting/get_rs_themes

    Accessibility:
    Everyone
    Support of service list:
    No
    Designation:

    get available themes

    Request fields:
    Parameter Description

    servtype

    The type of the ordered service:: "srv_rs_joomla" или "srv_rs_wordpress"

    If this field is missing, all themes for all possible servtypes and subtypes will be exists in response

    subtype

    The rate plan.

    If this field is missing, all themes for all possible subtypes of specified servtype will be exists in response.

    Currently available rate plans for ready-made solutions, based on Joomla, are:
    corporate-0617
    eCommerce-0617

    Currently available rate plans for ready-made solutions, based on Wordpress, are
    blog-0617
    corporate-0617
    eCommerce-0617
    ecwid-0617
    portfolio-0617

    Response fields:
    Field Description

    img

    Index page preview (small size)

    img_big

    Index page preview (big size)

    link

    URL for online demo

    name

    The theme name used when ordering the ready-made solution

    text

    Theme description

    priority

    The priority of the theme in the resulting list

    title

    Theme title

    Example of a request:
    Example of a successful response:
    {
       "answer" : {
          "happy" : {
             "img" : "https://turnkey.reg.ru/screenshots/joomla/ru/corporate/happy/screenshot.jpg",
             "img_big" : "https://turnkey.reg.ru/screenshots/joomla/ru/corporate/happy/screenshot-big.jpg",
             "link" : "http://turnkey.reg.ru/joomla/happy",
             "name" : "happy",
             "priority" : "0",
             "text" : "Простой и лаконичный сайт компании, отзывы клиентов на главной странице, удобный раздел для описания услуг.",
             "title" : "Тема Happy"
          },
          "melano" : {
             "img" : "https://turnkey.reg.ru/screenshots/joomla/ru/corporate/melano/screenshot.jpg",
             "img_big" : "https://turnkey.reg.ru/screenshots/joomla/ru/corporate/melano/screenshot-big.jpg",
             "link" : "http://turnkey.reg.ru/joomla/melano",
             "name" : "melano",
             "priority" : "0",
             "text" : "Современный и стильный шаблон для корпоративного сайта в строгих тонах, продуманная главная страница, интерактивный баннер.",
             "title" : "Тема Melano"
          },
          "zone" : {
             "img" : "https://turnkey.reg.ru/screenshots/joomla/ru/corporate/zone/screenshot.jpg",
             "img_big" : "https://turnkey.reg.ru/screenshots/joomla/ru/corporate/zone/screenshot-big.jpg",
             "link" : "http://turnkey.reg.ru/joomla/zone",
             "name" : "zone",
             "priority" : "0",
             "text" : "Аккуратный и выверенный дизайн корпоративного сайта с поддержкой адаптивности, интерактивный баннер привлекает внимание посетителей.",
             "title" : "Тема Zone"
          }
       },
       "charset" : "utf-8",
       "messagestore" : null,
       "result" : "success"
    }
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    12. Folder management functions (the category «folder»)

    12.1. Function: folder/nop

    Accessibility:
    Everyone
    Support of service list:
    No
    Designation:

    You can use this test function to check the availability of folders.

    Request fields:
    Parameter Description

    folder_name or folder_id

    This field serves to identify the required folder (see the list of common folder identification parameters).

    Response fields:

    Common system responses

    Example of a request:

    Initialization with ID folder_id

    Initialization with name folder_name

    Example of a successful response:
    {
       "answer" : {
          "id" : "-1",
          "name" : "test_folder_name"
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    12.2. Function: folder/create

    Accessibility:
    Everyone
    Support of service list:
    No
    Designation:

    Creation of folders.

    Request fields:
    Parameter Description

    folder_name

    The name of the new folder.

    Response fields:

    Common system responses

    Example of a request:

    Creation of a folder with the name test_folder_name

    Example of a successful response:
    {
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    12.3. Function: folder/remove

    Accessibility:
    Everyone
    Support of service list:
    No
    Designation:

    Deletion of folders.

    Request fields:
    Parameter Description

    folder_name or folder_id

    This field serves to identify the required folder (see the list of common folder identification parameters).

    Response fields:

    Common system responses

    Example of a request:

    Removing from the folder with ID folder_id

    Removing from the folder with name folder_name

    Example of a successful response:
    {
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    12.4. Function: folder/rename

    Accessibility:
    Everyone
    Support of service list:
    No
    Designation:

    Use this function to rename folders.

    Request fields:
    Parameter Description

    folder_name or folder_id

    This field serves to identify the required folder (see the list of common folder identification parameters).

    new_folder_name

    This field defines the new folder name.

    Response fields:

    Common system responses.

    Example of a request:

    Rename the folder with ID folder_id

    Rename the folder with name folder_name

    Example of a successful response:
    {
       "answer" : {
          "folder_content" : [
             {
                "domain_name" : "test1.ru",
                "service_id" : "1000",
                "servtype" : "domain"
             },
             {
                "domain_name" : "test2.ru",
                "service_id" : "1001",
                "servtype" : "domain"
             }
          ]
       },
       "charset" : "utf-8",
       "messagestore" : "null",
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    12.5. Function: folder/get_services

    Accessibility:
    Everyone
    Support of service list:
    No
    Designation:

    Use this function to obtain the list of services available in the folder

    Request fields:

    Common folder identification parameters.

    Response fields:

    Common system responses

    Example of a request:

    Add a list of services (test1.ru, test2.ru) to the folder test_folder_name

    Add a list of services (с ID=1000, ID=1001) to the folder with ID 12345

    Example of a successful response:

    without the return_folder_content parameter

    
    "answer" => {
    "folder_content" => [
        {
    	"domain_name" => "test1.ru",
    	"service_id" => "1000",
    	"servtype" => "domain"
        },
        {
    	"domain_name" => "test2.ru",
    	"service_id" => "1001",
    	"servtype" => "domain"
        }
    ],
    "result" => "success"
    }
    
    

    with the parameter return_folder_content=1

    
    {
        "answer" : {
            "services" : [
                {
                    "dname" : "test01.ru",
                    "service_id" : "123456",
                    "servtype" : "domain",
                    "result" : "success"
                },
                {
                    "dname" : "test11.ru",
                    "result" : "Domain test11.ru not found or not owned by You",
                    "error_params" : {
                       "domain_name" : "test11.ru"
                    },
                    "error_code" : "DOMAIN_NOT_FOUND"
                }
            ],
            "folder_content" : [
                {
                    "domain_name" : "test1.ru",
                    "service_id" : "1000"
                },
                {
                    "domain_name" : "test2.ru",
                    "service_id" : "1001"
                }
            ]
        },
        "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    12.6. Function: folder/add_services

    Accessibility:
    Everyone
    Support of service list:
    Yes
    Designation:

    Use this function to add services to folders.

    Request fields:
    Parameter Description

    folder_name or folder_id

    Defines the name of the folder to which the services will be added.
    (see the list of common folder identification parameters).

    services

    Defines the list of required services to which the services will be added.
    (see the list of common folder identification parameters).

    return_folder_contents

    If this parameter is set to “1”, the response will include the list of services available in the folder to which the function will be applied.

    Response fields:

    Common system responses.

    Example of a request:

    Add a list of services (test1.ru, test2.ru) to the folder test_folder_name

    Add a list of services (с ID=1000, ID=1001) to the folder with ID 12345

    Example of a successful response:

    without the return_folder_content parameter

    {
       "answer" : {
          "services" : [
             {
                "dname" : "test1.ru",
                "result" : "success",
                "service_id" : "1000",
                "servtype" : "domain"
             },
             {
                "dname" : "test2.ru",
                "result" : "success",
                "service_id" : "1000",
                "servtype" : "domain"
             }
          ]
       },
       "result" : "success"
    }
    
    

    with the parameter return_folder_content=1

    {
       "answer" : {
          "folder_content" : [
             {
                "domain_name" : "test1.ru",
                "service_id" : "1000"
             },
             {
                "domain_name" : "test2.ru",
                "service_id" : "1001"
             }
          ],
          "services" : [
             {
                "dname" : "test01.ru",
                "result" : "success",
                "service_id" : "123456",
                "servtype" : "domain"
             },
             {
                "dname" : "test11.ru",
                "error_code" : "DOMAIN_NOT_FOUND",
                "error_params" : {
                   "domain_name" : "test11.ru"
                },
                "result" : "Domain test11.ru not found or not owned by You"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    12.7. Function: folder/remove_services

    Accessibility:
    Everyone
    Support of service list:
    Yes
    Designation:

    Use this function to delete services from folders.

    Request fields:
    Parameter Description

    folder_name or folder_id

    Defines the name of the folder откуда будут удалены услуги.
    (see the list of common folder identification parameters).

    services

    Defines the list of required services откуда будут удалены услуги.
    (see the list of common folder identification parameters).

    return_folder_contents

    If this parameter is set to “1”, the response will include the list of services available in the folder to which the function will be applied.

    Response fields:

    Common system responses

    Example of a request:

    Deletion a list of services (test1.ru, test2.ru) from folder test_folder_name

    Deletion a list of services (с ID=1000, ID=1001) from folder with ID 12345

    Example of a successful response:

    without the return_folder_content parameter

    {
       "answer" : {
          "services" : [
             {
                "dname" : "test1.ru",
                "result" : "success",
                "service_id" : "1000",
                "servtype" : "domain"
             },
             {
                "dname" : "test2.ru",
                "result" : "success",
                "service_id" : "1000",
                "servtype" : "domain"
             }
          ]
       },
       "result" : "success"
    }
    
    

    with the parameter return_folder_content=1

    {
       "answer" : {
          "folder_content" : [
             {
                "domain_name" : "test1.ru",
                "service_id" : "1000"
             },
             {
                "domain_name" : "test2.ru",
                "service_id" : "1001"
             }
          ],
          "services" : [
             {
                "dname" : "test01.ru",
                "result" : "success",
                "service_id" : "123456",
                "servtype" : "domain"
             },
             {
                "dname" : "test11.ru",
                "error_code" : "DOMAIN_NOT_FOUND",
                "error_params" : {
                   "domain_name" : "test11.ru"
                },
                "result" : "Domain test11.ru not found or not owned by You"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    12.8. Function: folder/replace_services

    Accessibility:
    Everyone
    Support of service list:
    Yes
    Designation:

    This function allows replacement of services already available in a folder with other services (deletes the service available in the folder and adds the services defined by the domain_name or service_id parameter)

    Request fields:
    Parameter Description

    folder_name or folder_id

    Defines the name of the folder target.
    (see the list of common folder identification parameters).

    services

    Defines the list of required services target.
    (see the list of common folder identification parameters).

    return_folder_contents

    If this parameter is set to “1”, the response will include the list of services available in the folder to which the function will be applied.

    Response fields:

    Common system responses

    Example of a request:

    replace a list of services (test1.ru, test2.ru) in folder test_folder_name

    replace a list of services (с ID=1000, ID=1001) in folder with ID 12345

    Example of a successful response:

    without the return_folder_content parameter

    {
       "answer" : {
          "services" : [
             {
                "dname" : "test1.ru",
                "result" : "success",
                "service_id" : "1000",
                "servtype" : "domain"
             },
             {
                "dname" : "test2.ru",
                "result" : "success",
                "service_id" : "1000",
                "servtype" : "domain"
             }
          ]
       },
       "result" : "success"
    }
    
    

    with the parameter return_folder_content=1

    {
       "answer" : {
          "folder_content" : [
             {
                "domain_name" : "test1.ru",
                "service_id" : "1000"
             },
             {
                "domain_name" : "test2.ru",
                "service_id" : "1001"
             }
          ],
          "services" : [
             {
                "dname" : "test01.ru",
                "result" : "success",
                "service_id" : "123456",
                "servtype" : "domain"
             },
             {
                "dname" : "test11.ru",
                "error_code" : "DOMAIN_NOT_FOUND",
                "error_params" : {
                   "domain_name" : "test11.ru"
                },
                "result" : "Domain test11.ru not found or not owned by You"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    12.9. Function: folder/move_services

    Accessibility:
    Everyone
    Support of service list:
    Yes
    Designation:

    Use this function to move service between folders

    Request fields:
    Parameter Description

    folder_name or folder_id

    Defines the name of the folder (source).
    (see the list of common folder identification parameters).

    new_folder_name or new_folder_id

    Defines the name of the target folder
    (see the list of common folder identification parameters).

    services

    Defines the list of required services (source).
    (see the list of common folder identification parameters).

    return_folder_contents

    If this parameter is set to “1”, the response will include the list of services available in the folder to which the function will be applied.

    Response fields:

    Common system responses.

    Example of a request:

    Move a list of services (test1.ru, test2.ru) from folder test_folder_name to folder new_test_folder_name

    Move a list of services (с ID=1000, ID=1001) из папки c ID 12345 в папку with ID 1234567

    Example of a successful response:

    without the return_folder_content parameter

    {
       "answer" : {
          "services" : [
             {
                "dname" : "test1.ru",
                "result" : "success",
                "service_id" : "1000",
                "servtype" : "domain"
             },
             {
                "dname" : "test2.ru",
                "result" : "success",
                "service_id" : "1000",
                "servtype" : "domain"
             }
          ]
       },
       "result" : "success"
    }
    
    

    with the parameter return_folder_content=1

    {
       "answer" : {
          "folder_content" : [
             {
                "domain_name" : "test1.ru",
                "service_id" : "1000"
             },
             {
                "domain_name" : "test2.ru",
                "service_id" : "1001"
             }
          ],
          "services" : [
             {
                "dname" : "test01.ru",
                "result" : "success",
                "service_id" : "123456",
                "servtype" : "domain"
             },
             {
                "dname" : "test11.ru",
                "error_code" : "DOMAIN_NOT_FOUND",
                "error_params" : {
                   "domain_name" : "test11.ru"
                },
                "result" : "Domain test11.ru not found or not owned by You"
             }
          ]
       },
       "result" : "success"
    }
    
    
    Code sample:
    Show sample
    Possible errors:

    See the list of common error codes

    13. Domain Shop management functions

    13.1. Function: shop/nop

    Accessibility:
    Clients
    Support of service list:
    Yes
    Designation:

    For testing purposes. Also, with the help of this function you can check accessibility of a lot and get its ID. For this, pass username+password+dname.

    Request fields:

    common domain identification parameters and

    Parameter Description

    dname

    domain name

    Response fields:
    Field Description

    lot_id

    lot identifier

    Example of a request:
    Example of a response:
    {
       "answer" : {
          "lot_id" : "123"
       },
       "result" : "success"
    }
    
    
    Possible errors:

    See the list of common error codes

    13.2. Function: shop/update_lot

    Accessibility:
    Everyone
    Designation:

    Update lot/lots

    Request fields:

    [common domain identification parameters] (#common_service_identification_params) and

    Parameter Description

    category_ids

    a list of category identifiers (1-3 values), see get_category_list function for values

    description

    the description of the lots

    keywords

    a list of keywords

    sold_with

    what is sold, possible values: "" or absent (only domain), "site" (domain and website), "tm" (domain name and trademark), "site, tm" (domain, website and brand )

    price

    domain price

    min_price

    minimal allowed bid for lot

    deny_bids_lower_rejected

    do not accept offers for a price lower than the rejected

    setup_parking_page

    activate "Showcase domain for Domain Shop"

    lot_price_type

    "fixed" (fixed price) or "offer" (free price)

    dname

    domains list for update

    Response fields:

    no

    Example of a request:
    Example of a response:
    {
       "result" : "success"
    }
    
    
    Possible errors:

    See the list of common error codes

    13.3. Function: shop/delete_lot

    Accessibility:
    Everyone
    Designation:

    delete lot/lots

    Request fields:

    common domain identification parameters и

    Parameter Description

    dname

    domain list

    Response fields:

    no

    Example of a request:
    Example of a response:
    {
       "result" : "success"
    }
    
    
    Possible errors:

    See the list of common error codes

    13.4. Function: shop/get_info

    Accessibility:
    Everyone
    Designation:

    obtain information on the lot

    Request fields:

    common domain identification parameters и

    Parameter Description

    dname

    domain name

    Response fields:
    Field Description

    dname

    domain name

    dname_puny

    punycode domain name

    price_type

    price type: "fixed" (fixed price) or "offer" (free price)

    start_price

    price

    site

    the flag that sold site also

    tm

    the flag that the brand sold also

    description

    description

    keywords

    keyword list

    category_ids

    category identifier list

    lot_hits

    lot view count

    bids_cnt

    lot bids/suggestions count

    first_create_domain

    first registration date

    creation_date

    registration date

    lot_date

    the date placed on sale

    yandex_tic

    Yandex тИц

    google_pr

    Google PageRank

    Example of a request:
    Example of a response:
    {
       "answer" : {
          "category_list" : [
             "1",
             "2",
             "3"
          ],
          "description" : "desc",
          "dname" : "test-shop-api-1.ru",
          "dname_puny" : "test-shop-api-1.ru",
          "keywords" : [
             "k1",
             "k2",
             "k3"
          ],
          "price_type" : "fixed",
          "site" : "1",
          "start_price" : "200.00",
          "tm" : "1"
       },
       "charset" : "utf-8",
       "messagestore" : "null",
       "result" : "success"
    }
    
    
    Possible errors:

    See the list of common error codes

    13.5. Function: shop/get_lot_list

    Accessibility:
    Everyone
    Designation:

    getting a list of lots

    Request fields:

    common domain identification parameters и

    Parameter Description

    pg

    what page to show, by default - 0

    itemsonpage

    how many items per page, by default - 25, possible values: 25, 50, 100, 200, 500

    sortcol

    : dname, dname_length, google_pr, yandex_tic, is_online, creation_date, lot_date, lot_hits, start_price, lot_mtime, first_create_domain, bids_cnt, keywords

    sortorder

    : ASC, DESC, by default - ASC

    keywords

    show_my_lots

    flag "Only my items" flag

    yandex_tic_from

    yandex_tic_to

    google_pr_from

    Google PageRank

    google_pr_to

    Google PageRank

    price_from

    price_to

    creation_date_from

    creation_date_to

    lot_date_from

    lot_date_to

    lot_mtime_from

    lot_mtime_to

    dname_length_from

    dname_length_to

    Response fields:
    Field Description

    lots_cnt

    lots

    bids_cnt

    category_ids

    creation_date

    dname

    dname_puny

    punycode

    first_create_domain

    google_pr

    Google PageRank

    is_online

    keywords

    lot_date

    lot_hits

    lot_mtime

    price_type

    site

    start_price

    tm

    yandex_tic

    Example of a request:
    Example of a response:
    {
       "answer" : {
          "lots" : [
             {
                "bids_cnt" : "0"
             },
             {
                "category_ids" : "[ 1, 2, 3 ]"
             },
             {
                "creation_date" : "2010-11-12"
             },
             {
                "dname" : "test-shop-api-1.ru"
             },
             {
                "dname_puny" : "test-shop-api-1.ru"
             },
             {
                "first_create_domain" : "2010-11-12"
             },
             {
                "google_pr" : "0"
             },
             {
                "is_online" : "1"
             },
             {
                "keywords" : "test, shop, api"
             },
             {
                "lot_date" : "2011-12-21 17:40:36"
             },
             {
                "lot_hits" : "null"
             },
             {
                "lot_mtime" : "2016-04-08 13:55:02"
             },
             {
                "price_type" : "fixed"
             },
             {
                "site" : "0"
             },
             {
                "start_price" : "3000.00"
             },
             {
                "tm" : "0"
             },
             {
                "yandex_tic" : "0"
             }
          ],
          "lots_cnt" : "1"
       },
       "result" : "success"
    }
    
    
    Possible errors:

    See the list of common error codes

    13.6. Function: shop/get_category_list

    Accessibility:
    Everyone
    Designation:

    getting a list of categories

    Request fields:

    common domain identification parameters

    Response fields:
    Field Description

    id

    category id

    category_name

    category name

    subcategories

    a list of subcategories, which contain elements: id, category_name

    Example of a request:
    Example of a response:
    {
       "answer" : {
          "category_list" : [
             {
                "category_name" : "Культура и искусство",
                "subcategories" : [
                   {
                      "category_name" : "Видео",
                      "id" : "4"
                   },
                   {
                      "category_name" : "Изобразительное искусство",
                      "id" : "6"
                   },
                   {
                      "category_name" : "Кино",
                      "id" : "10"
                   }
                ]
             },
             {
                "category_name" : "Бизнес",
                "subcategories" : [
                   {
                      "category_name" : "Бухгалтерское дело",
                      "id" : "32"
                   },
                   {
                      "category_name" : "Горное дело и бурение",
                      "id" : "34"
                   },
                   {
                      "category_name" : "Издательство и полиграфия",
                      "id" : "40"
                   }
                ]
             },
             {
                "category_name" : "Компьютеры",
                "subcategories" : [
                   {
                      "category_name" : "Безопасность, вирусы, антивирусы",
                      "id" : "76"
                   },
                   {
                      "category_name" : "Бытовая автоматизация",
                      "id" : "77"
                   },
                   {
                      "category_name" : "Графика",
                      "id" : "79"
                   }
                ]
             }
          ]
       },
       "charset" : "utf-8",
       "messagestore" : "null",
       "result" : "success"
    }
    
    
    Possible errors:

    See the list of common error codes

    13.7. Function: shop/get_suggested_tags

    Accessibility:
    Everyone
    Designation:

    getting a list of popular tags

    Request fields:

    common domain identification parameters и

    Parameter Description

    limit

    the number of tags, optional, default 10, maximum 50

    Response fields:

    List of tags

    Example of a request:
    Example of a response:
    {
       "answer" : {
          "tags" : [
             "бизнес",
             "интернет",
             "авто",
             "бренд",
             "туризм"
          ]
       },
       "charset" : "utf-8",
       "messagestore" : "null",
       "result" : "success"
    }
    
    
    Possible errors:

    See the list of common error codes

    В рамках договорённости о стратегическом сотрудничестве компания Agava и REG.RU объединяют свои усилия в области предоставления услуг хостинга и регистрации доменов. С 5.12.2016г. вся техническая поддержка и консультации оказывается специалистами REG.RU, которые оперативно помогут вам.

    We use cookie files. By continuing using the site, you agree with Cookie Policy and Privacy Policy.