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

submit_bulk_change (WHOIS Privacy)

This command allows you to enable or disable WHOIS Privacy for multiple domains. WHOIS Privacy can be enabled or disabled for .COM, .NET, .ORG, .INFO, .BIZ, .ME, .MOBI, .NAME, .CC, .CO, and .TV TLDs.

Request parameters for submit_bulk_change

Standard parameters

  • action = submit_bulk_change
  • object = bulk_change attributes

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

apply_to_locked_domains

Optional

Specifies whether to apply WHOIS Privacy to locked domains.

  • 0—Do not apply WHOIS Privacy to locked domains. This is the default.

  • 1—Apply WHOIS Privacy to locked domains

change_items

Required

List of domains for which you want to purchase WHOIS Privacy.

change_type

Required

Identifies WHOIS Privacy as the type of service to implement in bulk.
Allowed values are:

  • whois_privacy

If this value is part of your current integration, it continues to work; however, we recommend that you use

contact_email

Optional

The email address to which your request results are sent. If blank, you do not receive a results report or any other notification regarding the bulk WHOIS Privacy purchase.

op_type

Required

The type of operation to perform. Allowed values are enable or disable.

Response parameters for submit_bulk_change

Standard parameters

  • action = reply
  • object = bulk_change
  • 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 submit_bulk_change

<?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">submit_bulk_change</item>
                <item key="object">bulk_change</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="apply_to_locked_domains">1</item>
                        <item key="contact_email">jdoe@example.com</item><item key="change_type">whois_privacy</item><item key="op_type">enable</item><item key="change_items"><dt_array><item key="0">example1.com</item><item key="1">example2.com</item></dt_array></item></dt_assoc>
                </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">BULK_CHANGE</item>
                <item key="response_text">Command successfully submitted for processing</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

submit_bulk_change (WHOIS Privacy)

This command allows you to enable or disable WHOIS Privacy for multiple domains. WHOIS Privacy can be enabled or disabled for .COM, .NET, .ORG, .INFO, .BIZ, .ME, .MOBI, .NAME, .CC, .CO, and .TV TLDs.