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

delete (nameserver)

Deletes a nameserver, provided it is not currently serving a domain.

Note:

If the registry in which the nameserver object resides is serving a domain outside of OpenSRS, delete nameserver returns an error and the nameserver is not deleted.

Request parameters for delete (nameserver)

Standard parameters

  • action = delete
  • object = nameserver
  • registrant_ip = valid IP address of the registrant (optional)

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

domain

Required

The relevant domain.

ipaddress

Required if ipv6 is not submitted

The IPv4 address of the nameserver.

You can specify ipaddress or ipv6, or both.

Note: This parameter is always required for .DE, even if ipv6 is submitted.

ipv6

Required if ipaddress is not submitted

The IPv6 address of the nameserver.

You can specify ipaddress or ipv6, or both.

Note:This parameter is not supported for .CN.

name

Required

Fully qualified race-encoded domain name of the nameserver.

Response parameters for delete (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

Examples for delete (nameserver)

Example 1

This example deletes an IPv4 nameserver.

<?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">delete</item>
                <item key="object">nameserver</item>
                <item key="registrant_ip">216.40.46.115</item>
                <item key="domain">yourdomain.com</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="ipaddress">24.22.112.11</item>
                        <item key="name">ns1.example.com</item>
                    </dt_assoc>
                </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">nameserver</item>
                <item key="response_text">Nameserver deleted</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 2

This example deletes an IPv6 nameserver.

<?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">delete</item>
                <item key="object">nameserver</item>
                <item key="registrant_ip">216.40.46.115</item>
                <item key="domain">yourdomain.com</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="ipv6">2a00:1450:4008:c00:0:0:0:1</item>
                        <item key="name">ns3.example.com</item>
                    </dt_assoc>
                </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">nameserver</item>
                <item key="response_text">Nameserver deleted</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

delete (nameserver)

Deletes a nameserver, provided it is not currently serving a domain.