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_alias_list

Returns a list of the aliases associated with the specified mobile domain.

Request parameters for get_alias_list

Standard parameters

  • action = get_alias_list
  • object = publishing

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Parameter name
Definition/Value

domain

Required

The name of the mobile domain.

service_type

Required

The type of Publishing service.

Allowed value is gomobi.

Response parameters for get_alias_list

Standard parameters

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

If the request is successful, the attributes associative array may include the following:

Parameter name
Obligation
Definition/Value

aliases

Returned if is_success = true

The list of the aliases associated with the specified domain.

domain

Returned if is_success = true

The name of the mobile domain.

Examples for get_alias_list

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">get_alias_list</item>
                <item key="object">publishing</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="service_type">gomobi</item>
                        <item key="domain">example.com</item>
                    </dt_assoc>
                </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="action">REPLY</item>
                <item key="object">PUBLISHING</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
                <item key="response_text">Service information retrieved.</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">example.com</item>
                        <item key="aliases">
                            <dt_array>
                                <item key="0">example.net</item>
                                <item key="1">example.org</item>
                                <item key="2">example.info</item>
                                <item key="3">example.biz</item>
                                <item key="4">example.us</item>
                            </dt_array>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

get_alias_list

Returns a list of the aliases associated with the specified mobile domain.