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

let expire (publishing)

Sets a goMobi domain to expire at the end of the billing period. Until that time, you can re-enable the domain by using the enable(publishing) command.

Request parameters for let expire (publishing)

Standard parameters

  • action = let_expire
  • 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 that you want to let expire.

service_type

Required

The type of Publishing service.

Allowed value is gomobi.

Response parameters for let expire (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 let expire (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="action">LET_EXPIRE</item>
                <item key="object">PUBLISHING</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="service_type">gomobi</item>
                        <item key="domain">example.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">Let 'gomobi' service for 'example.net' expire.</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

let expire (publishing)

Sets a goMobi domain to expire at the end of the billing period. Until that time, you can re-enable the domain by using the enable(publishing) command.