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

rsp2rsp_push_transfer

Transfer a domain from one reseller to another reseller. The domain is not renewed when it is transferred and so no charges are incurred.

important:

Before you can push a domain to another reseller account, that reseller has to add you to their allow list by entering your username on the Push Domain Settings page of the RWI. For more information, see: https://kb.opensrs.com/domains/push-domains

Request parameters for rsp2rsp_push_transfer

Standard parameters

action = rsp2rsp_push_transfer

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

domain

Required

The domain that you want to push to another reseller.

grsp

Required

The name of the gaining reseller.

password

Optional

Registrant password. If specified, this value will be used for the new registration; otherwise the original password will be used.

username

Optional

Registrant username. If specified, this value will be used for the new registration; otherwise the original username will be used.

Response parameters for rsp2rsp_push_transfer

Standard parameters

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

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">RSP2RSP_PUSH_TRANSFER</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">example.com</item>
                        <item key="grsp" />
                        <item key="username">robson</item>
                        <item key="password">abc123</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"></item>
                <item key="is_success">1</item>
                <item key="response_text">'Domain successfully
                    transferred'</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"></item>
                <item key="is_success">0</item>
                <item key="response_text">'grsp must be another
                    reseller'</item>
                <item key="response_code">465</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

rsp2rsp_push_transfer

Transfer a domain from one reseller to another reseller. The domain is not renewed when it is transferred and so no charges are incurred.