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

modify (nameserver)

Modifies a nameserver. This command is not supported for .TEL domains.

Important:

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 modify (nameserver)

Standard parameters

  • action = modify
  • 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 domain name of the nameserver. The name key must always be present, and must be race-encoded.

new_name

Optional. This field is only required if you are changing the name. The new, fully qualified domain name for

The new, fully qualified domain name for the nameserver

Response parameters for modify (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 modify (nameserver)

Example 1

This example changes the name of an IPv4 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">modify</item>
                <item key="object">nameserver</item>
                <item key="domain">yourdomain.com</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="name">ns1.example.com</item>
                        <item key="new_name">ns.boo.example.com</item>
                        <item key="ipaddress">212.112.123.11</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">nameserver</item>
                <item key="response_text">Command successful</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 2

This example changes the name of an IPv6 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">modify</item>
                <item key="object">nameserver</item>
                <item key="domain">yourdomain.com</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="name">ns1.example.com</item>
                        <item key="new_name">ns.test.example.com</item>
                        <item key="ipv6">2a00:1450:4008:c00:0:0:0:1</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">nameserver</item>
                <item key="response_text">Command successful</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

modify (nameserver)

Modifies a nameserver. This command is not supported for .TEL domains.