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

change (ownership)

Changes the profile (username/password) for the domain.

Note:

After issuing this command, in order to continue issuing further commands for the domain, you must delete the current cookie and set another.

Request parameters for change (ownership)

Standard parameters

  • action = change
  • object = ownership
  • 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.

password

Required

The password of the registrant who is gaining ownership.

Passwords must be 10-20 characters in length. You can use any of the following alphanumeric characters and symbols: A-Z, a-z, 0-9, !@\ $^,.~|=-+_{}#"

reg_domain

Optional

If included, the user can change the domain from one profile to another (already existing) profile. If reg_domain is not included, the username and password provided in the request are used to create a new profile.

username

Required

The username of the registrant who is gaining ownership.

Usernames must be 3-20 characters in length. You can use any of the following alphanumeric characters: A-Z, a-z, 0-9.

Response parameters for change (ownership)

Standard parameters

  • action = reply
  • object = ownership
  • 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 change (ownership)

Request

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="domain">mitdevcolin12757.com</item>
                <item key="object">OWNERSHIP</item>
                <item key="action">CHANGE</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="password">newprofile</item>
                        <item key="username">newprofile</item>
                    </dt_assoc>
                </item>
                <item key="registrant_ip">10.0.10.138</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="object">OWNERSHIP</item>
                <item key="response_text">Command Successful</item>
                <item key="action">REPLY</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

change (ownership)

Changes the profile (username/password) for the domain.