su_register

Submits a new registration order for an available Personal Names domain.

Request parameters for su_register

Standard parameters

action = su_register
object = surname
registrant_ip = valid IP address of the registrant (optional)

Attributes

Parameters within the attributes associative array are described below.

Parameter name

Obligation

Definition/Value

dnsRecords

Optional

A DNS record associated with the domain along with its value.

Note: You can only specify one DNS record: either A or CNAME

For more information, see the DNS Records table below.

domain

Required

The domain name to register.

mailbox

Required

An array that defines the type of account to create.

For more information, see the Mailbox table below.

DNS Records

within the dnsRecords associative array are described below.

Parameter name

Parameter name

Definition/Value

content

Optional

The IP address or fully qualified domain name.

Note: When specifying the domain name for CNAME records, put a dot after the TLD.

name

Optional

The unqualified name of the DNS record.

Specify @ to indicate the actual zone rather than another record in the zone.

type

Optional

The type of DNS record. Allowed values are A or CNAME.

Mailbox

Parameters within the mailbox associative array are described below.

Parameter name

Obligation

Definition/Value

forward_email

Optional

The address to which email is forwarded.

mailbox_type

Required

The type of mailbox account. Allowed values are:

  • MAILBOX—createaregularemailaccount. 􏰀

  • WEBMAIL_ONLY—createaWebmailonly
    account (no IMAP/POP/SMTP).

  • FORWARD_ONLYTHIS VALUE HAS BEEN
    DEPRECATED.
    If you submit this value, the command will fail.

password

Required

The registrant's initial email password.

Response parameters for su_register

Uses standard response messages.

Examples for su_register

Request

Register a domain with a regular mailbox

<?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">SU_REGISTER</item>
                <item key="object">SURNAME</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">steven.smith.net</item>
                        <item key="mailbox">
                            <dt_assoc>
                                <item key="mailbox_type">MAILBOX</item>
                                <item key="password">changeit</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="action">REPLY</item>
                <item key="object">SURNAME</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Command completed successfully</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Request

Register a domain with a regular mailbox and email forwarding

<?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">SU_REGISTER</item>
                <item key="object">SURNAME</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">steven.smith.net</item>
                        <item key="mailbox">
                            <dt_assoc>
                                <item key="mailbox_type">MAILBOX</item>
                                <item key="password">changeit</item>
                                <item key="forward_email">[email protected]</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="action">REPLY</item>
                <item key="object">SURNAME</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Command completed successfully</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Request
Register a domain with webmail only

<?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">SU_REGISTER</item>
                <item key="object">SURNAME</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">steven.smith.net</item>
                        <item key="mailbox">
                            <dt_assoc>
                                <item key="mailbox_type">WEBMAIL_ONLY</item>
                                <item key="password">changeit</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="action">REPLY</item>
                <item key="object">SURNAME</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Command completed successfully</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Request
Register a domain with webmail only and email forwarding

<?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">SU_REGISTER</item>
                <item key="object">SURNAME</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">steven.smith.net</item>
                        <item key="mailbox">
                            <dt_assoc>
                                <item key="mailbox_type">WEBMAIL_ONLY</item>
                                <item key="password">changeit</item>
                                <item key="forward_email">[email protected]</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="action">REPLY</item>
                <item key="object">SURNAME</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Command completed successfully</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Request
Register a domain with email forwarding and set the A record

<?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">SU_REGISTER</item>
                <item key="object">SURNAME</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">steven.smith.net</item>
                        <item key="mailbox">
                            <dt_assoc>
                                <item key="mailbox_type">MAILBOX</item>
                                <item key="password">changeit</item>
                                <item key="forward_email">[email protected]</item>
                            </dt_assoc>
                        </item>
                        <item key="dnsRecords">
                            <dt_array>
                                <item key="0">
                                    <dt_assoc>
                                        <item key="type">A</item>
                                        <item key="name">@</item>
                                        <item key="content">127.0.0.2</item>
                                    </dt_assoc>
                                </item>
                            </dt_array>
                        </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">SURNAME</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Command completed successfully</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Request
Register a domain with a regular mailbox and set the Cname record

<?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">SU_REGISTER</item>
                <item key="object">SURNAME</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="domain">steven.smith.net</item>
                        <item key="mailbox">
                            <dt_assoc>
                                <item key="mailbox_type">MAILBOX</item>
                                <item key="password">changeit</item>
                            </dt_assoc>
                        </item>
                        <item key="dnsRecords">
                            <dt_array>
                                <item key="0">
                                    <dt_assoc>
                                        <item key="type">CNAME</item>
                                        <item key="name">@</item>
                                        <item key="content">steven.smith.net.</item>
                                    </dt_assoc>
                                </item>
                            </dt_array>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Note: The dot after .net is required for CNAME records.

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">SURNAME</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Command completed successfully</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>