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

send_password (domain)

Sends an email containing a password reset link to a contact of the domain.

Request parameters for send_password (domain)

Standard parameters

  • action = send_password
  • object = domain

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

domain_name

Required

The domain name for which the password is sent.

send_to

Required

An indication of the contact to which the password is to be sent, either owner or admin (default)

sub_user

Required

An indication of whether the password is to be sent to the sub-user of the domain. An error is returned if this field is set to 1 but there is no sub-user associated to the domain.

  • 0—Do not send to sub-user

  • 1—Sendtosub-user

Response parameters for send_password (domain)

Standard parameters

  • action = reply
  • object = domain
  • 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 send_password (domain)

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">send_password</item>
                <item key="object">domain</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="sub_user">0</item>
                        <item key="send_to">owner</item>
                        <item key="domain_name">example.info</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">domain</item>
                <item key="response_text">Message sent</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

send_password (domain)

Sends an email containing a password reset link to a contact of the domain.