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

request_on_demand_scan

If you have a Symantec or SiteLock seal, or the GeoTrust Web Site Anti- Malware Scan product, and you have corrected a malware issue on your site, you can ask the SSL Service provider to rescan your system immediately and reinstate the Seal.

Note:

You can only request a scan if the SSL Seal order is complete.

Request parameters for request_on_demand_scan

Standard parameters

  • action = request_on_demand_scan
  • object = trust_service

Attributes

Parameters within the attributes associative array are described below.

Note:

You must specify at least one of these parameters.

Parameter name
Obligation
Definition/Value

order_id

Optional

The SSL Service order ID number.

product_id

Optional

The SSL Service product ID number.

Response parameters for request_on_demand_scan

Standard parameters

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

product_id

Returned if is_success = true

The SSL Service ID number.

Examples for request_on_demand_scan

Example 1

This example requests a scan for a site by submitting the product ID.

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">request_on_demand_scan</item>
                <item key="object">trust_service</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="product_id">275</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">TRUST_SERVICE</item>
                <item key="response_text">Command completed successfully.</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="product_id">275</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Example 2

This example requests a scan for a site by submitting the order ID.

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">request_on_demand_scan</item>
                <item key="object">trust_service</item>
                <item key="action">REQUEST_ON_DEMAND_SCAN</item>
                <attributes>
                    <item key="order_id">49841</item>
                </attributes>
            </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">TRUST_SERVICE</item>
                <item key="response_text">Command completed successfully.</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="product_id">275</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

request_on_demand_scan

If you have a Symantec or SiteLock seal, or the GeoTrust Web Site Anti- Malware Scan product, and you have corrected a malware issue on your site, you can ask the SSL Service provider to rescan your system immediately and reinstate the Seal.