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

registry_check_nameserver

Verifies whether a nameserver exists at a particular registry.

Note:

This command is not required for registries that do not have a nameserver object, that is, .CA, .UK, .DE, .FR, and CH.

Request parameters for registry_check_nameserver

Standard parameters

  • action = registry_check_nameserver
  • object = nameserver attributes

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

fqdn

Required

The Fully Qualified Domain Name of the nameserver that you want to check.

tld

Required

The Top Level Domain of the nameserver that you want to check. If no tld is supplied, the tld is extracted from the nameserver.

Response parameters for registry_check_nameserver

Standard parameters

  • action = reply
  • object = nameserver
  • 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

Attributes

If the request is successful, the attributes associative array may include the
following:

Parameter name
Obligation
Definition/Value

status

Returned if is_success = true

Indicates whether the nameserver exists at the registry.

Examples for registry_check_nameserver

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">REGISTRY_CHECK_NAMESERVER</item>
                <item key="object">NAMESERVER</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="tld">.com</item>
                        <item key="fqdn">ns1.livedns.co.uk</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_array>
                <item key="0">
                    <dt_assoc>
                        <item key="protocol">XCP</item>
                        <item key="action">REPLY</item>
                        <item key="object">NAMESERVER</item>
                        <item key="is_success">1</item>
                        <item key="response_code">200</item>
                        <item key="response_text">Command successful</item>
                    </dt_assoc>
                </item>
            </dt_array>
        </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="object">NAMESERVER</item>
                <item key="response_text">Command successful</item>
                <item key="action">REPLY</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="status">
                            <dt_assoc>
                                <item key="protocol">RAP</item>
                                <item key="_response_text">Authorization error</item>
                                <item key="_response_code">531</item>
                                <item key="attributes">
                                    <dt_assoc>
                                        <item key="trans_id">
                                            <dt_assoc>
                                                <item key="client_trid">216.40.33.60-
                                                    1240404268810</item>
                                                <item key="server_trid">437077128-
                                                    1240404268830</item>
                                            </dt_assoc>
                                        </item>
                                    </dt_assoc>
                                </item>
                                <item key="registry_response_code">2201</item>
                                <item key="is_success">0</item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
                <item key="response_code">200</item>
                <item key="is_success">1</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_array>
                <item key="0">
                    <dt_assoc>
                        <item key="protocol">XCP</item>
                        <item key="action">REPLY</item>
                        <item key="object">NAMESERVER</item>
                        <item key="is_success">0</item>
                        <item key="response_code">400</item>
                        <item key="response_text">Registry doesn't support
                            nameserver as a separate entity.</item>
                    </dt_assoc>
                </item>
            </dt_array>
        </data_block>
    </body>
</OPS_envelope>

registry_check_nameserver

Verifies whether a nameserver exists at a particular registry.