API: OpenSRS

OpenSRS API Guide: Domains and SSL

Welcome to the OpenSRS API guide. Here you will find comprehensive documentation regarding our domain and SSL services. We hope this guide will help you start working with OpenSRS as quickly as possible. If you have any questions or concerns, please do not hesitate to contact help@opensrs.com

Get Started

update_all_info

Submits a domain-information update for .DK TLDs to the OpenSRS system. Each contact object is submitted as a whole to OpenSRS, and changes are parsed against the existing information.

Important:

This command does not support .BE.

This command will overwrite the existing nameserver entries. If a nameserver has two IPs, one for IPv4 and one for IPv6, and you specify only one of these in the request, the other one will be removed from the registry.

Request parameters for update_all_info

Standard parameters

  • action = update_all_info
  • object = domain

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

contact_set

Required


Contains contact information for each contact type: owner, admin, billing, and tech.

domain

Required

The domain to be updated.

nameserver_list

Required

List of nameservers used by the domain. Values include fqdn, ipaddress, and ipv6 keys.

For more information, see the Nameserver_List table below.

Nameserver_List

Parameters within the nameserver_list associative array are described below.

Parameter name
Obligation
Definition/Value

fqdn

Required

The FQDN of a nameserver that holds the DNS information for the domain being checked, for example, 'ns1.some-domain-ved.ch'

ipaddress

Required if ipv6 is not submitted

The IPv4 address of a nameserver that holds the DNS information for the domain being checked.

You can specify ipaddress or ipv6, or both.

ipv6

Required if ipaddress is not submitted

The IPv6 address of a nameserver that holds the DNS information for the domain being checked.

You can specify ipaddress or ipv6, or both.

Response parameters for update_all_info

Standard parameters

  • action = reply
  • object = domain
  • is_success = a Boolean is returned, indicating success or failure of the
    request
  • response_code = response code indicating outcome of the request
  • response_text = message describing the outcome of the request

Examples for update_all_info

Request

<?xml version='1.0' encoding='UTF-8' standalone='no' ?>
<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">UPDATE_ALL_INFO</item>
                <item key="object">DOMAIN</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">example.dk</item>
                        <item key="nameserver_list">
                            <dt_array>
                                <item key="0">
                                    <dt_assoc>
                                        <item key="fqdn">ns1.systemdns.dk</item>
                                        <item key="ipaddress">216.40.33.21</item>
                                    </dt_assoc>
                                </item>
                                <item key="1">
                                    <dt_assoc>
                                        <item key="fqdn">ns2.systemdns.dk</item>
                                        <item key="ipaddress">216.40.33.22</item>
                                    </dt_assoc>
                                </item>
                            </dt_array>
                        </item>
                        <item key="contact_set">
                            <dt_assoc>
                                <item key="owner">
                                    <dt_assoc>
                                        <item key="first_name">Owen</item>
                                        <item key="last_name">Ottway</item>
                                        <item key="phone">+1.4165550123x1902</item> <item key="fax">+1.4165550124</item>
                                        <item key="email">ottway@example.com</item> <item key="org_name">Example Inc.</item>
                                        <item key="address1">32 Oak Street</item> <item key="address2">Suite 500</item>
                                        <item key="address3">Owner</item>
                                        <item key="city">SomeCity</item>
                                        <item key="state">CA</item>
                                        <item key="country">US</item>
                                        <item key="postal_code">90210</item>
                                    </dt_assoc> </item>
                                <item key="admin">
                                    <dt_assoc>
                                        <item key="first_name">Adler</item>
                                        <item key="last_name">Adams</item>
                                        <item key="phone">+1.4165550123x1812</item> <item key="fax">+1.4165550125</item>
                                        <item key="email">adams@example.com</item> <item key="org_name">Example Inc.</item>
                                        <item key="address1">32 Oak Street</item> <item key="address2">Suite 100</item>
                                        <item key="address3">Admin</item>
                                        <item key="city">Santa Clara</item>
                                        <item key="state">CA</item>
                                        <item key="country">US</item>
                                        <item key="postal_code">90210</item>
                                    </dt_assoc>
                                </item>
                                <item key="billing">
                                    <dt_assoc>
                                        <item key="first_name">Bill</item>
                                        <item key="last_name">Burton</item>
                                        <item key="phone">+1.4165550123x1248</item> <item key="fax">+1.4165550136</item>
                                        <item key="email">burton@example.com</item> <item key="org_name">Example Inc.</item>
                                        <item key="address1">32 Oak Street</item> <item key="address2">Suite 200</item>
                                        <item key="address3">Billing</item>
                                        <item key="city">Santa Clara</item>
                                        <item key="state">CA</item>
                                        <item key="country">US</item>
                                        <item key="postal_code">90210</item>
                                    </dt_assoc>
                                </item>
                                <item key="tech">
                                    <dt_assoc>
                                        <item key="first_name">Tim</item>
                                        <item key="last_name">Tucker</item>
                                        <item key="phone">+1.4165550123x1243</item> <item key="fax">+1.4165550125</item>
                                        <item key="email">tucker@example.com</item> <item key="org_name">Example Inc.</item>
                                        <item key="address1">32 Oak Street</item> <item key="address2">Suite 100</item>
                                        <item key="address3">Tech</item>
                                        <item key="city">Santa Clara</item>
                                        <item key="state">CA</item>
                                        <item key="country">US</item>
                                        <item key="postal_code">90210</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>

<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>

<OPS_envelope>
    
    <header><version>0.9</version>
        
    </header>
    
    <body>
        
        <data_block>
            
            <dt_assoc>
                
                <item key="protocol">XCP</item>
                
                <item key="action">REPLY</item>
                
                <item key="object">DOMAIN</item>
                
                <item key="is_success">1</item>
                
                <item key="response_text">Update request submitted successfully.</item>
                
                <item key="response_code">200</item>
                
            </dt_assoc>
            
        </data_block>
        
    </body>
    
<OPS_envelope>
<?xml version='1.0' encoding='UTF-8' standalone='no'?>

<!DOCTYPE OPS_envelope SYSTEM 'ops.dtd'>

<OPS_envelope>
    
    <header>
        
        <version>0.9</version>
        
    </header>
    
    <body>
        
        <data_block>
            
            <dt_assoc>
                
                <item key="protocol">XCP</item>
                
                <item key="action">REPLY</item>
                
                <item key="object">DOMAIN</item>
                
                <item key="is_success">0</item>
                
                <item key="response_text">A request is currently waiting on this domain.</item>
                
                <item key="response_code">437</item>
                
            </dt_assoc>
            
        </data_block>
        
    </body>
    
<OPS_envelope>

update_all_info

Submits a domain-information update for .DK TLDs to the OpenSRS system. Each contact object is submitted as a whole to OpenSRS, and changes are parsed against the existing information.