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

update publishing

Changes the name of the mobile domain, and, optionally, changes the domain from which the mobile domain gets its content.

Request parameters for update publishing

Standard parameters

  • action = update
  • object = publishing

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

domain

Required

The name of the mobile domain.

new_domain

Optional

The new name of the mobile domain.

service_type

Required

The type of Publishing service.

Allowed value is gomobi.

source_domain

Required

The name of the domain on which the mobile domain content is based.

Response parameters for update publishing

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

Examples for update publishing

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">PUBLISHING</item>
                <item key="action">UPDATE</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">example.net</item>
                        <item key="service_type">gomobi</item>
                        <item key="source_domain">example303.com</item>
                        <item key="new_domain">example123.net</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="action">REPLY</item>
                <item key="object">PUBLISHING</item>
                <item key="response_text">Updated 'gomobi' service for 'example.net' with source-domain 'example303.com' and new domain 'example123.net'.</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

update publishing

Changes the name of the mobile domain, and, optionally, changes the domain from which the mobile domain gets its content.