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_add_ns

Adds a nameserver to one or all registries to which a reseller has access.

Note:

This command does not create a nameserver; a nameserver must already be created (see create (nameserver)).

Request parameters for registry_add_ns

Standard parameters

  • action = registry_add_ns
  • object = nameserver

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

all

Required

Specifies whether to add the nameserver to all registries or to only COM and NET:

  • 0—Add to the registry specified in the tld Parameter

  • 1—Add to all registries enabled for your account

fqdn

Required

The nameserver to be added, which must be a fully qualified domain name.

tld

Required

The registry to which you want to add the nameservers.

Allowed values: any tld available through OpenSRS, for example, .com.

Note: If the all value = 1, the tld value is ignored; however, it must be present and the value must be a valid tld; otherwise, the command will fail.

Response parameters for registry_add_ns

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

registry_name

Returned if is_success = true

Registry Names:

  • NSI

  • DENIC

  • NeuLevel

  • TV

  • NSI .cc

  • CIRA

  • ISOC/PIR

  • UK

  • VC

  • dotName

  • NeuStar

  • Afilias

Note: Only the registries to which the reseller is subscribed are returned.

The following success/failure messages may be returned:

  • 'Successfully added.'

  • 'Couldn't add nameserver: Registry doesn't support nameserver as a
    separate object.'

  • 'Couldn't add nameserver: Our system is experiencing technical
    difficulties; please try again later. If problem persists, please contact support and state error message: REM server: -702, no RAs to service the domain 'example.cc'.

Examples for registry_add_ns

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_add_ns</item>
                <item key="object">nameserver</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="fqdn">n99.example.aero</item>
                        <item key="tld">.com</item>
                        <item key="all">0</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="attributes">
                    <dt_assoc>
                        <item key="DENIC">Successfully added</item>
                        <item key="VC">Couldn't add nameserver: Unexpected response
                            from registry: 705: No RAs to service your domain. </item>
                        <item key="TV">Couldn't add nameserver: Registry doesn't support nameserver as a separate object.
                        </item>
                        <item key="Neulevel">Successfully added</item>
                        <item key="CIRA">Couldn't add nameserver: Registry doesn't support nameserver as a separate object.
                        </item>
                        <item key="ISOC/PIR">Successfully added</item>
                        <item key="GNR">Successfully added</item>
                        <item key="UK">Couldn't add nameserver: Registry doesn't support nameserver as a separate object.
                        </item>
                        <item key="NSI_CC">Successfully added</item>
                        <item key="Neustar">Successfully added</item>
                        <item key="Afilias">Successfully added</item>
                    </dt_assoc>
                </item>
                <item key="response_text">Command verified</item>
                <item key="is_success">1</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">nameserver</item>
                <item key="response_text">Command verified</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

registry_add_ns

Adds a nameserver to one or all registries to which a reseller has access.