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

get_trade_designated_agent

Queries the current state (enabled or disabled) of the designated agent setting for the specified domain.

Request Parameters for get_trade_designated_agent

Standard parameters

  • action = get_trade_designated_agent
  • object = domain

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

domain

Required

The domain to which the trade pertains.

Response Parameters for get_trade_designated_agent

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

Attributes

The attributes array includes an array of associative arrays, one for each
domain queried. The associative array for each domain includes the contact
set for that domain.

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

allow_designated_agent

Always returned

Indicates whether TUCOWS is allowed to act as the designated agent.

Possible values are:

  • 0 - Indicates that TUCOWS does not have permission act as a "designated agent". The registrant/owner will therefore approve any and all contact owner changes for their domains via email.

  • 1 - Indicates that TUCOWS may act on behalf of the registrant as a "designated agent". The registrant has agreed to all terms and conditions outlined in TUCOWS' service agreement).

Examples for get_trade_designated_agent

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">GET_TRADE_DESIGNATED_AGENT</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">icanntradetest2.com</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</item>
                <item key="action">REPLY</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="allow_designated_agent">0</item>
                    </dt_assoc>
                </item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

get_trade_designated_agent

Queries the current state (enabled or disabled) of the designated agent setting for the specified domain.