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

modify_trade_lock_setting

A setting to indicate whether the 60-day trade lock will be applied after the next trade. This setting will revert to “1" after every trade. It will not prevent another change of registrant. Please note that this is a setting to indicate whether the lock should be applied after the next trade. You must successfully complete a trade for this setting to take effect. Changing this setting will NOT disable the trade lock if the domain is already trade-locked.

Request Parameters for modify_trade_lock_setting

Standard parameters:

  • action = modify_trade_lock_setting
  • object = domain
  • protocol = XCP

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

domain

Required

The domain for which the trade lock setting is being modified.

enable

Required

Possible values are:

  • 0 - Indicates that the Current Registrant has explicitly opted out of applying the 60-day inter-registrar transfer lock for this domain name.

  • 1 - Indicates that a 60-day inter-registrar transfer lock will be applied to the domain name after a successful completion of a Change of Registrant process. This is the default setting as per the ICANN Transfer Policy.

ip_address

Required

The IP address of the Current Registrant at the time when they gave their explicit consent to opting out of the transfer lock.

Response Parameters for modify_trade_lock_setting

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 modify_trade_lock_setting

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="object">DOMAIN</item>
    <item key="action">modify_trade_lock_setting</item>
    <item key="attributes">
     <dt_assoc>
      <item key="enable">1</item>
      <item key="domain">weruiofh89q34gh78943g4.com</item>
      <item key="ip_address">0.0.0.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="object">DOMAIN</item>
    <item key="response_text">Command successful: The 60-day trade hold has been enabled (by reseller (via API); Supplied IP address: 0.0.0.0)</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>

modify_trade_lock_setting

A setting to indicate whether the 60-day trade lock will be applied after the next trade. This setting will revert to “1" after every trade. It will not prevent another change of registrant. Please note that this is a setting to indicate whether the lock should be applied after the next trade. You must successfully complete a trade for this setting to take effect. Changing this setting will NOT disable the trade lock if the domain is already trade-locked.