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 Contacts

Submits a domain-contact information update to the OpenSRS system. Each contact object is submitted as a whole to OpenSRS.

Request parameters for update_contacts

Standard parameters

  • action = update_contacts
  • object = domain

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

affect_domains

Optional

Flag indicating the domains to which to apply the change.

  • 0—Change applies only to the specified domain. This is the default.

  • 1—Change applies to all domains linked to
    this profile.

contact_set

Required

Contains new contact information for each specified contact type. For more information, see “ContactSet”.

domain

The domain to be updated.

report_email

Optional

The End User's email address to which notification of success or failure is sent. The notification email is sent on behalf of the reseller.

Note: This parameter can only be specified if affect_domains is set to '1'

types

Required

The contact types whose information is changing. Allowed values are; owner, admin, billing, and tech.

Response parameters for update_contacts

Standard parameters

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

details

Returned if
is_success = true

Definition/Value
A description of the success or failure of each affected domain.

The key is the name of the domain.
When you specify a contact_info modification, you can specify that you want the action to apply to all domains.

Because the modification may succeed or fail on a case-by-case basis, you get a response code for each domain that is affected.

The key that is used to access this domain success information is the name of the domain itself, for example, 'mydomain.com' or 'mydomain.co.uk'.

Each key contains a hash (described below) that provides details on the action performed on that domain.

encoding_type

Optional

The encoding type for this domain. For a list of languages and codes, see “AppendixC:EncodingTypes forIDNs”.

response_code

Returned if
is_success = true

The response code associated with the modification on this domain.

response_text

Returned if
is_success = true

The response text associated with the modification on this domain.

waiting_requests_no

Returned if
is_success = true

The number of registry requests in the waiting state.

Examples for update_contacts

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">UPDATE_CONTACTS</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="types">
                            <dt_array>
                                <item key="0">admin</item>
                                <item key="1">billing</item>
                            </dt_array>
                        </item>
                        <item key="domain">ryansiew.com</item>
                        <item key="contact_set">
                            <dt_assoc>
                                <item key="owner">
                                    <dt_assoc>
                                        <item key="country">US</item>
                                        <item key="address3">Owner</item>
                                        <item key="org_name">Example Inc.</item>
                                        <item key="phone">+1.4165550123x1902</item>
                                        <item key="last_name">Ottway</item>
                                        <item key="address2">Suite 500</item>
                                        <item key="state">CA</item>
                                        <item key="email">ottway@example.com</item>
                                        <item key="city">SomeCity</item>
                                        <item key="postal_code">90210</item>
                                        <item key="fax">+1.4165550124</item>
                                        <item key="address1">32 Oak Street</item>
                                        <item key="first_name">Owen</item>
                                    </dt_assoc>
                                </item>
                                <item key="admin">
                                    <dt_assoc>
                                        <item key="country">US</item>
                                        <item key="address3">Admin</item>
                                        <item key="org_name">Example Inc.</item>
                                        <item key="phone">+1.4165550123x1812</item>
                                        <item key="last_name">Adams</item>
                                        <item key="address2">Suite 100</item>
                                        <item key="state">CA</item>
                                        <item key="email">adams@example.com</item>
                                        <item key="city">Santa Clara</item>
                                        <item key="postal_code">90210</item>
                                        <item key="fax">+1.4165550125</item>
                                        <item key="address1">32 Oak Street</item>
                                        <item key="first_name">Adler</item>
                                    </dt_assoc>
                                </item>
                                <item key="billing">
                                    <dt_assoc>
                                        <item key="country">US</item>
                                        <item key="address3">Billing</item>
                                        <item key="org_name">Example Inc.</item>
                                        <item key="phone">+1.4165550123x1248</item>
                                        <item key="last_name">Burton</item>
                                        <item key="address2">Suite 200</item>
                                        <item key="state">CA</item>
                                        <item key="email">burton@example.com</item>
                                        <item key="city">Santa Clara</item>
                                        <item key="postal_code">90210</item>
                                        <item key="fax">+1.4165550136</item>
                                        <item key="address1">32 Oak Street</item>
                                        <item key="first_name">Bill</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </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 completed successfully</item>
                <item key="action">REPLY</item>
                <item key="response_code">200</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="details">
                            <dt_assoc>
                                <item key="ryansiew.com">
                                    <dt_assoc>
                                        <item key="response_text">Command completed successfully</item>
                                        <item key="waiting_requests_no">0</item>
                                        <item key="encoding_type"></item>
                                        <item key="response_code">200</item>
                                        <item key="is_success">1</item>
                                    </dt_assoc>
                                </item>
                            </dt_assoc>
                        </item>
                    </dt_assoc>
                </item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Update Contacts


Submits a domain-contact information update to the OpenSRS system. Each contact object is submitted as a whole to OpenSRS.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.