opensrs.net
ack_event
After an event has been polled (poll_event), each unique transaction can be acknowledged, effectively removing it from future poll_event results.
Each unique transaction must be individually acknowledged .
Suggest Edits
Request Parameters for ack_event
Standard Parameters
action = ack
object = event
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
event_id Required The unique identifier of the event transaction to be acknowledged.
Response Parameters for ack_event
Standard parameters
action = reply
object = event
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 nameObligationDefinition/Value
transaction_id Always returned The unique identifier of the event transaction acknowledged.
Request Example for ack_event
<?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">EVENT</item> <item key="action">ACK</item> <item key="attributes"> <dt_assoc> <item key="event_id">6887c7d3838dcaec7517c531df527bb7</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response Example for ack_event
<?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">EVENT</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="transaction_id">2014-05-29 11:17:03 22962 101</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="total">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request Parameters for ack_event
Standard Parameters
Attributes
Response Parameters for ack_event
Standard parameters
Attributes
Request Example for ack_event
Response Example for ack_event
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Acting on behalf of subresellers
Suggest Edits
You can execute any of the API commands on behalf of one of your subresellers simply by adding the parameter as_subreseller to the request.
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
as_subreseller Optional The username of the subreseller on whose behalf you are submitting the command.
Example
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="as_subreseller">subtest</item> <item key="auto_renew">0</item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="domain">example.com </item> <item key="handle">process</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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="sortorder">3</item> <item key="name">ns3.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="id">281405</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Attributes
Example
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
activate (domain)
Activates a parked .DE domain.
The .DE registry requires a domain to be
parked on a valid nameserver.
The domain can be parked prior to the
registration, or within thirty days of the successful registration.
Use this
command within thirty days of registering the domain and after you park the
domain.
Suggest Edits
Request parameters for activate (domain)
Standard parameters
action = activate
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The .DE domain that you want to activate
Response parameters for activate (domain)
Standard parameters
action = activate
object = domain
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 activate (domain)
Request
<?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">ACTIVATE</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">example.de </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
<?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">REPLY</item> <item key="object">DOMAIN</item> <item key="is_success">0</item> <item key="response_code">437</item> <item key="response_text">A request is currently waiting on this domain</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for activate (domain)
Standard parameters
Attributes
Response parameters for activate (domain)
Standard parameters
Examples for activate (domain)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
add (subuser)
Creates a subuser for a user's account.
Only one subuser can exist per account.
Suggest Edits
Request parameters for add (subuser)
Standard parameters
action = add
object = subuser
registrant_ip = valid IP address of the registrant (optional)
username = name of the user account
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The relevant domain.
sub_password Required Password for the sub-user.
sub_permission Required The sub_permission value is a bit-mask that indicates which portions of the domain information are changeable by the sub-user.
The bits are as follows:
1—Owner
2—Admin
4—Billing
8—Tech
16—Nameservers
32—Rsp_whois_info
sub_username Required Username for the sub-user.
Response parameters for add (subuser)
Standard parameters
action = reply
object = subuser
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 add (subuser)
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">add</item> <item key="object">subuser</item> <item key="domain”>acmeinc.biz </item> <item key="username">aaaa</item> <item key="attributes"> <dt_assoc> <item key="sub_password">luda</item> <item key="sub_permission">2</item> <item key="sub_username">subludak</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">SUBUSER</item> <item key="response_text">Command Successful</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for add (subuser)
Standard parameters
Attributes
Response parameters for add (subuser)
Standard parameters
Examples for add (subuser)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
advanced_update_nameservers
Adds nameservers to a domain, or adds or removes nameservers for a domain that already has nameservers assigned to it.
Suggest Edits
📘Note:
This command does not create a nameserver; the nameserver must already exist.
This command is not supported for .DK.
Use the update_all_info command to change the nameservers for .DK domains.
When you use this command to add or change nameservers for .IT domains, even though the response says the command was successful, the new nameservers are not activated immediately.
The registry runs a series of tests against the nameservers before activating them.
During the time that the tests are being run, any query about the domain, such as get nameservers or getdomainall_info, will return the old nameservers.
If the nameservers do not pass the registry tests within 30 days, the registry ignores the request.
If you issue another advanced_update_nameservers command before the registry has completed their tests, the new command is assumed to refer to the old, currently active nameservers.
Request parameters for advanced_update_nameservers
Standard parameters
action = advanced_update_nameservers
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
add_ns Optional List of nameservers to add.
This array cannot be submitted in the same command with the assign_ns parameter, but can be submitted with remove_ns.
assign_ns Optional List of nameservers to assign.
This array cannot be submitted in the same command with the add_ns or remove_ns parameters.
domain Required The relevant domain.
op_type Required The type of operation to perform on the object.
Use assign when submitted with the assign_ns array.
Use add_remove when submitted with the add_ns or remove_ns arrays.
remove_ns Optional List of nameservers to remove.
This array cannot be submitted in the same command with the assign_ns parameter, but can be submitted with add_ns.
Response parameters for advanced_update_nameservers
Standard parameters
action = reply
object = domain
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 advanced_update_nameservers
Request
Assign nameserverAdd or remove nameserver
<?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">advanced_update_nameservers</item> <item key="object">domain</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="assign_ns"> <dt_array> <item key="0">ns1.example .com</item> <item key="1">ns2.example .com</item> <item key="2">ns3.example .com</item> <item key="3">ns4.example .com</item> </dt_array> </item> <item key="op_type">assign</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">advanced_update_nameservers</item> <item key="object">domain</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="op_type">add_remove</item> <item key="remove_ns"> <dt_array> <item key="0">ns1.example .com</item> <item key="1">ns2.example .com</item> </dt_array> </item> <item key="add_ns"> <dt_array> <item key="0">ns4.example .com</item> <item key="1">ns3.example .com</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">domain</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>
Updated about 7 years ago
* * *
Table of Contents
Request parameters for advanced_update_nameservers
Standard parameters
Attributes
Response parameters for advanced_update_nameservers
Standard parameters
Examples for advanced_update_nameservers
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
belongs_to_rsp
Determines whether domain belongs to the RSP who issued the command.
Suggest Edits
Request parameters
Standard request parameters
action = belongs_to_rsp
object = domain
Request attributes
Parameters within the attributes associative array are described below:
ParameterObligationDefinition/Value
domain Required The domain to be checked.
* * *
Response parameters
Standard response parameters
action = reply
object = domain
is_success = Boolean 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.
Response attributes
If the request is successful, the attributes associative array may include the following:
ParameterObligationDefinition/Value
belongs_to_rsp Always returned Whether the domain belongs to the RSP who issued the command.
Allowed Values:
0—Does not belong to the RSP
1—Belongs to the RSP
domain_expdate Returned when: belongs_to_rsp=1 The domain's expiry date.
📘Note
Domains not managed by OpenSRS and expired domains without grace period may cause belongs_to_rsp to report 0 and error "Unknown Domain".
This means the domain will not show active in your account, however, you may still run queries on the domain and process redemption when supported.
* * *
Example
RequestResponse: If belongs_to_rsp=1Response: If belongs_to_rsp=0
<?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">BELONGS_TO_RSP</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="belongs_to_rsp">1</item> <item key="domain_expdate">2023-11-01 00:49:10</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="response_text">Query successful</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="belongs_to_rsp">0</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="response_text">Query successful</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Response attributes
Example
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
cancel_icann_trade
Suggest Edits
Request Parameters for cancel_icann_trade
Standard parameters:
action = cancel_icann_trade
object = domain
protocol = XCP
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The domain to which the trade being modified pertains.
Response Parameters for modify_trade_lock_setting
Standard parameters
action = reply
object = domain
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 cancel_icann_trade
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">CANCEL_ICANN_TRADE</item> <item key="attributes"> <dt_assoc> <item key="domain">icanntradetest2.com </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">Trade successfully cancelled by reseller</item> <item key="action">REPLY</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated almost 2 years ago
* * *
Table of Contents
Request Parameters for cancel_icann_trade
Standard parameters:
Attributes
Response Parameters for modify_trade_lock_setting
Standard parameters
Examples for cancel_icann_trade
Request
Response
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
cancel_order
Cancel a SSL Service order.
Suggest Edits
Request parameters
Standard request parameters
action = cancel_order
object = trust_service
Request attributes
Parameters within the attributes associative array are described below:
ParameterObligationDefinition/Value
order_id Required The ID number of the order.
* * *
Response parameters
Standard response parameters
action = reply
object = trust_service
is_success = Boolean 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.
Response attributes
If the request is successful, the attributes associative array may include the following:
ParameterObligationDefinition/Value
domain Always returned The associated domain name for the SSL order.
order_id Always returned The ID number of the order.
state Always returned The state of the order.
Allowed values are:
approver-confirmed—Owner has confirmed the DV certificate.
awaiting-approval—Waiting for supplier approval.
cancelled—Pending order was cancelled.
completed—Order is complete.
declined—Order declined by the supplier.
in-progress—Order is in progress.
pending—Order saved as pending.
* * *
Example
RequestResponse
<?xml version='1.0 ' encoding='UTF-8'?> <!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">cancel_order</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="order_id">578</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="domain">example.org </item> <item key="order_id">578</item> <item key="state">declined</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Response attributes
Example
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
cancel_pending_orders
Cancels orders with a status of pending or declined.
Suggest Edits
Request parameters for cancel_pending_orders
Standard parameters
action = cancel_pending_orders
object = order
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
status Optional Lists the status for which to cancel orders, either pending or declined.
Valid values are declined or pending.
The default is pending.
to_date Required Specify the date, in UNIX (epoch) time before which
to cancel orders.
Orders put in pending or declined
state on this date and earlier are cancelled.
Response parameters for cancel_pending_orders
Standard parameters
action = reply
object = order
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 nameObligationDefinition/Value
cancelled Returned if is_success = true Contains associative arrays identifying orders that were cancelled.
Valid values are domain, reg_type, and id.
For more information, see the Cancelled table
below.
total Returned if is_success = true The number of orders that were cancelled.
Cancelled
Parameters within the cancelled associative array are described below.
Parameter nameObligationDefinition/Value
domain Always returned The domain name of the cancelled order.
id Always returned The order ID of the cancelled order.
reg_type Always returned The type of order that was cancelled.
Valid values are new, transfer, and renewal.
Examples for cancel_pending_orders
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">cancel_pending_orders</item> <item key="object">order</item> <item key="attributes"> <dt_assoc> <item key="to_date">1115228160</item> <item key="status"> <dt_array> <item key="0">declined</item> <item key="1">pending</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">ORDER</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command successful</item> <item key="attributes"> <dt_assoc> <item key="total">2</item> <item key="cancelled"> <dt_array> <item key="0"> <dt_assoc> <item key="reg_type">new</item> <item key="id">5261</item> <item key="domain">example.de </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="reg_type">transfer</item> <item key="id">5530</item> <item key="domain">example.com </item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for cancel_pending_orders
Standard parameters
Attributes
Response parameters for cancel_pending_orders
Standard parameters
Attributes
Cancelled
Examples for cancel_pending_orders
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
cancel_transfer
Cancels transfers that are pending owner approval.
Suggest Edits
Request parameters for cancel_transfer
Standard parameters
action = cancel_transfer
object = transfer
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Optional - either order-id or domain must be specified.
The domain to be cancelled.
order_id Optional - either order-id or domain must be specified.
The ID of the order to be cancelled.
reseller Required Reseller username.
Response parameters for cancel_transfer
Standard parameters
action = reply
object = transfer
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 cancel_transfer
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">cancel_transfer</item> <item key="object">transfer</item> <item key="attributes"> <dt_assoc> <item key="reseller">purple</item> <item key="order_id">3533098</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
If successfulIf unsuccessful
<?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">TRANSFER</item> <item key="response_text">Transfer with order id: 3533098 has been cancelled.</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">TRANSFER</item> <item key="response_text">Command Failed: Transfer State Prohibits Cancellation</item> <item key="is_success">0</item> <item key="response_code">400</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for cancel_transfer
Standard parameters
Attributes
Response parameters for cancel_transfer
Standard parameters
Examples for cancel_transfer
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
change (ownership)
Changes the profile (username/password) for the domain.
Suggest Edits
Request parameters for change (ownership)
Standard parameters
action = change
object = ownership
registrant_ip = valid IP address of the registrant (optional)
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The relevant domain.
password Required The password of the registrant who is gaining ownership.
Passwords must be 10-20 characters in length.
You can use any of the following alphanumeric characters and symbols: A-Z, a-z, 0-9, !@\ $^,.~|=-+_{}#"
reg_domain Optional If included, the user can change the domain from one profile to another (already existing) profile.
If reg_domain is not included, the username and password provided in the request are used to create a new profile.
username Required The username of the registrant who is gaining ownership.
Usernames must be 3-20 characters in length.
You can use any of the following alphanumeric characters: A-Z, a-z, 0-9.
Response parameters for change (ownership)
Standard parameters
action = reply
object = ownership
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 change (ownership)
Request
<?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="domain">mitdevcolin12757.com </item> <item key="object">OWNERSHIP</item> <item key="action">CHANGE</item> <item key="attributes"> <dt_assoc> <item key="password">newprofile</item> <item key="username">newprofile</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
<?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="object">OWNERSHIP</item> <item key="response_text">Command Successful</item> <item key="action">REPLY</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for change (ownership)
Standard parameters
Attributes
Response parameters for change (ownership)
Standard parameters
Examples for change (ownership)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
check_transfer
Checks to see if the specified domain can be transferred in to OpenSRS, or from one OpenSRS reseller to another.
This call can also be used to check the status of the last transfer request on a given domain name.
When you use the check_transfer action prior to initiating a transfer, the transferable response parameter is most relevant, and if transferable = 0, the reason field is also important.
When you use the check_transfer action to determine the progress of a transfer, the status parameter is most important.
If the response indicates that the transfer is in progress and the status is pending_registry, the transfer will be scheduled to complete within 5 minutes of the query; running the query expedites the process and causes the transfer to complete within 5 minutes.
Suggest Edits
Request parameters for check_transfer
Standard parameters
action = check_transfer
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
check_status Optional Flag to request the status of a transfer request.
If the transfer state is returned as pending_registry and the Registry shows OpenSRS as the Registrar of record, OpenSRS schedules the completion of gTLD transfers.
Allowed values are 0 or 1.
domain Required The fully qualified domain name in the transfer order.
get_request_address Optional Flag to request the registrant's contact email address.
This is useful if you want to make
sure that your client can receive mail at that address to acknowledge the transfer.
Allowed values are 0 or 1.
Response parameters for check_transfer
Standard parameters
action = reply
object = domain
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 nameObligationDefinition/Value
noservice Returned if
is_success=true Indication of supplier availability:
0—Supplier is available
1—Supplier is unavailable.
Note: When noservice is 1 then transferable is set to 0 and is_success is set to 1.
reason Returned if is_success = true and transferrable = 0 Reason for transfer status.
request_address Optional Valid email address of registrant, which can be used to make sure that they can receive mail at that address to acknowledge the transfer.
status Returned if is_success = true.
If no transfer is underway, this value is retrieved from the previous transfer order.
Status of the latest transfer on the domain initiated by the reseller.
Note: Resellers can only request status for transfers that they initiated (any checks for transfers initiated by other resellers returns 'undef').
pending_owner—Awaiting approval by domain's admin contact (every transfer begins with this status).
If approval is not given within five days, the transfer is cancelled by OpenSRS.
pending_admin—Waiting for approval by OpenSRS support staff.
pending_registry—Awaiting registry approval (the transfer completes after 7 days unless it is declined by the current registrar).
If the Registry shows OpenSRS as the Registrar of record, OpenSRS schedules the completion of gTLD transfers.
The transfer will be scheduled to complete within 5 minutes of the query.
completed—The transfer completed successfully.
cancelled—The reseller or OpenSRS stopped the transfer.
undef—No transfer exists for this domain.
timestamp Returned if is_success = true.
If no transfer is currently underway, timestamp is retrieved from the previous transfer order.
The date and time of the most recent update to the state of the transfer (which could be placement of an order, an owner request, an owner confirmation, a registry request, or completion/cancellation of an order).
Date format is DD MMM YYYY 00:00:00 GMT
transferrable Included only when a transfer request has not been submitted for the specified domain Whether the domain can be transferred.
0—Cannot be transferred
1—Can be transferred
type Returned if is_success = true and transferrable = 1 Type of transfer initiated:
reg2reg—Transfer from one registrar to another.
rsp2rsp—Transfer between two resellers of the same registrar.
unixtime Returned if is_success = true.
If no transfer is currently underway, unixtime is retrieved from the previous transfer order.
Conversion of timestamp, in seconds since Epoch (1 Jan 1970 00:00:00 GMT).
Examples for check_transfer
Request and Response
This request may have one of three possible responses.
Response 1
Indicates that the transfer is awaiting approval by domain's admin contact .
Response 2
Indicates that the transfer was successful.
The status shows pending_registry because a cronjob needs to run to complete the transfer process; however, running the check transfer command causes the transfer to complete within 5 minutes.
Response 3
This response indicates that the transfer request completed and the domain is now with OpenSRS.
RequestResponse 1Response 2Response 3
<?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">CHECK_TRANSFER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="check_status">1</item> <item key="get_request_address">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?xml version="1.0 " encoding="UTF-8"?> <!DOCTYPE OPS_envelope> <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"">Query successful</item> <item key=""action"">REPLY</item> <item key=""attributes""> <dt_assoc> <item key=""transferrable"">0</item> <item key=""noservice"">0</item> <item key=""status"">pending_owner</item> <item key=""reason"">Transfer in progress</item> <item key=""unixtime"">1520826472</item> <item key=""request_address"">[email protected]</item> <item key=""timestamp"">Mon Jun 18 15:15:25 2012</item> </dt_assoc> </item> <item key=""response_code"">200</item> <item key=""is_success"">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Query successful.
Transfer scheduled in 5 minutes.</item> <item key="attributes"> <dt_assoc> <item key="transferrable">0</item> <item key="noservice">0</item> <item key="timestamp">Thu Jun 14 11:05:34 2012</item> <item key="status">pending_registry</item> <item key="reason">Transfer in progress</item> <item key="unixtime">1339686334</item> <item key="request_address">[email protected]</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="is_success">1</item> <item key="response_text">Query successful</item> <item key="action">REPLY</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="transferrable">0</item> <item key="reason_code">domain_already_belongs_to_current_reseller</item> <item key="noservice">0</item> <item key="timestamp">Mon Jun 18 15:15:25 2012</item> <item key="status">completed</item> <item key="reason">Domain already exists in RESELLER_NAME's account</item> <item key="unixtime">1340046925</item> <item key="request_address">[email protected]</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for check_transfer
Standard parameters
Attributes
Response parameters for check_transfer
Standard parameters
Attributes
Examples for check_transfer
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Construction of the POST Data
Suggest Edits
The header for the POST data should have the following format.
Replace the items in brackets with user- and command-specific information.
POST data
POST / HTTP/1.0 Content-Type: text/xml X-Username: (OpenSRS Username) X-Signature: (MD5 Signature) Content-Length: (Length of XML Document)
Following this header should be one blank line followed by the XML document that contains the OpenSRS command data.
The header combined with the XML makes up the packet that is sent to OpenSRS to execute your command.
Response Messages
The response is returned in the form of an XML document.
Responses contain data that may be simple strings or lists of information.
Common fields
There are a few common fields that all responses share, regardless of the action to which they are responding.
The following fields comprise a standard response message.
Some actions only use standard response messages.
Parameter nameDefinition/Value
protocol The protocol that is being used (XCP).
action In the case of responses, this is always REPLY.
response_code Response code (meaning is action-specific).
response_text Response text (meaning is action-specific).
is_success Indicates whether the command was successful.
Returns 0 if not successful and 1 if the action was successful.
Optional fields
In addition, the structure may contain the following fields, depending on the specific action that was requested.
Parameter nameDefinition/Value
attributes A hash that contains any specific parameters or attributes to be sent along with the action request.
Updated about 2 years ago
* * *
What’s Next
Troubleshooting HTTPS Post
Table of Contents
Response Messages
Common fields
Optional fields
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
create (nameserver)
Creates a nameserver in the same domain space as the cookie's domain.
Suggest Edits
📘Note:
This action is not the same as modify (nameserver), which actually assigns a nameserver to a domain.
Request parameters for create (nameserver)
Standard parameters
action = create
object = nameserver
registrant_ip = valid IP address of the registrant (optional)
cookie = cookie created to access OpenSRS, see "set (cookie)" (optional)
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
add_to_all_registry Optional Adds the newly created nameserver to other
registries so that the nameserver can be used
on other TLDs.
Specify OpenSRS supported TLDs where the
Registry supports nameservers as a separate
object.
Domain Required if cookie is not submitted The relevant domain.
ipaddress Required if ipv6 is not submitted The IPv4 address of the nameserver.
You can specify ipaddress or ipv6, or both.
Note: This parameter is always required for .DE, even if ipv6 is submitted.
ipv6 Required if ipaddress is not submitted The IPv6 address of the nameserver.
You can specify ipaddress or ipv6, or both.
Note:This parameter is not supported for .CN.
name Required Fully qualified race-encoded domain name of the nameserver.
Response parameters for create (nameserver)
Standard parameters
action = reply
object = nameserver
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 create (nameserver)
Example 1
This example creates an IPv4 nameserver without adding to any foreign
registries.
RequestResponse
<?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">create</item> <item key="object">nameserver</item> <item key="domain">example.com </item> <item key="attributes"> <dt_assoc> <item key="name">ns1.example .com</item> <item key="ipaddress">212.112 .123.11 </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">nameserver</item> <item key="response_text">Nameserver Created</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
This example creates an IPv4 nameserver and adds it to any foreign
registries.
RequestResponse
<?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_array> <item key="0"> <dt_assoc> <item key="protocol">XCP</item> <item key="action">create</item> <item key="object">nameserver</item> <item key="domain">example.com </item> <item key="attributes"> <dt_assoc> <item key="add_to_all_registry"> <dt_array> <item key="0">.info</item> <item key="1">.name</item> <item key="2">.org</item> <item key="3">.biz</item> <item key="4">.de</item> <item key="5">.cc</item> <item key="6">.us</item> </dt_array> </item> <item key="ipaddress">207.136 .65.24 </item> <item key="name">ns6.example .com</item> </dt_assoc> </item> </dt_assoc> </item> </dt_array> </data_block> </body> </OPS_envelope>
<?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_array> <item key="0"> <dt_assoc> <item key="protocol">XCP</item> <item key="action">reply</item> <item key="object">nameserver</item> <item key="add_to_all_registry"> <dt_assoc> <item key=".biz"> <dt_assoc> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command successful</item> </dt_assoc> </item> <item key=".cc"> <dt_assoc> <item key="is_success">1</item> <item key="response_code">200</item> successful</item> successful</item> successful</item> successful</item> successful</item> <item key="response_text">Command </dt_assoc> </item> <item key=".info"> <dt_assoc> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command </dt_assoc> </item> <item key=".name"> <dt_assoc> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command </dt_assoc> </item> <item key=".org"> <dt_assoc> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command </dt_assoc> </item> <item key=".us"> <dt_assoc> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command </dt_assoc> </item> </dt_assoc> </item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Nameserver Created</item> </dt_assoc> </item> </dt_array> </data_block> </body> </OPS_envelope>
Example 3
This example submits the create nameserver command without end-user
credentials and creates an IPv4 nameserver without adding it to any foreign
registries.
RequestResponse
<?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">create</item> <item key="object">nameserver</item> <item key="domain">example.com </item> <item key="attributes"> <dt_assoc> <item key="ipaddress">212.112 .123.11 </item> <item key="name">ns5.example .com</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">NAMESERVER</item> <item key="is_success">1</item> <item key="response_text">Nameserver Created</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 4
This example creates an IPv6 nameserver without adding to any foreign
registries.
RequestResponse
<?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">create</item> <item key="object">nameserver</item> <item key="domain">example.com </item> <item key="attributes"> <dt_assoc> <item key="name">ns1.example .com</item> <item key="ipv6">2a00:1450:4008:c00:0:0:0:1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">nameserver</item> <item key="response_text">Nameserver Created</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for create (nameserver)
Standard parameters
Attributes
Response parameters for create (nameserver)
Standard parameters
Examples for create (nameserver)
Example 1
Example 2
Example 3
Example 4
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
create subreseller
Creates a new sub-reseller account.
Suggest Edits
Request parameters for create subreseller
Standard parameters
action = create
object = subreseller attributes
Attributes
Parameters within the attributes associative array are described below.
Parameter nameParameter nameDefinition/Value
ccp_enabled Required Indicates whether credit card payments are allowed for the subreseller.
N—No
Y—Yes
contact_set Required Subreseller’s contact information.
The admin contact for a subreseller is the Emergency Contact, which is not the same as a domain admin contact.
The following values are required for the subreseller admin contact: first_name, last_name, org_name, phone, and email.
For tech contact, you can include any of the fields explained in the contact_set section;
however, you must include first_name,
last_name, org_name, address1, city, phone, and email.
If country is Canada or U.S , you must also include the state and postal code parameters.
low_balance_email Required The email address to which notices are sent when the subreseller's account balance falls to a predefined level.
nameservers Optional List of default nameservers for the subreseller.
password Required Password for the new subreseller account.
payment_email Optional The email address to which payment notices are sent.
pricing_plan Required The pricing plan assigned to the subreseller.
status Required Set the status of the account.
Allowed values are active, onhold, locked,
canceled, and paid_only.
system_status_email Required The email address that will receive system
status messages.
url Optional The web address of the account.
username Required Username for the new subreseller.
Response parameters for create subreseller
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 nameObligationDefinition/Value
reseller_id Returned if is_success = 1 The ID of the newly created subreseller.
Examples for create subreseller
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'>CREATE</item> <item key='object'>SUBRESELLER</item> <item key='attributes'> <dt_assoc> <item key='url'>testurl.com </item> <item key='nameservers'> <dt_assoc> <item key='fqdn1'>ns1.systemdns .com</item> <item key='fqdn2'>ns2.systemdns .com</item> </dt_assoc> </item> <item key='payment_email'>[email protected]</item> <item key='pricing_plan'>gold</item> <item key='status'>active</item> <item key='username'>sub1240929148892</item> <item key='contact_set'> <dt_assoc> <item key="admin"> <dt_assoc> <item key="email">[email protected]</item> <item key="phone">+1.4165551123x333 </item> <item key="phone2"></item> <item key="first_name">John</item> <item key="last_name">Doe</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="org_name">Sub Reseller Company Inc.</item> <item key="first_name">John</item> <item key="last_name">Doe</item> <item key="title">CEO</item> <item key="phone">+1.4165551122x333 </item> <item key="fax"></item> <item key="email">[email protected]</item> <item key="address1">55 Reseller Ave</item> <item key="address2">Suite 99</item> <item key="address3"></item> <item key="city">New York</item> <item key="state">NY</item> <item key="postal_code">70218</item> <item key="country">US</item> </dt_assoc> </item> </dt_assoc> </item> <item key='ccp_enabled'>n</item> <item key='low_balance_email'>[email protected]</item> <item key='password'>changeit</item> <item key='system_status_email'>[email protected]</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">SUBRESELLER</item> <item key="response_text">Sub-Reseller sub1240929148892 successfully created</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="reseller_id">9782</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for create subreseller
Standard parameters
Attributes
Response parameters for create subreseller
Standard parameters
Attributes
Examples for create subreseller
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
create_dns_zone
Enables the DNS service for a domain.
If you have created a DNS template, you can specify the template in the command to assign initial DNS records.
The template is then associated with the domain, so if you later issue the reset_dns_zone command, the records are set back to what is defined in the template.
If you specify blank instead of a DNS template when you issue this command, you can submit the values for the DNS records in this command or you can use the set_dns_zone command to define the DNS records.
For information on creating a DNS zone template, see “Managing DNS Zone Information” in the Reseller’s Guide to Domain Name Registration and Management.
Suggest Edits
Request parameters for create_dns_zone
Standard parameters
action = create_dns_zone
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationObligation
domain Required The domain for which you want to define DNS records.
dns_template Optional Specify the name of the DNS template that you want to use to enable DNS and assign initial DNS records.
If you do not submit this parameter, DNS is enabled but no records are defined.
In this case, you can submit the settings for the domain's DNS zone records (A, AAAA, CNAME, SRV, and TXT).
records Required A list of the record types defined for the domain; each record includes the settings for that record.
Record types may be
A
AAAA
CNAME
MX
SRV
TXT
Records
Parameters within the records associative array are described below.
Parameter nameObligationDefinition/Value
A Optional Maps the domain name to the IP address.
The A record consists of the following:
ip_address—Internet Protocol Address.
A numeric address that computers recognize, for example,
123.45 .54.123 .
subdomain—The third level of the domain name, such as www or ftp.
AAAA Optional Maps the domain name to the IPv6 address.
The AAAA record consists of the following:
ipv6_address— The next generation Internet Protocol designed as the successor to version 4.
It is normally written as eight groups of four hexadecimal digits (i.e .
2003:0db8:
85a3:0000:0000:8a2e:
0370:7334
subdomain—The third level of the domain name, such as www or ftp.
CNAME Optional Canonical Name.
CNAME records can be used when you want a subdomain to point to another hostname.
Allows you to create an alias for your domain.
The CNAME record consists of the following:
hostname—The FQDN of the domain that you want to access.
subdomain—The third level of the domain name, such as www or ftp.
MX Optional Mail Exchange.
MX records determine how mail is delivered to your domain.
Ensures that email that is sent to you is routed to the correct destination.
The MX record consists of the following:
priority—The priority of the target host,lower
value means more preferred.
subdomain—The third level of the domain
name, such as www or ftp.
* hostname—The FQDN of the domain that you
want to access.
SRV Optional Service Record.
The SRV record consists of the following:
priority—The priority of the target host,lower
value means more preferred.
weight—A relative weight for records with the
same priority.
subdomain—The third level of the domain
name, such as www or ftp.
hostname—The FQDN of the domain that you
want to access.
* port—The TCP or UDP port on which the service is to be found.
Response parameters for create_dns_zone
Standard parameters
action = reply
object = domain
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 nameObligationDefinition/Value
nameservers_ok Returned if is_success = true Indicates whether the domain is set up to use the OpenSRS nameservers.
0—Nameservers are not set to the DNS service nameservers
1—Nameservers are set to the DNS service nameservers
records Returned if is_success = true A list of the record types defined for the domain; each record includes the settings for that record.
Record types may be
A
AAAA
CNAME
MX
SRV
TXT
For more information, see the Records table below.
Records
Parameters within the records associative array are described below.
Parameter nameObligationDefinition/Value
A Optional Maps the domain name to the IP address.
The A record consists of the following:
ip_address—InternetProtocolAddress.A numeric address that computers recognize, for example, 123.45 .54.123 .
subdomain—The third level of the domain name, such as www or ftp.
AAAA Optional Maps the domain name to the IPv6 address.
The AAAA record consists of the following:
subdomain—The third level of the domain name, such as www or ftp.
ipv6_address— The next generation Internet Protocol designed as the successor to version 4.
It is normally written as eight groups of four hexadecimal digits (i.e .
2003:0db8:
85a3:0000:0000:8a2e:
0370:7334
CNAME Optional Canonical Name.
CNAME records can be used when you want a subdomain to point to another hostname.
Allows you to create an alias for your domain.
The CNAME record consists of the following:
hostname—The FQDN of the domain that you want to access.
subdomain—The third level of the domain name, such as www or ftp.
MX Optional Mail Exchange.
MX records determine how mail is delivered to your domain.
Ensures that email that is sent to you is routed to the correct destination.
The MX record consists of the following:
priority—The priority of the target host,lower value means more preferred.
subdomain—The third level of the domain name, such as www or ftp.
* hostname—The FQDN of the domain that you want to access.
SRV Optional Service Record.
The SRV record consists of the following:
priority—The priority of the target host,lower
value means more preferred.
weight—Arelative weight for records with the
same priority.
* subdomain—The third level of the domain name, such as www or ftp.
hostname—The FQDN of the domain that you want to access.
port—The TCP or UDP port on which the service is to be found.
TXT Optional Text Record.
Allows you to attach comments to a hostname, for example, SPF data to validate that email is being sent from the IP address of the domain's mail server.
The TXT record consists of the following:
subdomain—The third level of the domain
name, such as www or ftp.
text—The comments that you want to include.
Examples for create_dns_zone
Request
If template is specifiedIf template is not specified
<?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">create_dns_zone</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="dns_template">business_domains</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">create_dns_zone</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
If template is specifiedIf template is not specified
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="records"> <dt_assoc> <item key="A"> <dt_array> <item key="0"> <dt_assoc> <item key="subdomain"></item> <item key="ip_address">17.16 .156.5 </item> </dt_assoc> </item> </dt_array> </item> <item key="MX"> <dt_array> <item key="0"> <dt_assoc> <item key="priority">10</item> <item key="subdomain">www</item> <item key="hostname">example.org </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="priority">1</item> <item key="subdomain"></item> <item key="hostname">mx.cust .aug18dnstest1.com .hostedemail.com </item> </dt_assoc> </item> </dt_array> </item> <item key="SRV"> <dt_array> <item key="0"> <dt_assoc> <item key="priority">1</item> <item key="weight">3</item> <item key="subdomain">w3</item> <item key="hostname">yummynames.com </item> <item key="port">81</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> <item key="nameservers_ok">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="records"> <dt_assoc></dt_assoc> </item> <item key="nameservers_ok">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated 9 months ago
* * *
Table of Contents
Request parameters for create_dns_zone
Standard parameters
Attributes
Response parameters for create_dns_zone
Standard parameters
Attributes
Examples for create_dns_zone
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
create_domain_forwarding
Create domain forwarding service that is used to redirect visitors from one web address to another.
Once you create domain forwarding, you need to use the set_domain_forwarding command to configure the settings.
Suggest Edits
Request parameters for create_domain_forwarding
Standard parameters
action = create_domain_forwarding
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Optional The domain for which you want to enable domain forwarding.
Response parameters for create_domain_forwarding
Standard parameters
action = reply
object = domain
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 create_domain_forwarding
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">create_domain_forwarding</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </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">DOMAIN</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for create_domain_forwarding
Standard parameters
Attributes
Response parameters for create_domain_forwarding
Standard parameters
Examples for create_domain_forwarding
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
create_token
Creates a SiteLock account so that users can log in and manage the Trust Service product.
To use this command, the order cannot be in a pending state.
Suggest Edits
📘Note
The resulting URL is valid for only a limited period of time that may be as short as five minutes.
Request parameters
Standard request parameters
action = create_token
object = trust_service
Request attributes
Parameters within the attributes associative array are described below:
ParameterObligationDefinition/Value
order_id Required if product_id is not submitted The SSL service order ID number.
product_id Required if order_id is not submitted The SSL service product ID number.
* * *
Response parameters
Standard response parameters
action = reply
object = trust_service
is_success = Boolean 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.
Response attributes
If the request is successful, the attributes associative array may include the following:
ParameterObligationDefinition/Value
login_url Always returned The URL where the user can log in to manage the SiteLock product.
* * *
Example
RequestResponse
<?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">create_token</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="order_id">50094</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="is_success">1</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="login_url">https://www.sitelock .com/rlogin.php ?token=ccc038d24c91a7a67d0a12f46f29a260</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Response attributes
Example
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
delete (nameserver)
Deletes a nameserver, provided it is not currently serving a domain.
Suggest Edits
📘Note:
If the registry in which the nameserver object resides is serving a domain outside of OpenSRS, delete nameserver returns an error and the nameserver is not deleted.
Request parameters for delete (nameserver)
Standard parameters
action = delete
object = nameserver
registrant_ip = valid IP address of the registrant (optional)
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The relevant domain.
ipaddress Required if ipv6 is not submitted The IPv4 address of the nameserver.
You can specify ipaddress or ipv6, or both.
Note: This parameter is always required for .DE, even if ipv6 is submitted.
ipv6 Required if ipaddress is not submitted The IPv6 address of the nameserver.
You can specify ipaddress or ipv6, or both.
Note:This parameter is not supported for .CN.
name Required Fully qualified race-encoded domain name of the nameserver.
Response parameters for delete (nameserver)
Standard parameters
action = reply
object = nameserver
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 delete (nameserver)
Example 1
This example deletes an IPv4 nameserver.
RequestResponse
<?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">delete</item> <item key="object">nameserver</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="ipaddress">24.22 .112.11 </item> <item key="name">ns1.example .com</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">nameserver</item> <item key="response_text">Nameserver deleted</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
This example deletes an IPv6 nameserver.
RequestResponse
<?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">delete</item> <item key="object">nameserver</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="ipv6">2a00:1450:4008:c00:0:0:0:1</item> <item key="name">ns3.example .com</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">nameserver</item> <item key="response_text">Nameserver deleted</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for delete (nameserver)
Standard parameters
Attributes
Response parameters for delete (nameserver)
Standard parameters
Examples for delete (nameserver)
Example 1
Example 2
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
delete (subuser)
Deletes a subuser.
Suggest Edits
Request parameters for delete (subuser)
Standard parameters
action = delete
object = subuser
registrant_ip = valid IP address of the registrant (optional)
username = name of the user account
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The relevant domain.
sub_id Required The ID of the sub-user to be deleted.
Response parameters for delete (subuser)
Standard parameters
action = reply
object = subuser
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 delete (subuser)
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="attributes"> <dt_assoc> <item key="sub_id">2532880</item> </dt_assoc> </item> <item key="protocol">XCP</item> <item key="action">delete</item> <item key="object">subuser</item> <item key="domain">yourdomain.com </item> <item key="username">aaaa</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">SUBUSER</item> <item key="response_text">Command Successful</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for delete (subuser)
Standard parameters
Attributes
Response parameters for delete (subuser)
Standard parameters
Examples for delete (subuser)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
delete (surname)
Deletes the Personal Names domain.
This call can delete only one domain at a time.
Suggest Edits
Request parameters for delete (surname)
Standard parameters
action = delete
object = surname
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required Personal Names domain to be deleted.
Response parameters for delete (surname)
Standard parameters
action = reply
object = surname
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 delete (surname)
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">DELETE</item> <item key="object">SURNAME</item> <item key="attributes"> <dt_assoc> <item key="domain">steven.smith .net</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
SuccessfulFailed
<?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">SURNAME</item> <item key="response_text">In progress.
Request successfully submitted and placed in the queue</item> <item key="action">DELETE:REPLY</item> <item key="response_code">250</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">SURNAME</item> <item key="response_text">Domain not found or in unacceptable state for this action</item> <item key="action">DELETE:REPLY</item> <item key="response_code">424</item> <item key="is_success">0</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for delete (surname)
Standard parameters
Attributes
Response parameters for delete (surname)
Standard parameters
Examples for delete (surname)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
delete_dns_zone
Deletes the DNS zones defined for the specified domain.
Suggest Edits
Request parameters for delete_dns_zone
Standard parameters
action = delete_dns_zone
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The domain whose DNS you want to delete.
Response parameters for delete_dns_zone
Standard parameters
action = reply
object = domain
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 delete_dns_zone
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">delete_dns_zone</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </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">DOMAIN</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for delete_dns_zone
Standard parameters
Attributes
Response parameters for delete_dns_zone
Standard parameters
Examples for delete_dns_zone
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
delete_domain_forwarding
Delete the domain forwarding service for the specified domain.
Suggest Edits
Request parameters for delete_domain_forwarding
Standard parameters
action = delete_domain_forwarding
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Optional The domain for which you want to delete domain forwarding.
Response parameters for delete_domain_forwarding
Standard parameters
action = reply
object = domain
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 delete_domain_forwarding
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">delete_domain_forwarding</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </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">DOMAIN</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for delete_domain_forwarding
Attributes
Response parameters for delete_domain_forwarding
Standard parameters
Examples for delete_domain_forwarding
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Domain contacts
Suggest Edits
This section lists domain contacts for the following TLDs:
.BE owner and tech contact requirements
.CA owner, admin, and tech contact requirement
.DE owner contact requirements
.ES postal codes
.EU owner and tech contact requirements
.IT contact requirements
.MX contact requirements
.PRO contact requirements
.UK transfer-no change-admin contact requirements
.UK contact requirements
Trust (SSL) Service contacts
Trust (SSL) Service Admin, Billing, Signer and Tech contact requirements
Trust (SSL) Service Organization contact requirements
The following tables list the contacts that are required for each gTLD and ccTLD.
gTldOwnerAdminBillingTech
.aero √ √ √ √
.asia √ √ √ √
.biz √ √ √ √
.coop √ √ √ √
.com √ √ √ √
.info √ √ √ √
.jobs √ √ √ √
.mobi √ √ √
.name √ √ √ √
.net √ √ √ √
.org √ √ √ √
.pro √ √ √ √
.tel √ √ √ √
.xxx √ √ √ √
ccTldOwnerAdminBillingTech
.ac √ √ √ √
.ae √ √ √
.af (.af, .com.af , .net.ag , .org.af ) √ √ √ √
.ag (.ag, .co.ag , .com.ag , .net.ag ,
.nom.ag , .org.ag ) √ √ √ √
.ai (.com.ai , .net,ai, .off.ai , .org.ai ) √ √ √
.am √ √ √ √
.ar (.com.ar ) √ √ √
.as √ √ √
.at √ √ √ √
.au (.asn.au , .com.au , .net.au , .id.au , .org.au ) √ √
.be √ √
.br (.com.br ) √ √ √ √
.bz √ √ √ √
.ca √ √ √
.cc √ √ √ √
.cd √ √ √
.ch √
.cl √ √ √
.cm
.co.cm
.com.cm
.net.cm √
√
√
√ √
√
√
√ √ √
√
√
√
.co (.co, .com.co , .net.co , .nom.co ) √ √ √ √
.cx √ √ √ √
.cz √ √
.de √
.dk √ √ √ √
.ec (.ec, .com.ec , .fin.ec , .info.ec , .med.ec , .net.ec , .pro.ec ) √ √ √ √
.es (.es, .com.es , .nom.es , .org.es ) √ √ √ √
.eu √ √
.fi √ √ √
.fm √ √ √ √
.fr √ √ √
.gd √ √ √ √
.gg (.gg, .co.gg , .net.gg , .org.gg ) √
.gl (.gl, .co.gl , .com.gl , .net.gl , .org.gl ) √ √ √ √
.gr (.com.gr , .edu.gr , .net.gr , .org.gr ) √
.gs √ √ √
.gy (.gy,
.co.gy ,
.com.gy , .net.gy ) √ √ √
.hk √ √ √ √
.hm √ √ √
.hn (.hn, .com.hn , .net.hn , .org.hn ) √ √ √ √
.hr (.com.hr ) √ √ √
.ht (.ht, .com.ht , .info.ht , .net.ht , .org,ht) √ √ √
.hu (.hu, .co.hu ) √ √ √
.il (.co.il ) √ √ √
.im (.im, .co.im , .com.im , .net.im , .org.im ) √ √ √ √
.in (.in, .co.in , .firm.in , .gen.in , .ind.in , .net.in , .org.in ) √ √ √ √
.io √ √ √ √
.is √ √ √
.it √ √ √
.je (.je, .co.je ) √
.jp √ √ √
.kg √ √
.ki (.biz.ki , .com.ki , .info.ki , .mobi.ki , .net.ki , .tel.ki ) √ √ √
.kr √ √
.co.kr √ √ √
.la √ √ √
.lc (.lc, .co.lc , .com.lc , .l.lc , .net.lc , .org.lc , .p.lc ) √ √ √
.li √
.lt √ √ √
.lu √ √ √
.lv √ √
.com.lv √ √ √
.ly (.ly, .com.ly ) √ √ √
.ma √
.co.ma √ √ √
.md √ √ √ √
.me √ √ √ √
.mn √ √ √ √
.ms √ √ √ √
.mu √ √ √ √
.mx (.mx, .com.mx ) √ √ √ √
.my (.my, .com.my , .net.my , .org.my ) √ √
.nl √ √ √
.no √ √ √ √
.nu √ √ √ √
.nz (.co.nz , .net.nz , .org.nz ) √ √ √ √
.pe (.pe, .com.pe , .net.pe ) √ √ √ √
ph (.ph, .com.ph , .net.ph , .org.ph ) √ √ √
.pl (.pl, .biz.pl .com.pl , .edu.pl , .info.pl , .net.pl , .nom.pl , .org.pl , .shop.pl , .waw.pl ) √
.pm √ √ √
.pr (.com.pr ) √ √ √
.pt (.pt, .com.pt ) √
.pw √ √ √
.qa √ √ √
.re √ √ √
.ro (.ro, .com.ro ) √ √
.ru (.ru, .com.ru ) √ √ √
.sb (.com.sb , .net.sb , .org.sb ) √ √ √
.sc
.com.sc
.net.sc
.org.sc √
√
√
√ √
√
√
√ √ √
√
√
√
.se √
.sg √ √ √
.sh √ √ √ √
.si √ √ √
.so (.so, .com.so , .net.so , .org.so ) √ √ √ √
.sr √ √ √
.st √ √ √ √
.sx √
.tc √ √ √ √
.tf √ √ √
.tk √ √ √ √
.tl √ √ √
.tm √ √ √
.to √
.tv √ √
.tw (.tw, .com.tw , .org.tw , idv.tw ) √ √ √ √
.ua (.com.ua ) √ √ √
.uk (.co.uk , .ltd.uk , .me.uk , .net.uk , .org.uk , .plc.uk ) √ √
.us √ √ √ √
.uy (.com.uy ) √ √ √
.vc (.vc, .com.vc , .net.vc , .org.vc ) √ √ √ √
ve (.co.ve , .com.ve ) √ √ √
.vg √ √ √ √
.wf √ √ √
.ws √ √ √ √
.yt √ √ √
.za (.co.za ) √ √
Default (EPP) contact requirements
The following contact requirements are default for all gTLD domains unless otherwise specified on the page:
Parameter nameObligationFormat/Constraints
first_name Required Maximum 64 alphanumeric characters.
last_name Required Maximum 64 alphanumeric characters.
org_name Required Maximum 64 alphanumeric characters.
address1 Required Maximum 64 alphanumeric characters.
address2 Optional Maximum 64 alphanumeric characters.
address3 Optional Maximum 64 alphanumeric characters.
city Required Maximum 64 alphanumeric characters.
state Required if country = CA or
US
Not required for .NL Maximum 32 alphanumeric characters.
postal_code Required Maximum 16 alphanumeric characters.
Note: For .NL, ensure that the postal code does not include any spaces.
country Required 2 letter ISO country code.
phone Required Maximum 20 alphanumeric characters, syntax verified according to EPP.
fax Optional Maximum 20 alphanumeric characters, in the format +CCC.NNNNNNNNNNxEEEE , where C = country code, N = phone number, and E = extension (optional).
email Required Maximum 64 characters to left of and 63 characters right of "@" sign, alphanumeric characters, validated according to rfc822..BE owner and tech contact requirements
Two contacts are required for .BE domains: 'owner' and 'tech'.
If you submit other contact types, they are ignored.
Parameter nameObligationFormat/Constraints
first_name Required Maximum length: 64 alphanumeric characters.
last_name Required Maximum length: 64 alphanumeric characters.
org_name Required Maximum length: 64 alphanumeric characters.
address1 Required Maximum length: 100 alphanumeric characters.
address2 Optional Maximum length: 100 alphanumeric characters.
address3 Optional Maximum length: 100 alphanumeric characters.
city Required Maximum length: 64 alphanumeric characters.
state Required if country = CA or
US Maximum length: 32 alphanumeric characters.
postal_code Required Maximum length: 20 alphanumeric characters.
country Required Maximum length: 2 alphanumeric characters.
phone Required Maximum length: 20 alphanumeric characters, in the format +CCC.NNNNNNNNNNxEEEE , where C = country code, N = phone number, and E = extension (optional).
fax Optional Maximum length: 20 alphanumeric characters, syntax verified according to EPP.
email Required Maximum length: 255 alphanumeric characters, validated according to rfc822.
lang Required Maximum length: 2 alpha characters, must be one of designated languages for .BE (see the language list for .BE).
vat Optional Valid Value-Added Tax registration number of the contact..CA owner, admin, and tech contact requirements
Parameter nameObligationFormat/Constraints
first_name Required Maximum length: 64 alphanumeric characters.
last_name Required Maximum length: 64 alphanumeric characters.
org_name Required for all except domains using the following legal types (full list here under legal_type):
ABO => 'Aboriginal Peoples (individuals or groups) indigenous to Canada'
CCT => 'Canadian citizen'
LGR => 'Legal Representative of a Canadian Citizen or Permanent Resident'
RES => 'Permanent Resident of Canada' Maximum length: 64 alphanumeric characters.
address1 Required Maximum length: 100 alphanumeric characters.
address2 Optional Maximum length: 100 alphanumeric characters.
address3 Optional Maximum length: 100 alphanumeric characters.
city Required Maximum length: 64 alphanumeric characters.
state Required A valid 2 letter code for the Canadian province.
Alberta = AB
British Columbia = BC
Manitoba = MB
New Brunswick = NB
Newfoundland and Labrador = NL
Northwest Territories = NT
Nova Scotia = NS
Nunavut = NU
Ontario = ON
Prince Edward Island = PE
Quebec = QC
Saskatchewan = SK
* Yukon = YK
postal_code Required Maximum length: 32 alphanumeric characters.
country Required Maximum length: 2 alphanumeric characters
phone Required Maximum length: 20 alphanumeric characters, in the format +CCC.NNNNNNNNNNxEEEE , where C = country code, N = phone number, and E = extension (optional).
fax Optional Maximum length: 20 alphanumeric characters.
email Required Maximum length: 255 alphanumeric characters, validated according to rfc822.
lang Required The contact's preferred language.
The default is English.
Allowed values are:
EN = English
FR = French
.DE owner contact requirements
Parameter nameObligationFormat/Constraints
first_name Required Maximum length: 64 alphanumeric characters.
last_name Required Maximum length: 64 alphanumeric characters.
org_name Required Maximum length: 64 alphanumeric characters.
address1 Required Maximum length: 100 alphanumeric characters.
address2 Optional Maximum length: 100 alphanumeric characters.
address3 Optional Maximum length: 100 alphanumeric characters.
city Required Maximum length: 64 alphanumeric characters.
state Required if country = CA or
US Maximum length: 32 alphanumeric characters.
postal_code Required Maximum length: 20 alphanumeric characters.
country Required Maximum length: 2 alphanumeric characters.
phone Required Maximum length: 20 alphanumeric characters, in the format +CCC.NNNNNNNNNNxEEEE , where C = country code, N = phone number, and E = extension (optional).
fax Optional Maximum length: 20 alphanumeric characters, if not null syntax verified according to EPP.
email Required Maximum length: 255 alphanumeric characters, validated according to rfc822.
📘Additional rules
SUM (first_name last_name address1 address2 address3 postal_code city) must not exceed 248 characters.
SUM (org_name address1 address2 address3) not to exceed 255 characters..ES postal codes
When registering a .ES name, the postal code must correspond to the province for each of the contacts.
Refer to the chart below for the two digit postal code prefix that applies to each province.
Postal code prefixProvincePostal code prefixProvince
01 Araba 27 Lugo
02 Albacete 28 Madrid
03 Alicante 29 Malaga
04 Almeria 30 Murcia
05 Avila 31 Navarr
06 Badajoz 32 Ourense
07 Illes Balears 33 Asturias
08 Barcelona 34 Palencia
09 Burgos 35 Palmas, Las
10 Caceres 36 Pontevedra
11 Cadiz 37 Salamanca
12 Castellon 38 Santa Cruz de Tenerife
13 Ciudad Real 39 Cantabria
14 Cordoba 40 Segovia
15 Coruña, A 41 Sevilla
16 Cuenca 42 Soria
17 Girona 43 Tarragona
18 Granada 44 Teruel
19 Guadalajara 45 Toledo
20 Gipuzkoa 46 Valencia
21 Huelva 47 Valladolid
22 Huesca 48 Bizkaia
23 Jaen 49 Zamora
24 Leon 50 Zaragoza
25 Lleida 51 Ceuta
26 Rioja, La 52 Melilla
.EU owner and tech contact requirements
Only two contacts are accepted for .EU domains: 'owner' and 'tech'.
If you submit other contact types, they are ignored.
Parameter nameObligationFormat/Constraints
first_name Required Maximum length: 64 alphanumeric characters.
last_name Required Maximum length: 64 alphanumeric characters.
org_name Required Maximum length: 64 alphanumeric characters.
address1 Required Maximum length: 100 alphanumeric characters.
address2 Optional Maximum length: 100 alphanumeric characters.
address3 Optional Maximum length: 100 alphanumeric characters.
city Required Maximum length: 64 alphanumeric character
state Optional Maximum length: 32 alphanumeric characters.
postal_code Optional Maximum length: 20 alphanumeric characters.
country Required Maximum length: 2 alphanumeric characters, for owner contact the country must be one of the designated countries for .EU (see the country list for .EU).
phone Required Maximum length: 15 alphanumeric characters, in the format +CCC.NNNNNNNNNN , where C = country code and N = phone number.
fax Optional Maximum length: 20 alphanumeric characters, if not null syntax verified according to EPP.
email Required Maximum length: 255 alphanumeric characters, validated according to rfc822.
lang Required Maximum length: 2 alpha characters, must be one of designated languages for .EU (see the language list for .EU).
vat Optional Valid Value-Added Tax registration number of the requesting contact..IT contact requirements
Parameter nameObligationFormat/Constraints
first_name Required Maximum length: 64 alphanumeric characters.
last_name Required Maximum length: 64 alphanumeric characters.
org_name Required if entity_type is not 1 Maximum length: 64 alphanumeric characters.
address1 Required Maximum length: 100 alphanumeric characters.
address2 Optional Maximum length: 100 alphanumeric characters.
address3 Optional Maximum length: 100 alphanumeric characters.
city Required Maximum length: 64 alphanumeric characters.
state Required Maximum length: 32 alphanumeric characters.
If country = IT, province must be a valid Italian province.
(See http://en.wikipedia .org/wiki/ISO_3166-2:IT ).
postal_code Required Maximum length: 16 alphanumeric characters.
If country = IT, postal_code must be a valid Italian postal code.
(See http://en.wikipedia .org/wiki/List_of_postal_codes_in_Italy)
country Required The ISO 3166-1 country code for the owner contact.
Maximum length: 2 alphanumeric characters.
(See nationality_code for requirements.)
Note: Be sure to use capital letters.
phone Required Maximum length: 20 alphanumeric characters, in the format +CCC.NNNNNNNNNNxEEEE , where C = country code, N = phone number, and E = extension (optional).
fax Optional Maximum length: 20 alphanumeric characters, if not null syntax verified according to EPP.
email Required Maximum length: 100 alphanumeric characters, validated according to rfc822.
entity_type Required A numeric entry that indicates the type of domain owner.
Valid values are:
1—Italian and foreign natural persons
2—Companies/one man companies
3—Freelance workers/professionals
4—Non-profit organizations
5—Public organizations
6—Other subjects
* 7—Foreigners who match 2-6
nationality_code Optional The ISO 3166-1 code for the nationality of the domain owner.
Maximum length: 2 alphanumeric characters.
If entity_type = 1, nationality or owner's country or both must be an EU country.
If entity_type = 2-6, this value must be IT.
If entity_type = 7, this value must match owner's
country and must be an EU country other than IT.
Note: Be sure to use capital letters.
reg_code Required An identifying number, usually the VAT or Codice Fiscale (numeric tax code).
The value that you need to enter depends on the entity type of the registrant.
Italian citizens must enter their Codice Fiscale.
Non Italians not living in Italy can enter n.a .
Italian companies, freelancers, and other subjects must enter their 11 digit VAT number or tax indentification number.
Italian non-profit organizations must enter their VAT number or tax identification number; however, if they do not have one,they can enter n.a .
* Non Italian entities other than persons (organizations, freelancers, companies, etc.) may enter their VAT number or n.a ..MX contact requirements
Parameter nameObligationFormat/Constraints
first_name Required Maximum 64 alphanumeric characters.
last_name Required Maximum 64 alphanumeric characters.
org_name Required Maximum 64 alphanumeric characters.
address1 Required Maximum 64 alphanumeric characters.
address2 Optional Maximum 64 alphanumeric characters.
address3 Optional Maximum 64 alphanumeric characters.
city Required Maximum 64 alphanumeric characters.
state/province Required if country = CA, MX, or US A valid 2 letter code for the state or province.
postal_code Required Maximum 16 alphanumeric characters.
country Required 2 letter ISO country code.
phone Required Maximum 20 alphanumeric characters, syntax verified according to EPP.
fax Optional Optional
Maximum 20 alphanumeric characters, in the format +CCC.NNNNNNNNNNxEEEE , where C = country code, N = phone number, and E = extension (optional).
email Required Maximum 64 characters to left of and 63 characters right of "@" sign, alphanumeric characters, validated according to rfc822..PRO contact requirements
The PRO registry does not support extensions in phone and fax numbers.
If you include an extension in the number, for example, +1.4165550123x1234 , the string will be accepted, but the registry drops the extension part of the number and the resulting number becomes +1.4165550123 ..UK transfer-no change-admin contact requirements
Note: The admin contact information is only used by OpenSRS, and the information is not forwarded to the .UK registry.
Parameter nameObligationFormat/Constraints
first_name Optional Maximum length: 64 alphanumeric characters.
last_name Optional Maximum length: 64 alphanumeric characters.
org_name Optional Maximum length: 64 alphanumeric characters.
address1 Optional Maximum length: 100 alphanumeric characters.
address2 Optional Maximum length: 100 alphanumeric characters.
address3 Optional Maximum length: 100 alphanumeric characters.
city Optional Maximum length: 64 alphanumeric characters.
state Optional Maximum length: 32 alphanumeric characters.
postal_code Optional Maximum length: 32 alphanumeric characters.
country Optional Maximum length: 2 alphanumeric characters
phone Optional Maximum length: 20 alphanumeric characters, in the format +CCC.NNNNNNNNNNxEEEE , where C = country code, N = phone number, and E = extension (optional), 7 bit ASCII only.
fax Optional Maximum length: 20 alphanumeric characters.
email Required Maximum length: 255 alphanumeric characters, validated according to rfc822..UK contact requirements
Note: Technical contact information is not required or accepted for .UK.
Parameter nameObligationFormat/Constraints
first_name Required Maximum length: 64 alphanumeric characters.
last_name Required Maximum length: 64 alphanumeric characters.
org_name Required Maximum length: 64 alphanumeric characters.
*Must Contain: First Name/Last Name if Individual OR Company name if Organization, cannot be "None"
address1 Required Maximum length: 100 alphanumeric characters.
address2 Optional Maximum length: 100 alphanumeric characters.
address3 Optional Maximum length: 100 alphanumeric characters.
city Required Maximum length: 64 alphanumeric characters.
state Required if country = CA or
US Maximum length: 32 alphanumeric characters.
postal_code Required Maximum length: 32 alphanumeric characters.
country Required Maximum length: 2 alphanumeric characters.
phone Required Maximum length: 20 alphanumeric characters, in the format +CCC.NNNNNNNNNNxEEEE , where C = country code, N = phone number, and E = extension (optional).
fax Optional Maximum length: 20 alphanumeric characters.
email Required Maximum length: 255 alphanumeric characters, validated according to rfc822.
Trust Service contacts
This table lists the contacts that are required for each of the available Trust Service products.
Comodo
AdminBillingTechOrganizationSigner
EV SSL X X X
InstantSSL
PremiumSSL X
PremiumSSL Wildcard
SSL X
SSL Wildcard
GeoTrust
AdminBillingTechOrganizationSigner
QuickSSL X X X
QuickSSL Premium
True BusinessID X X X X
True BusinessID Wildcard
True BusinessID with EV X X X X
SiteLock
AdminBillingTechOrganizationSigner
Basic X
Premium X
SMB Enterprise Secure X
Find X
Fix X
Prevent X
911 X
Symantec
AdminBillingTechOrganizationSigner
SecureSite X X X X
SecureSite
SecureSite with EV X X X X
SecureSite Pro with EV
thawte
AdminBillingTechOrganizationSigner
SSL123 X X X X
SGC SuperCerts
SSL Webserver Certificate X X X X
SSL Webserver Certificate with EV
SSL Webserver Certificate Wildcard X X X X
TRUSTe
AdminBillingTechOrganizationSigner
Privacy Policy X
Privacy Policy with Seal
Trustwave
AdminBillingTechOrganizationSigner
Domain Vetted (DV) X
Premium EV
Premium SSL X
Premium SSL Wildcard
Trust Service Admin, Billing, Signer and Tech contact requirements
Most of the Trust Service products require Admin, Billing, and Tech contact details.
Please note the following exceptions:
Trustwave certificates require only the Admin contact and must include first_name, last_name, address1, city, postal_code, state, country, email, and phone.
Comodo certificates, other than EV, require only the Organization contact, and must include org_name, address1, city, postal_code, state, country, and email.
Comodo EV certificates require Organization, Admin, and Signer contacts, and must include address1, city, postal_code, state, country, email, title, first_name, last_name, phone, and org_name (only for Organization contact).
Note: Fields cannot contain leading or trailing white-spaces.
Parameter nameObligationFormat/Constraints
first_name Required Maximum 64 alphanumeric characters.
last_name Required Maximum 64 alphanumeric characters.
title Required for thawte and Symantec certs as well as truebizid_ev certs Maximum 64 alphanumeric characters.
org_name org_name Maximum 64 alphanumeric characters.
address1 Required Maximum 100 alphanumeric characters.
address2 Optional Maximum 100 alphanumeric characters.
address3 Optional Maximum 100 alphanumeric characters.
city Required Maximum 64 alphanumeric characters.
state Required if country = CA, US, or .ES Maximum 32 alphanumeric characters.
postal_code Required if country = CA or US Maximum 32 alphanumeric characters.
country Required 2 letter ISO country code
phone Required Maximum 20 characters, in the format +CCC.NNNNNNNNNNxEEEE , where C = country code, N = phone number, and E = extension (optional).
fax Optional Maximum 20 alphanumeric characters.
email Required Maximum 255 alphanumeric characters, validated according to rfc822.
Trust Service Organization contact requirements
Organization vetted certificates require Organization contact details.
Parameter nameObligationFormat/Constraints
first_name Optional Maximum 64 alphanumeric characters.
last_name Optional Maximum 64 alphanumeric characters.
org_name Required Maximum 64 alphanumeric characters.
address1 Required Maximum 100 alphanumeric characters.
address2 Optional Maximum 100 alphanumeric characters.
address3 Optional Maximum 100 alphanumeric characters.
city Required Maximum 64 alphanumeric characters.
state Required if country = CA, US, or .ES Maximum 32 alphanumeric characters.
postal_code Required if country = CA or US Maximum 32 alphanumeric characters.
country Required 2 letter ISO country code.
phone Required Maximum 20 characters, in the format +CCC.NNNNNNNNNNxEEEE , where C = country code, N = phone number, and E = extension (optional).
fax Optional Maximum 20 alphanumeric characters.
Updated almost 2 years ago
* * *
Table of Contents
This section lists domain contacts for the following TLDs:
Default (EPP) contact requirements
.BE owner and tech contact requirements
.CA owner, admin, and tech contact requirements
.DE owner contact requirements
.ES postal codes
.EU owner and tech contact requirements
.IT contact requirements
.MX contact requirements
.PRO contact requirements
.UK transfer-no change-admin contact requirements
.UK contact requirements
Trust Service contacts
Trust Service Admin, Billing, Signer and Tech contact requirements
Trust Service Organization contact requirements
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Domain Event: Created
This event notification will be generated when a domain is added to the system as a result of any number of actions, including registration, transfer completion, redemption, back-end import, etc.
Suggest Edits
Response Parameters for created (domain)
If the request is successful, the attributes associative array may include the
following:
Parameter nameObligationDefinition/Value
expiration_date Always returned.
The date upon which the domain is set to expire.
This is returned in UTC ISO8601 format ( Example: 2016-10-14T18:23:40Z).
Example Response for created (domain)
<?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">EVENT</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="transaction_id">2014-06-19 11:31:49 27660 101</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="events"> <dt_array> <item key="0"> <dt_assoc> <item key="object_data"> <dt_assoc> <item key="domain_name">tucows-13e97b6ef1b1c.com </item> <item key="domain_id">808369</item> <item key="expiration_date">2015-06-19T11:31:47Z</item> </dt_assoc> </item> <item key="object">DOMAIN</item> <item key="event_id">9c3baadb1fae18754ce5d86d94da6ded</item> <item key="event">CREATED</item> <item key="event_date">2014-06-19T15:31:47Z</item> </dt_assoc> </item> </dt_array> </item> <item key="total">6</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 2 years ago
* * *
Table of Contents
Response Parameters for created (domain)
Example Response for created (domain)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Domain Event: Deleted
This event notification will be generated when a domain is deleted from the system.
Suggest Edits
Response Parameters for deleted (domain)
The attributes associative array may include the
following:
Parameter nameObligationDefinition/Value
deletion_date Always returned.
The date upon which the domain was deleted
reason Always returned.
The reason for the deletion.
Possible values include:
expired
transfered
auction
historical
by-request
delete-domain-api
redemption_grace_period_end_date Always returned.
The date upon which the redemption grace period end.
This is returned in UTC ISO8601 format (Example: 2016-10-14T18:23:40Z)
Example for deleted (domain)
<?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">EVENT</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="transaction_id">2014-06-19 11:32:54 27661 101</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="events"> <dt_array> <item key="0"> <dt_assoc> <item key="object_data"> <dt_assoc> <item key="domain_name">tucows-845d85fa0ca51.com </item> <item key="redemption_grace_period_end_date"></item> <item key="domain_id">808364</item> <item key="reason">delete-domain-api</item> <item key="deletion_date">2014-06-19T15:32:49Z</item> </dt_assoc> </item> <item key="object">DOMAIN</item> <item key="event_id">8e8c5213c8ae7be450af44e9918a9d97</item> <item key="event">DELETED</item> <item key="event_date">2014-06-19T15:32:49Z</item> </dt_assoc> </item> </dt_array> </item> <item key="total">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 4 years ago
* * *
Table of Contents
Response Parameters for deleted (domain)
Example for deleted (domain)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Domain Event: Expired
This event notification is generated when a domain has reached day 0 without being renewed.
Suggest Edits
Response Parameters for expired (domain)
If the request is successful, the attributes associative array may include the
following:
ParametersObligationDefinition/Value
expiration_date Always returned.
The date upon which the domain expired.
This is returned in UTC ISO8601 format (Example: 2016-10-14T18:23:40Z)
Example Response for expired (domain)
XML
<?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">EVENT</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="transaction_id">2014-06-19 13:43:51 8716 101</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="events"> <dt_array> <item key="0"> <dt_assoc> <item key="object_data"> <dt_assoc> <item key="domain_name">unit-test-single-status-register-1311624340.info </item> <item key="domain_id">258459</item> <item key="expiration_date">2014-06-19T00:00:00Z</item> </dt_assoc> </item> <item key="object">DOMAIN</item> <item key="event_id">173be0ca55cfd70e8e73bf4d30cd25ce</item> <item key="event">EXPIRED</item> <item key="event_date">2014-06-19T17:43:36Z</item> </dt_assoc> </item> </dt_array> </item> <item key="total">3</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Response Parameters for expired (domain)
Example Response for expired (domain)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Domain Event: message_status_change
Suggest Edits
Response Parameters for message_status_change (domain)
If the request is successful, the attributes associative array may include the
following:
Parameter nameObligationDefinition/Value
message_status Always returned The updated status of the message.
Possible values are:
Queued
Sent
* Bounced
message_type Always returned The type of message.
reference_id Always returned The unique message ID.
Example Response for message_status_change (domain)
<?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">EVENT</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="transaction_id">2016-12-02 15:24:56 10026 101</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="events"> <dt_array> <item key="0"> <dt_assoc> <item key="object_data"> <dt_assoc> <item key="domain_name">somedomain.com </item> <item key="message_type">enduser.icann .trade.new .registrant.approval </item> <item key="domain_id">310499</item> <item key="message_status">QUEUED</item> <item key="reference_id">7814e71bb27b751a33bd79555c08e7546b70ce9b4156cbdea8284864b01733cd104a36e1</item> <item key="to_address">[email protected]</item> </dt_assoc> </item> <item key="object">DOMAIN</item> <item key="event_id">d417c52e31e3ff537a034e982546b64f</item> <item key="event">MESSAGE_STATUS_CHANGE</item> <item key="event_date">2016-12-02T20:24:27Z</item> </dt_assoc> </item> </dt_array> </item> <item key="total">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 2 years ago
* * *
Table of Contents
Response Parameters for message_status_change (domain)
Example Response for message_status_change (domain)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Domain Event: nameserver_update
This event notification is generated when the nameservers set for a domain have changed.
Suggest Edits
Response Parameters for nameserver_update (domain)
If the request is successful, the attributes associative array may include the
following:
Parameter nameObligationDefinition/Value
nameserver_list Always returned.
An array of nameservers, as set at the moment of this event.
Response Example for nameserver_update (domain)
<?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">EVENT</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="transaction_id">2014-06-19 11:32:29 27661 101</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="events"> <dt_array> <item key="0"> <dt_assoc> <item key="object_data"> <dt_assoc> <item key="domain_name">tucows-13e97b6ef1b1c.com </item> <item key="domain_id">808369</item> <item key="nameserver_list"> <dt_array> <item key="0">parking1.mdnsservice .com</item> <item key="1">parking2.mdnsservice .com</item> </dt_array> </item> </dt_assoc> </item> <item key="object">DOMAIN</item> <item key="event_id">b5eeb0e98f95563b72309755e0bfd172</item> <item key="event">NAMESERVER_UPDATE</item> <item key="event_date">2014-06-19T15:32:28Z</item> </dt_assoc> </item> </dt_array> </item> <item key="total">2</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Response Parameters for nameserver_update (domain)
Response Example for nameserver_update (domain)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Domain Event: Registered
This event notification is generated when a domain registration has completed.
Suggest Edits
Response Parameters for registered (domain)
If the request is successful, the attributes associative array may include the
following:
Response parameterObligationDefinition/Value
expiration_date Always returned.
The date upon which the domain is set to expire.
This is returned in UTC ISO8601 format (Example: 2016-10-14T18:23:40Z)
period Always returned.
The length of the registration period in years
Example Response for registered (domain)
<?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">EVENT</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="transaction_id">2014-06-19 11:31:44 27661 101</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="events"> <dt_array> <item key="0"> <dt_assoc> <item key="object_data"> <dt_assoc> <item key="domain_name">s-tucows-13e97b6ef1b1c.com </item> <item key="period">1</item> <item key="domain_id">808368</item> <item key="expiration_date">2015-06-19T15:31:42Z</item> </dt_assoc> </item> <item key="object">DOMAIN</item> <item key="event_id">d282cd475f22b1b0c023de478235e0dc</item> <item key="event">REGISTERED</item> <item key="event_date">2014-06-19T15:31:43Z</item> </dt_assoc> </item> </dt_array> </item> <item key="total">7</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 2 years ago
* * *
Table of Contents
Response Parameters for registered (domain)
Example Response for registered (domain)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Domain Event: registrant_verification_status_change
This event notification is generated when there is a change to the registrant verification status for a domain.
This provides an update on the state of a registrant's verification.
Suggest Edits
Response Parameters for registrant_verification_status_change (domain)
If the request is successful, the attributes associative array may include the
following:
Parameter nameObligationDefinition/Value
verification_status Always returned.
The status of the verification.
Possible values include:
unverified The verification process has not been initiated.
The domain does not need to be verified.
pending - The verification process has been initiated, and the verification email will be sent to the registrant.
verifying - The verification process has been initiated and is waiting for registrant response.
verified - The registrant has been verified.
suspended - The domain is suspended and we interrupt the DNS to prevent the domain from resolving.
The domain will be placed on ClientHold.
admin_reviewing - The registrant data has been submitted and is being verified manually by the Tucows Compliance team.
bounced - The registrant verification that we sent from OpenSRS has bounced.
not_applicable
Example Response for registrant_verification_status_change
<?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">EVENT</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="transaction_id">2014-06-19 11:31:49 27660 101</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="events"> <dt_array> <item key="0"> <dt_assoc> <item key="object_data"> <dt_assoc> <item key="domain_name">tucows-13e97b6ef1b1c.com </item> <item key="domain_id">808369</item> <item key="verification_status">pending</item> </dt_assoc> </item> <item key="object">DOMAIN</item> <item key="event_id">f430be6ae0ff7600a1b5214125b0e079</item> <item key="event">REGISTRANT_VERIFICATION_STATUS_CHANGE</item> <item key="event_date">2014-06-19T15:31:48Z</item> </dt_assoc> </item> </dt_array> </item> <item key="total">6</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated almost 3 years ago
* * *
Table of Contents
Response Parameters for registrant_verification_status_change (domain)
Example Response for registrant_verification_status_change
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Domain Event: Renewed
This event notification is generated when a renewal is processed for a domain, whether it be through auto-renewal, or a manually created renewal order.
Suggest Edits
Response Parameters for renewed (domain)
If the request is successful, the attributes associative array may include the
following:
Parameter nameObligationDefinition/Value
expiration_date Always returned.
The date upon which the domain is set to expire.
This is returned in UTC ISO8601 format (Example: 2016-10-14T18:23:40Z)
period Always returned.
The length of the registration period in years.
<?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">EVENT</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="transaction_id">2014-06-19 11:32:18 27657 101</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="events"> <dt_array> <item key="0"> <dt_assoc> <item key="object_data"> <dt_assoc> <item key="domain_name">tucows-13e97b6ef1b1c.com </item> <item key="period">1</item> <item key="domain_id">808369</item> <item key="expiration_date">2016-06-19T15:31:47Z</item> </dt_assoc> </item> <item key="object">DOMAIN</item> <item key="event_id">09c200310d163449b2da98d31761f30c</item> <item key="event">RENEWED</item> <item key="event_date">2014-06-19T15:32:16Z</item> </dt_assoc> </item> </dt_array> </item> <item key="total">4</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Response Parameters for renewed (domain)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Domain Event: zone_check_status_change
Applicable only for .de and .fr domains, this event notification will be generated when the DNS/ZONE check has passed or failed at the registry.
If the DNS/ZONE check remains invalid for an extended period, there is a risk that the domain will be disabled by the registry.
Suggest Edits
Response Parameters for zone_check_status_change (domain)
If the request is successful, the attributes associative array may include the
following:
Parameter nameObligationDefinition/Value
zone_check_status Always returned The updated result or status of the DNS/zone check.
Possible values include:
* valid invalid
Example Response for (zone_check_status_change)
<?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">EVENT</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="transaction_id">2014-06-19 13:32:48 8716 101</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="events"> <dt_array> <item key="0"> <dt_assoc> <item key="object_data"> <dt_assoc> <item key="domain_name">something-with-bad-dns.de </item> <item key="domain_id">307255</item> <item key="zone_check_status">invalid</item> </dt_assoc> </item> <item key="object">DOMAIN</item> <item key="event_id">bf7b2cf6d8e835324241a4eae7be4ee5</item> <item key="event">ZONE_CHECK_STATUS_CHANGE</item> <item key="event_date">2014-06-19T17:31:51Z</item> </dt_assoc> </item> </dt_array> </item> <item key="total">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 2 years ago
* * *
Table of Contents
Response Parameters for zone_check_status_change (domain)
Example Response for (zone_check_status_change)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
enable_designated_agent
Grants permission for Tucows to act as the Designated Agent on behalf of a New Registrant.
This setting needs to be submitted prior to the actual Change of Registrant request.
If enabled, the New Registrant (by its combination of firstname, lastname, organization and email) will be flagged as having accepted Tucows as their Designated Agent, so that Tucows will accept subsequent Change of Registrant requests without requesting further confirmation from the New Registrant.
Suggest Edits
Request Parameters enable_designated_agent
Standard parameters:
action = enable_designated_agent
object = icann_trade_registrant
protocol = XCP
Attributes
Parameters within the attributes associative array are described below.
ParameterObligationDefinition/Value
owner Required Contains contact details of a New Registrant.
Contact details are submitted as a list of required sub-items.
The list of required sub-items consists of:
- first_name
- last_name
- org_name
ip_address Required The IP address of the registrant modifying the setting.
Response Parameters enable_designated_agent
Standard parameters
action = reply
object = 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
Examples for enable_designated_agent
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">icann_trade_registrant</item> <item key="action">enable_designated_agent</item> <item key="attributes"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="email">[email protected]</item> <item key="org_name">Example Corp.</item> <item key="last_name">Doe</item> <item key="first_name">John</item> </dt_assoc> </item> <item key="ip_address">0.0 .0.0 </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="action">REPLY</item> <item key="response_code">200</item> <item key="protocol">XCP</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="object">ICANN_TRADE_REGISTRANT</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request Parameters enable_designated_agent
Standard parameters:
Attributes
Response Parameters enable_designated_agent
Standard parameters
Examples for enable_designated_agent
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Event Notifications Overview
Suggest Edits
To receive event notifications about a specific transaction or event, the event notification feature must first be enabled for that transaction in the Reseller Control Panel.
This can be accomplished from Account Settings > Event notifications.
Simply enable the poll feature under Global Settings and check off any relevant transaction from the Individual Notifications Settings list.
In this section, you will find:
Standard event notification parameters — Lists the standard parameters that apply to every event.
Standard parameters domain event notifications
Standard parameters for order event notifications
Standard parameters for transfer event notifications
Standard parameters for trust order event notifications
Event types:
Created (domain)
Registered (domain)
Renewed (domain)
Expired (domain)
Deleted (domain)
Nameserver_update (domain)
Registrant_verification_status_change (domain)
Zone_check_status_change (domain)
Message_status_change (domain)
Claim_status_change (order)
Status_change (order)
Message_status_change (order)
Status_change (transfer)
Message_status_change (transfer)
Message_status_change (trust_order)
Updated over 2 years ago
* * *
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Examples for contact set
Suggest Edits
Rather than including the entire contact set in every command example in this guide, where it is required, contact details are listed in a separate topic.
Every command that requires contact details contains an ellipsis (...) that links to the topic where the contact_set parameter is defined.
This example shows a portion of the sw_register command with a link to the contact_set example:
<?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="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="auto_renew"/> <item key="link_domains">0</item> <item key="custom_tech_contact">0</item> <item key="contact_set"> ...
see "Contact Set" </item> ...
Example for contact set
...
<item key='contact_set'> <dt_assoc> <item key="owner"> <dt_assoc> <item key="first_name">Owen</item> <item key="last_name">Ottway</item> <item key="phone">+1.4165550123x1902 </item> <item key="fax">+1.4165550124 </item> <item key="email">[email protected]</item> <item key="org_name">Example Inc.</item> <item key="address1">32 Oak Street</item> <item key="address2">Suite 500</item> <item key="address3">Owner</item> <item key="city">SomeCity</item> <item key="state">CA</item> <item key="country">US</item> <item key="postal_code">90210</item> </dt_assoc> </item> <item key="admin"> <dt_assoc> <item key="first_name">Adler</item> <item key="last_name">Adams</item> <item key="phone">+1.4165550123x1812 </item> <item key="fax">+1.4165550125 </item> <item key="email">[email protected]</item> <item key="org_name">Example Inc.</item> <item key="address1">32 Oak Street</item> <item key="address2">Suite 100</item> <item key="address3">Admin</item> <item key="city">Santa Clara</item> <item key="state">CA</item> <item key="country">US</item> <item key="postal_code">90210</item> </dt_assoc> </item> <item key="billing"> <dt_assoc> <item key="first_name">Bill</item> <item key="last_name">Burton</item> <item key="phone">+1.4165550123x1248 </item> <item key="fax">+1.4165550136 </item> <item key="email">[email protected]</item> <item key="org_name">Example Inc.</item> <item key="address1">32 Oak Street</item> <item key="address2">Suite 200</item> <item key="address3">Billing</item> <item key="city">Santa Clara</item> <item key="state">CA</item> <item key="country">US</item> <item key="postal_code">90210</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="first_name">Tim</item> <item key="last_name">Tucker</item> <item key="phone">+1.4165550123x1243 </item> <item key="fax">+1.4165550125 </item> <item key="email">[email protected]</item> <item key="org_name">Example Inc.</item> <item key="address1">32 Oak Street</item> <item key="address2">Suite 100</item> <item key="address3">Tech</item> <item key="city">Santa Clara</item> <item key="state">CA</item> <item key="country">US</item> <item key="postal_code">90210</item> </dt_assoc> </item> </dt_assoc> </item> ...
Updated about 2 years ago
* * *
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
force_dns_nameservers
Changes the nameservers on your domain to use the DNS nameservers: ns1.systemdns .com, ns2.systemdns .com, and ns3.systemdns .com.
Suggest Edits
Request parameters for force_dns_nameservers
Standard parameters
action = force_dns_nameservers
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The domain whose nameservers you want to change to the DNS nameservers ns1.systemdns .com, ns2.systemdns .com, and ns3.systemdns .com.
Response parameters for force_dns_nameservers
Standard parameters
action = reply
object = domain
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 force_dns_nameservers
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">FORCE_DNS_NAMESERVERS</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </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 Successful</item> <item key="action">REPLY</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for force_dns_nameservers
Standard parameters
Attributes
Response parameters for force_dns_nameservers
Standard parameters
Examples for force_dns_nameservers
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
gdpr_send_consent_reminder_email
Resends the GDPR consent reminder email to the domain owner contact.
Suggest Edits
Request Parameters
Standard parameters:
action = gdpr_send_consent_reminder_email
object = domain
protocol = XCP
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The domain for which the consent reminder email is being sent.
Response Parameters
Standard parameters
action = reply
object = domain
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
Example
RequestResponse
<?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">gdpr_send_consent_reminder_email</item> <item key="attributes"> <dt_assoc> <item key="domain">gdprtesting.com </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">GDPR consent reminder email request has been submitted</item> <item key="action">REPLY</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 6 years ago
* * *
Table of Contents
Request Parameters
Standard parameters:
Attributes
Response Parameters
Standard parameters
Example
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get (DNSSEC)
Returns list of all DS records for a domain.
Suggest Edits
Request parameters
Standard request parameters
action = get
object = domain
Request attributes
ParameterObligationDefinition/Value
domain Required The relevant domain.
type Required The type of query, use the value 'dnssec' to retrieve dnssec information.
* * *
Response parameters
Standard response parameters
action = reply
object = domain
is_success = Boolean 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.
Response attributes
If the request is successful, the attributes associative array may include the following:
ParameterObligationDefinition/Value
dnssec Always returned Contains an array specifying the DNSSEC details to be added.
For more information, please see the dnssec table below.
Response parameters within the dnssec array includes the following:
ParameterObligationDefinition/Value
algorithm Always returned The cryptographic algorithm that generates the signature.
Allowed values are:
5—RSA/SHA-1
6—DSA-NSEC3/SHA1
7—RSASHA1-NSEC3/SHA1
8—RSA/SHA-256
10—RSA/SHA-512
253—Private [PRIVATEDNS]
254—Private [PRIVATEOID]
key_tag Always returned An integer value that identifies the DNSSEC record for this domain name.
digest_type Always returned The algorithm type that constructs the digest, allowed values are:
1—SHA-1
2—SHA-256
3—GOST
4—SHA-384
digest Always returned The digest is an alpha-numeric string value.
* * *
Example
RequestResponse
<?xml version="1.0 " encoding="UTF-8"?> <OPS_envelope> <header> <version>0.9 </version> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">get</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="type">dnssec</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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 successful</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="dnssec"> <dt_array> <item key="0"> <dt_assoc> <item key="algorithm">5</item> <item key="key_tag">333</item> <item key="digest">da39a3ee5e6b4b0d3255bfef95601890afd80709</item> <item key="digest_type">1</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Response attributes
Example
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get (domain)
Queries various types of data regarding the user's domain.
The list type queries the list of domains associated with the user's profile.
The list type can also be used to return a list of domains that expire within a specified range.
The nameservers type returns the nameservers currently acting as DNS servers for the domain.
Suggest Edits
Request parameters
Standard request parameters
action = get
object = domain
registrant_ip = valid IP address of the registrant (optional)
📘Note
The get_domain command will return results if a domain is active or in the expiration grace period, but it will not return results once a domain is deleted during and after the redemption period.
Also, this command may be used without end-user credentials when using type=admin, all_info, billing, expire_action, forwarding_email (.NAME only), list, tech, owner, nameservers, status, rsp_whois_info, ced_info, nexus_info, or whois_privacy_state.
Request attributes
Parameters within the attributes associative array are described below:
ParameterObligationDefinition/Value
domain Required The relevant domain.
type Required The type of query, allowed values are:
admin—Returns admin contact information.
billing— Returns billing contact information.
owner— Returns owner contact information.
tech— Returns tech contact information.
all_info—Returns all information.
auto_renew_flag—Returns domain auto-renew flag value.
domain_auth_info— Returns domain authorization code, if applicable.
expire_action— Returns the action to be taken upon domain expiry, specifically whether to auto-renew the domain, or let it expire silently.
forwarding_email— Returns forwarding email for .NAME 2nd level.
list— Returns list of domains in the same profile or returns list of domains for user using cookie method.
nameservers— Returns nameserver information.
registry_dates—Returns domain created, expiry and last updated dates from the registry.
rsp_whois_info— Returns name and contact information for RSP.
status— Returns lock or escrow status of the domain.
tld_data—Returns additional information that is required by some registries, such as the residency of the registrant.
waiting history— Returns information on asynchronous requests.
whois_privacy_state— Returns the state for the WHOIS Privacy feature: enabled, disabled, enabling, or disabling.
Note: If the TLD does not allow WHOIS Privacy, always returns Disabled.
whois_publicity_state— Returns the state for the WHOIS Publicity feature: enabled, disabled.
Note: If the TLD does not allow WHOIS Privacy, always returns Disabled.
TLD specific types:
au_registrant_info—Returns the current .AU registrant information for .AU domains.
ca_whois_display_setting—Returns the current CIRA Whois Privacy setting for .CA domains.
ced_info—Returns the current CED info for .ASIA domains.
CED info is optional as of July 15th, 2017.
it_registrant_info—Returns the current registrant info for .IT domains.
it_whois_display_setting—Returns the current Whois Privacy setting for .IT domains.
nexus_info—Returns the nexus information for .US domains.
uk_whois_opt—Returns the Whois Privacy setting for .UK domains.
xpack_waiting_history—Returns the state of completed/cancelled requests not yet deleted from the database for .DK domains.
All completed/cancelled requests are deleted from the database two weeks after they move to final state.
xxx_ipr_data—Returns the current IPR data for .XXX domains.
min_to_expiry
max_to_expiry Required if:
type = list Defines the expiration range (in days): to fetch the list of domains that are between min_to_expiry and max_to_expiry before expiration date.
Note: If min_to_expiry is not provided, it defaults to 0.
If min_to_expiry > max_to_expiry, the list is empty.
These parameters can have negative values, which means days past the expiration date.
For example, -5 means 5 days past the expiration date.
active_contacts_only Optional Retrieves the currently active contact information for owner, admin, billing and tech, as they are currently set on the domain.
This info will be returned regardless of whether there is a pending trade in progress.
page Optional Determines which page to retrieve, using the page number.
The page index starts at 0 (zero).
limit Optional The maximum number of domains to return per page.
clean_ca_subset Optional Determines the type of contact_set values that are returned for .CA domains when type = admin or tech.
Note: If clean_ca_subset = 1, the address data is returned as standard address fields (address1, address2, and address3).
If clean_ca_subset is not specified, the query returns the values addr_address_number, addr_corporative, addr_office, addr_orientation, addr_street_cat, and addr_street_name along with the standard address fields (address1, address2, and address3).
* * *
Response parameters
Standard response parameters
action = reply
object = domain
is_success = Boolean 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.
Response attributes
The response message returned varies depending on the value of the type field that was used to send the request, each type is broken down below.
* * *
type = admin, billing, owner, or tech
ParameterObligationDefinition/Value
contact_set Returned when:
type = owner, admin, billing, or tech and is_success = true An associative array containing the contact information of the requested type.
For details on contact fields, see: Contact Set.
gdpr_consent_status Returned when:
type = all_info or type = owner Displays whether or not the registrant has completed the GDPR consent requirements.
Possible values
NONE
PENDING
PENDING_ASYNC
ACCEPTED_CONTRACTUAL_MINIMUM
ACCEPTED_FULL
DENIED
FORCED_ALL_CONTRACTUAL
descr Returned when:
type = owner, admin, billing, or tech and is_success = true The domain description.
status Always returned The status of the contact.
Possible values
active
pending_current_registrant - waiting on action from the current owner/registrant of the domain.
pending_new_registrant - waiting on action from the registrant/owner to whom the domain is pending transfer.
Note:
When a pending_current_registrant or pending_new_registrant value is displayed, the contact information included in the response is that which will be displayed in whois once the trade is complete.
Both pending_current_registrant and pending_new_registrant will only ever be returned for gTLDs.
Examples
Example 1: Standard request RequestResponse
<?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">get</item> <item key="object">domain</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="type">owner</item> <item key="limit">10</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_text">Query Successful</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="country">CA</item> <item key="address3"></item> <item key="status">active</item> <item key="org_name">Widgets Co</item> <item key="phone">+1.8885555555 </item> <item key="last_name">Smith</item> <item key="address2"></item> <item key="state">ON</item> <item key="email">[email protected]</item> <item key="city">Toronto</item> <item key="postal_code">M6K 3M1</item> <item key="fax"></item> <item key="address1">96 Mowat Avenue</item> <item key="first_name">Ralph</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2: clean_ca_subset = 1 RequestResponse
<?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="domain">yourdomain.com </item> <item key="action">GET</item> <item key="attributes"> <dt_assoc> <item key="clean_ca_subset">1</item> <item key="type">admin</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Query Successful</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="contact_set"> <dt_assoc> <item key="admin"> <dt_assoc> <item key="address1">32 Oak Street</item> <item key="address2"></item> <item key="address3"></item> <item key="status">active</item> <item key="city">Toronto</item> <item key="state">ON</item> <item key="postal_code">M1M1M1</item> <item key="country">CA</item> <item key="org_name">Example Company</item> <item key="phone">+1.4165551212 </item> <item key="fax"></item> <item key="first_name">Marlin</item> <item key="last_name">Wilk</item> <item key="email">[email protected]</item> <item key="lang">EN</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 3: Without clean_ca_subset RequestResponse
<?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">GET</item> <item key="object">DOMAIN</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="type">admin</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">Query Successful</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="contact_set"> <dt_assoc> <item key="admin"> <dt_assoc> <item key="addr_address_number"></item> <item key="addr_corporative"></item> <item key="addr_office"></item> <item key="addr_orientation"></item> <item key="addr_street_cat"></item> <item key="addr_street_name">32 Oak Street</item> <item key="address1">32 Oak Street</item> <item key="address2"></item> <item key="address3"></item> <item key="status">active</item> <item key="city">Toronto</item> <item key="state">ON</item> <item key="postal_code">M1M1M1</item> <item key="country">CA</item> <item key="org_name">Example Company</item> <item key="first_name">Marlin</item> <item key="last_name">Wilk</item> <item key="lang">EN</item> <item key="email">[email protected]</item> <item key="phone">+1.4165551212 </item> <item key="fax"></item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 4: Without end-user credentials RequestResponse
<?xml version="1.0 " encoding="UTF-8" standalone='yes'?> <!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">GET</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">mydomain.com </item> <item key="type">admin</item> <item key="limit">10</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?xml version="1.0 " encoding="UTF-8" standalone='yes'?> <!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">DOMAIN</item> <item key="response_code">200</item> <item key="response_text">Query Successful</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="contact_set"> <dt_assoc> <item key="billing"> <dt_assoc> <item key="org_name">Empire Limited Inc.</item> <item key="first_name">George</item> <item key="last_name">Walsh</item> <item key="address1">44 Hemlock St.</item> <item key="address2"></item> <item key="address3"></item> <item key="status">active</item> <item key="city">Tampa</item> <item key="state">Florida</item> <item key="country">US</item> <item key="postal_code">90211</item> <item key="phone">+1.4165551122 </item> <item key="fax"></item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
* * *
type = all_info
The response message consists of a combination of the fields used for type = nameserver, and type = owner, admin, tech, or billing.
The contact_set contains a type for each possible contact type.
Also returns the fields: auto_renew, expiredate, let_expire, sponsoring_rsp as per the Extended Results of type = list.
ParameterObligationDefinition/Value
affiliate_id Returned if applicable and is_success = 1 The affiliate id associated with the domain.
descr Returned when:
type = all_info
and is_success = 1 The text of the domain description.
dns_errors Returned when:
type = all_info
and is_success = 1 The text of the DNS errors.
nameserver_list Returned when:
type = all_info
and is_success = 1 A list of nameservers.
Each nameserver is represented as an anonymous associative array.
For more information, see the Nameserver_List table below.
registry_createdate Returned when:
type = all_info
and is_success = 1 The date that the domain was created at the Registry.
registry_expiredate Returned when: type = all_info.
Only if the Registry provides this information.
The domain's expiry date as recorded at the Registry.
registry_transferdate Returned when: type = all_info.
Only if the Registry provides this information and the domain was transferred.
The Registry's record of when the domain was transferred.
registry_updatedate Returned when:
type = all_info
Only if the Registry provides this information.
The date the domain was last updated at the Registry.
sponsoring_rsp Returned when:
type = all_info
and is_success = 1 Indicates if the domain is under your reseller profile:
0—Domain is provisioned by a different reseller
1—Domain is under your reseller profile (logged- in reseller)
tld_data Returned for:
Required for specific TLDs when:
type = all_info and is_success = 1 An associative array containing registrant information.
For more information, see: tld_data.
Parameters within the nameserver_list associative array are described below:
ParameterObligationDefinition/Value
ip_address Returned if the nameserver has an IPv4 address.
The IPv4 address of the nameserver.
ipv6 Returned if the nameserver has an IPv6 address.
The IPv6 address of the nameserver.
name Returned when type = all_info The name of the nameserver.
sort_order Returned when type = all_info The nameserver sort order.
Examples
Example 1: Standard request RequestResponse
<?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">get</item> <item key="object">domain</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="type">all_info</item> <item key="limit">10</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_text">Query Successful</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">1</item> <item key="contact_set"> <dt_assoc> <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="status">active</item> <item key="state">CA</item> <item key="email">[email protected]</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="owner"> <dt_assoc> <item key="country">US</item> <item key="address3">Owner</item> <item key="status">active</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">[email protected]</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="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="status">active</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="registry_updatedate">2016-04-22 05:36:05</item> <item key="sponsoring_rsp">1</item> <item key="registry_createdate">2010-01-03 06:48:18</item> <item key="affiliate_id"></item> <item key="expiredate">2017-01-03 06:48:18</item> <item key="let_expire">0</item> <item key="tld_data"></item> <item key="registry_expiredate">2017-01-03 06:48:18</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="ipaddress">21.40 .33.21 </item> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="ipaddress">207.136 .100.142 </item> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="ipaddress">24.22 .23.28 </item> <item key="sortorder">3</item> <item key="name">patrick.example .com</item> </dt_assoc> </item> <item key="3"> <dt_assoc> <item key="ipaddress">24.22 .23.24 </item> <item key="sortorder">4</item> <item key="name">qa1.example .com</item> </dt_assoc> </item> <item key="4"> <dt_assoc> <item key="ipaddress">24.22 .23.25 </item> <item key="sortorder">5</item> <item key="name">qa2.example .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2: .CA domain RequestResponse
<?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">GET</item> <item key="object">DOMAIN</item> <item key="domain">yourdomain.ca </item> <item key="attributes"> <dt_assoc> <item key="limit">10</item> <item key="type">all_info</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_text">Query Successful</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="registry_createdate">2009-10-26 00:00:00</item> <item key="fqdn2">ns3.systemdns .com</item> <item key="legal_type">CCT</item> <item key="fqdn1">ns2.systemdns .com</item> <item key="sponsoring_rsp">1</item> <item key="expiredate">2010-10-26 00:00:00</item> <item key="auto_renew">0</item> <item key="registry_expiredate">2010-10-26 00:00:00</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">1</item> <item key="ipaddress"></item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">2</item> <item key="ipaddress"></item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">3</item> <item key="ipaddress"></item> </dt_assoc> </item> </dt_array> </item> <item key="let_expire">0</item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="org_name">Setter Sanctuary</item> <item key="first_name">Owen</item> <item key="last_name">Ottway</item> <item key="address1">32 Oak St.</item> <item key="address2">Suite 100</item> <item key="address3" /> <item key="status">active</item> <item key="city">Toronto</item> <item key="state">ON</item> <item key="postal_code">M1M1M1</item> <item key="country">CA</item> <item key="phone">+14165551212</item> <item key="fax"></item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="admin"> <dt_assoc> <item key="country">CA</item> <item key="org_name">Setter Sanctuary</item> <item key="phone">+14165551212</item> <item key="state">ON</item> <item key="last_name">Wilk</item> <item key="address2"></item> <item key="email">[email protected]</item> <item key="status">active</item> <item key="lang">EN</item> <item key="city">Toronto</item> <item key="postal_code">M1M1M1</item> <item key="fax"></item> <item key="address1"> 123 Oak St.</item> <item key="first_name">Marlin</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="country">CA</item> <item key="org_name">Setter Sanctuary</item> <item key="phone">+14165551212</item> <item key="state">ON</item> <item key="last_name">Wilk</item> <item key="address2"></item> <item key="email">[email protected]</item> <item key="status">active</item> <item key="lang">EN</item> <item key="city">Toronto</item> <item key="postal_code">M1M1M1</item> <item key="fax"></item> <item key="address1"> 123 Oak St.</item> <item key="first_name">Robson</item> </dt_assoc> </item> </dt_assoc> </item> <item key="domain_description"></item> <item key="fqdn3">ns1.systemdns .com</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 3: .AU domain RequestResponse
<?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">get</item> <item key="object">domain</item> <item key="domain">yourdomain.com .au</item> <item key="attributes"> <dt_assoc> <item key="type">all_info</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Query Successful</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="tld_data"> <dt_assoc> <item key="au_registrant_info"> <dt_assoc> <item key="eligibility_type">Charity</item> <item key="registrant_id">38 144 482 002</item> <item key="registrant_id_type">ABN</item> <item key="registrant_name">Example Company Ltd</item> <item key="policy_reason">1</item> </dt_assoc> </item> </dt_assoc> </item> <item key="registry_createdate">2010-09-22 18:29:35</item> <item key="auto_renew">1</item> <item key="sponsoring_rsp">1</item> <item key="expiredate">2012-09-22 18:29:35</item> <item key="registry_expiredate">2012-09-22 18:29:35</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> <item key="ipaddress"></item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> <item key="ipaddress"></item> </dt_assoc> </item> </dt_array> </item> <item key="contact_set"> <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="status">active</item> <item key="state">CA</item> <item key="email">[email protected]</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="status">active</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">[email protected]</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="status">active</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">[email protected]</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> </item> <item key="let_expire">0</item> <item key="registry_updatedate">2010-09-22 18:30:05</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 4: .XXX domain RequestResponse
<?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">get</item> <item key="object">domain</item> <item key="domain">yourdomain.xxx </item> <item key="attributes"> <dt_assoc> <item key="type">all_info</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="object">DOMAIN</item> <item key="response_text">Query Successful</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">1</item> <item key="ipr_data"> <dt_assoc> <item key="icm_membership_id">123456</item> </dt_assoc> </item> <item key="contact_set"> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="country">US</item> <item key="address3">Owner</item> <item key="status">active</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">[email protected]</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="status">active</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">[email protected]</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="status">active</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">[email protected]</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> </item> <item key="registry_updatedate">2011-11-29 21:16:04</item> <item key="sponsoring_rsp">1</item> <item key="registry_createdate">2011-11-29 21:11:25</item> <item key="expiredate">2012-11-29 21:11:25</item> <item key="let_expire">0</item> <item key="registry_expiredate">2012-11-29 21:11:25</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> <item key="ipaddress" /> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> <item key="ipaddress" /> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
* * *
type = domain_auth_info
ParameterObligationDefinition/Value
domain_auth_info Returned when:
type = domain_auth_info
and is_success = 1 Authentication password for the domain.
This facilitates transfers to others domain_auth_info registrars.
Example
Example: Standard request RequestResponse
<?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">get</item> <item key="object">domain</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="type">domain_auth_info</item> <item key="limit">10</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Query Successful</item> <item key="attributes"> <dt_assoc> <item key="domain_auth_info">ewgnRwnH</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
* * *
type = expire_action
ParameterObligationDefinition/Value
auto_renew Returned when:
type = expire_action and is_success = 1 Indicates domain auto-renew setting:
0—Do not auto-renew
1—Auto-renew.
expiredate Returned when:
type = expire_action and is_success = 1 The date that the domain is set to expire, in the format
YYYY-MM-DD HH24:MM:SS
let_expire Returned when:
type = expire_action and is_success = 1 Indicates whether the domain is set to expire silently:
0—Do not expire silently.
1—Expire silently
For more information, see “Renewing domains”.
Example
Example: Standard request This command returns the action that occurs on domain expiry, in particular whether the domain will renew automatically, or silently expires.
RequestResponse
<?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">get</item> <item key="object">domain</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="type">expire_action</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_text">Query Successful</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="let_expire">0</item> <item key="expiredate">2017-01-01 06:48:18</item> <item key="auto_renew">1</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
* * *
type = forwarding_email
ParameterObligationDefinition/Value
forwarding_email Returned when:
type = forwarding_email
and is_success = 1 The domain's e-mail address that is used for forwarding purposes.
Example
Example: Standard request This type is currently for use with .NAME domains which have been bundled or have been upgraded with email forwarding.
RequestResponse
<?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">get</item> <item key="object">domain</item> <item key="domain">yourdomain.name </item> <item key="attributes"> <dt_assoc> <item key="type">forwarding_email</item> <item key="limit">10</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Query Successful</item> <item key="attributes"> <dt_assoc> <item key="forwarding_email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
* * *
type = list
ParameterObligationDefinition/Value
count Returned when:
type = list
and is_success = 1 The count (total number) of domain names in the
current user profile.
domain_list Returned when:
type = list
and is_success = 1 An array of domain name hashes.
For compatibility reasons, if you set
with_encoding_types attribute in the request to
0 or don't set it at all, then you get an array of
scalars, domain names.
For more information, see “Domain_List” table below.
ext_results Returned when:
type = list
and is_success = 1 An array of extended results that indicate the domains and their expiry dates.
For more information, see the Ext_Results table below.
remainder Returned when:
type = list
and is_success = 1 A Boolean variable indicating whether there are more domains in the list:
0—No more domains.
1—More domains to be listed
Parameters within the domain_list associative array are described below:
ParameterObligationDefinition/Value
domain Returned when:
type = list
and is_success = 1 Fully qualified domain name.
encoding_type Returned when:
type = list
and is_success = 1 The three-character tag that represents the language encoding type for the domain.
For a list of languages and codes, see “AppendixC:
Encoding Types for IDNs”.
Parameters within the ext_results associative array are described below:
ParameterObligationDefinition/Value
auto_renew Returned when:
type = list
and is_success = 1 Status of the auto-renew flag:
0—Do not auto-renew
1—Auto-renew
expiredate Returned when:
type = list
and is_success = 1 Expiration date of the domain.
has_whois_privacy Returned when:
type = list
and is_success = 1 Indicates whether WHOIS Privacy is enabled:
0—Disabled
1—Enabled
let_expire Returned when:
type = list
and is_success = 1 Status of the let-expire flag:
0—Don't expire domain silently
1—Expire domain silently
lock_state Returned when:
type = list
and is_success = 1 Flag indicating if the domain is locked to prevent transfers:
0—Not locked
1—Locked
sponsoring_rsp Returned when:
type = list
and is_success = 1 Flag indicating if the domain is sponsored by the reseller making the call:
0—Not sponsoring RSP
1—Sponsoring RSP
Example
Example: Standard request RequestResponse
<?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">get</item> <item key="object">domain</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="type">list</item> <item key="limit">10</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_text">Command Successful</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="ext_results"> <dt_array> <item key="0"> <dt_assoc> <item key="firstdomain.net "> <dt_assoc> <item key="wp_service">0</item> <item key="wp_expiredate">0</item> <item key="auto_renew">1</item> <item key="expiredate">2016-10-05 21:59:59</item> <item key="sponsoring_rsp">1</item> <item key="lock_state">0</item> <item key="let_expire">0</item> <item key="has_whois_privacy">0</item> </dt_assoc> </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="seconddomain.co .nz"> <dt_assoc> <item key="wp_service">0</item> <item key="wp_expiredate">0</item> <item key="auto_renew">1</item> <item key="expiredate">2016-09-21 21:52:19</item> <item key="sponsoring_rsp">1</item> <item key="lock_state">1</item> <item key="let_expire">0</item> <item key="has_whois_privacy">0</item> </dt_assoc> </item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="yourdomain.com "> <dt_assoc> <item key="wp_service">0</item> <item key="wp_expiredate">0</item> <item key="auto_renew">1</item> <item key="expiredate">2017-01-03 06:48:18</item> <item key="sponsoring_rsp">1</item> <item key="lock_state">1</item> <item key="let_expire">0</item> <item key="has_whois_privacy">0</item> </dt_assoc> </item> </dt_assoc> </item> <item key="3"> <dt_assoc> <item key="thirddomain.org .uk"> <dt_assoc> <item key="wp_service">0</item> <item key="wp_expiredate">0</item> <item key="auto_renew">1</item> <item key="expiredate">2016-09-18 15:01:10</item> <item key="sponsoring_rsp">1</item> <item key="lock_state">0</item> <item key="let_expire">0</item> <item key="has_whois_privacy">0</item> </dt_assoc> </item> </dt_assoc> </item> </dt_array> </item> <item key="count">4</item> <item key="remainder">0</item> <item key="domain_list"> <dt_array> <item key="0">firstdomain.net </item> <item key="1">seconddomain.co .nz</item> <item key="2">yourdomain.com </item> <item key="3">thirddomain.org .uk</item> </dt_array> </item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
* * *
type = nameservers
ParameterObligationDefinition/Value
nameserver_list Returned when:
type = nameservers
and is_success = 1 A list of nameservers.
Each nameserver is represented as an anonymous associative array.
For more information, see the Nameserver_List table below.
Parameters within the nameserver_list associative array are described below.
ParameterObligationDefinition/Value
ipaddress Returned when:
type = nameservers IP address of the nameserver
name Returned when:
type = nameservers Fully qualified domain name of the nameserver.
sortorder Returned when:
type = nameservers Sort order of this nameserver.
The sortorder does not necessarily start at 0 and there may be gaps between nameserver entries.
It does indicate the relative sorting order of the nameservers.
The sort order value must be preserved for nameserver modification commands.
Example
Example: Standard request RequestResponse
<?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">get</item> <item key="object">domain</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="type">nameservers</item> <item key="limit">10</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Query Successful</item> <item key="attributes"> <dt_assoc> <item key="type">nameservers</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="ipaddress">21.40 .33.21 </item> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="ipaddress">207.136 .100.142 </item> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
* * *
type = rsp_whois_info
ParameterObligationDefinition/Value
business Returned when:
type = rsp_whois_info
and is_success = 1 The business name of the RSP.
domain_enabled Returned when:
type = rsp_whois_info
and is_success = 1 Indicates whether this feature enabled for given domain:
Y—Enabled
N—Disabled
email Returned when:
type = rsp_whois_info
and is_success = 1 Email address of the RSP.
phone Returned when:
type = rsp_whois_info
and is_success = 1 Phone number of the RSP.
rsp_enabled Returned when type =
rsp_whois_info and
is_success = 1 Indicates whether this feature is enabled or disabled by RSP:
Y—Enabled
N—Disabled
url Returned when type =
rsp_whois_info and
is_success = 1 The URL of the RSP.
Example
Example: Standard request RequestResponse
<?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">get</item> <item key="object">domain</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="type">rsp_whois_info</item> <item key="limit">10</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command successful</item> <item key="attributes"> <dt_assoc> <item key="url" /> <item key="domain_enabled">Y</item> <item key="rsp_enabled">Y</item> <item key="fax" /> <item key="business">Example</item> <item key="opt_info">This company may be contacted for domain login/passwords, DNS/Nameserver changes, and general domain support questions.</item> <item key="email">[email protected]</item> <item key="phone">+1.4165350123 </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
* * *
type = status
ParameterObligationDefinition/Value
auctionescrow Returned when:
type = status
and domain is in auction escrow.
Indicates whether the domain has been placed in auction escrow.
If in auction escrow, the domain cannot be renewed.
0—Not in escrow.
1—In escrow.
can_modify Returned when:
type = status
and is_success = 1 Indicates whether the lock state can be modified during this session:
0—Cannot be modified.
1—Can be modified.
domain_supports Returned when:
type = status
and is_success = 1 Indicates whether the TLD is one that supports domain locking:
0—Does not support domain locking.
1—Supports domain locking
lock_state Returned when:
type = status
and is_success = 1 Indicates whether the domain is locked:
0—Not locked.
1—Locked.
parkp_status Optional Indicates if the domain is enabled for the Parked Pages service.
Values are Enabled, Activating, or blank.
If returned but left blank, the domain is not enabled.
transfer_away_in_progress Optional If returned, indicates that the domain is in the process of being transferred away.
Value is 1.
📘Note:
The domain_supports and can_modify attributes are different in that a
TLD from a registry that supports domain locking always returns 1 for
domain_supports, but the state of the current session as well as the internal
state of the domain at OpenSRS affects can_modify.
This is only true when
all of the following conditions are met:
Request is done through the sponsoring reseller for the domain.
The TLD for the domain is one that supports locking at the registry level.
The domain is not locked internally by OpenSRS.
Example
Example: Standard request RequestResponseResponse (If being transferred away)
<?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">get</item> <item key="object">domain</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="domain">yourdomain.com </item> <item key="type">status</item> <item key="limit">10</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command successful</item> <item key="attributes"> <dt_assoc> <item key="can_modify">0</item> <item key="domain_supports">1</item> <item key="auctionescrow">1</item> <item key="parkp_status">enabled</item> <item key="lock_state">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command successful</item> <item key="attributes"> <dt_assoc> <item key="can_modify">0</item> <item key="domain_supports">1</item> <item key="parkp_status" /> <item key="lock_state">0</item> <item key="transfer_away_in_progress">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
* * *
type = tld_data
ParameterObligationDefinition/Value
tld_data Returned for:
.ASIA, .AR, .AU, .BR, .CL, .COOP, .DE, .DK, .FI, .HK, .HU, .IT, .JOBS, .LV, .MX, .NO, .PM, .PRO, .PT, .RE, .RO, .RU, .SE, .TF, .US, .WF, .XXX, .YT, and .ZA domains when type tld_data and is_success = true An associative array containing registrant information.
For more information, see “tld_data”.
Example
Example 1: .ASIA domain RequestResponse
<?xml version='1.0 ' encoding='UTF-8'?> <!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">get</item> <item key="object">domain</item> <item key="domain">yourdomain.asia </item> <item key="attributes"> <dt_assoc> <item key="type">tld_data</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_text">Query Successful</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="tld_data"> <dt_assoc> <item key="ced_info"> <dt_assoc> <item key="legal_entity_type_info">proprietorship</item> <item key="locality_state_prov">NSW</item> <item key="id_type">other</item> <item key="contact_type">tech</item> <item key="locality_city">Sydney</item> <item key="locality_country">AU</item> <item key="id_type_info">driver\'s license</item> <item key="legal_entity_type">other</item> <item key="id_number">AB1234567</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2: .COOP domain RequestResponse
<?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">get</item> <item key="object">domain</item> <item key="domain">yourdomain.coop </item> <item key="attributes"> <dt_assoc> <item key="type">tld_data</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Query Successful</item> <item key="attributes"> <dt_assoc> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="coop_verification_code">123456789</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 3: .DK domain RequestResponse
<?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">get</item> <item key="object">domain</item> <item key="domain">yourdomain.dk </item> <item key="attributes"> <dt_assoc> <item key="type">tld_data</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Query Successful</item> <item key="attributes"> <dt_assoc> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="registrant_type">organization</item> <item key="registrant_vat_id">123456789</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 4: .JOBS domain RequestResponse
<?xml version='1.0 ' encoding='UTF-8'?> <!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">get</item> <item key="object">domain</item> <item key="domain">yourdomain.jobs </item> <item key="attributes"> <dt_assoc> <item key="type">tld_data</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?xml version='1.0 ' encoding='UTF-8'?> <!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">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Query Successful</item> <item key="attributes"> <dt_assoc> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="jobs_admin_type">Yes</item> <item key="jobs_industry_type">Supply Chain Management</item> <item key="jobs_title">HR Generalist</item> <item key="jobs_association_member">Yes</item> <item key="jobs_website">http://www.example .com</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 5: .LV and .COM.LV domains RequestResponse
<?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">get</item> <item key="object">domain</item> <item key="domain">yourdomain.com .lv</item> <item key="attributes"> <dt_assoc> <item key="type">tld_data</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Query Successful</item> <item key="attributes"> <dt_assoc> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="registrant_type">individual</item> <item key="id_card_number">987654321</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 6: .PRO domain RequestResponse
<?xml version='1.0 ' encoding='UTF-8'?> <OPS_envelope> <header> <version>0.9 </version> </header> <body> <data_block> <dt_assoc> <item key="attributes"> <dt_assoc> <item key="type">tld_data</item> </dt_assoc> </item> <item key="protocol">XCP</item> <item key="action">get</item> <item key="object">domain</item> <item key="domain">yourdomain.pro </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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'>DOMAIN</item> <item key='response_text'>Query Successful</item> <item key='response_code'>200</item> <item key='is_success'>1</item> <item key='attributes'> <dt_assoc> <item key='tld_data'> <dt_assoc> <item key='professional_data'> <dt_assoc> <item key='profession'>Dentist</item> <item key='license_number'>123456789</item> <item key='authority_website'>http://www.cda - adc.ca /</item> Association</item> <item key='authority'>Canadian Dental </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
* * *
type = waiting history
Example: Standard request RequestResponse
<?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">get</item> <item key="object">domain</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="type">waiting_history</item> <item key="limit">10</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Query Successful</item> <item key="attributes"> <dt_assoc> <item key="record_count">0</item> <item key="waiting_history"> <dt_array /> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
* * *
type = whois_privacy_state
ParameterObligationDefinition / Value
state Returned when:
type = whois_privacy_state
and is_success = 1 WHOIS Privacy state: enabled, disabled, enabling (in process), or disabling (in process).
Example
Example: Standard request RequestResponse
<?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">GET</item> <item key="object">DOMAIN</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="type">whois_privacy_state</item> <item key="limit">10</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Query Successful</item> <item key="attributes"> <dt_assoc> <item key="state">enabled</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
* * *
type = whois_publicity_state
ParameterObligationDefinition / Value
state Returned when:
type = whois_publicity_state
and is_success = 1 WHOIS Publicity state: enabled, disabled.
Example
Example: Standard request RequestResponse
<?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">GET</item> <item key="object">DOMAIN</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="type">whois_publicity_state</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Query Successful</item> <item key="attributes"> <dt_assoc> <item key="state">enabled</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
* * *
type = ca_whois_display_setting
Parameters within the ca_whois_display_setting associative array are described below.
ParameterObligationDefinition/Value
display Returned if:
is_success = 1 Indicates the current setting for the CIRA WHOIS Privacy setting.
Allowed values are:
PRIVATE — Personal information is not displayed on WHOIS lookups.
FULL — Personal information such as name, address, telephone number and email address is displayed on WHOIS lookups.
individual Returned if:
is_success = 1 Indicates whether the domain owner is an individual registrant.
Only individual registrants (Canadian citizens, Permanent residents, Legal representatives, Aboriginal peoples) can change their CIRA Whois Privacy setting.
Allowed values are Y or N.
For more information, see “.CA registrations”.
Example
Example: Standard request RequestResponse
<?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">GET</item> <item key="object">DOMAIN</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="type">ca_whois_display_setting</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">OK</item> <item key="attributes"> <dt_assoc> <item key="individual">Y</item> <item key="display">FULL</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
* * *
type = xpack_waiting_history
ParameterObligationDefinition / Value
record_count Returned when
type = xpack_waiting_history
and is_success = 1 The number of completed/cancelled requests not yet deleted from the database for xpack domains.
waiting_history Returned when
type = xpack_waiting_history
and is_success = 1 The history of the request.
For more information, see the waiting_history table below.
Waiting_History:
Parameter nameObligationDefinition / Value
create_time Returned when:
type = xpack_waiting_history
and is_success = 1 The date and time the request was initiated, in the format DD-MMM-YYYY hh:mm:ss.
current_state Returned when:
type = xpack_waiting_history
and is_success = 1 The current state of the request.
reg_type Returned when:
type = xpack_waiting_history
and is_success = 1 Type of request.
Completed and cancelled requests are deleted from the database two weeks after they move to final state.
xpack_req_id Returned when:
type = xpack_waiting_history
and is_success = 1 The identification number of the request.
Example
Example: Standard request RequestResponse
<?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">GET</item> <item key="object">DOMAIN</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="type">xpack_waiting_history</item> <item key="limit">10</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Query Successful</item> <item key="attributes"> <dt_assoc> <item key="record_count">1</item> <item key="waiting_history"> <dt_array> <item key="0"> <dt_assoc> <item key="xpack_req_id">156013</item> <item key="current_state">INITIATE</item> <item key="create_time">05-JAN-2006 03:25:18</item> <item key="req_type">domain_change</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Response attributes
type = admin, billing, owner, or tech
type = all_info
type = domain_auth_info
type = expire_action
type = forwarding_email
type = list
type = nameservers
type = rsp_whois_info
type = status
type = tld_data
type = waiting history
type = whois_privacy_state
type = whois_publicity_state
type = ca_whois_display_setting
type = xpack_waiting_history
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get (nameserver)
Queries nameservers that exist in the current user profile.
These nameservers may or may not be currently assigned to a domain.
Suggest Edits
Request parameters for get (nameserver)
Standard parameters
action = get
object = nameserver
registrant_ip = valid IP address of the registrant (optional)
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The relevant domain.
name Required Specify all.
Response parameters for get (nameserver)
Standard parameters
action = reply
object = nameserver
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
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter nameObligationDefinition/Value
nameserver_list Returned if
is_success = true A list (array) of nameservers, each of which can contain any of the attributes listed in the Nameserver_List table below.
Nameserver_List
Parameters within the nameserver_list associative array are described below.
Parameter nameObligationDefinition/Value
can_delete Always returned A flag indicating whether the nameserver is currently serving a domain in OpenSRS.
To delete a nameserver with can_delete set to zero, it must first be un-assigned from the domain it serves.
Note: If the registry in which the nameserver object resides is serving a domain outside of OpenSRS, a delete_nameserver action returns an error, and the nameserver is not deleted.
0—Nameserver can be deleted.
1—Nameserver cannot be deleted.
ipaddress Returned if the nameserver has an Ipv4 address The IPv4 address of the nameserver.
Note: This parameter is always required for .DE, even if ipv6 is submitted.
ipv6 Returned if the nameserver has an Ipv6 address The IPv6 address of the nameserver.
Note: This parameter is not supported for .CN.
name Always returned The fully qualified domain name of the nameserver.
Examples for get (nameserver)
Example 1
This example returns information about an IPv4 nameserver.
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">get</item> <item key="object">nameserver</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="name">all</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">nameserver</item> <item key="response_code">200</item> <item key="response_text">Query Successful</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="can_delete">1</item> <item key="ipaddress">191.11 .121.111 </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="can_delete">0</item> <item key="ipaddress">11.111 .121.111 </item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
This example returns information about an IPv6 nameserver.
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">get</item> <item key="object">nameserver</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="name">all</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">nameserver</item> <item key="response_code">200</item> <item key="response_text">Query Successful</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="can_delete">1</item> <item key="ipv6">2a00:1450:4008:c00:0:0:0:1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns4.systemdns .com</item> <item key="can_delete">0</item> <item key="ipv6">2001:0db8:85a3:0000:0000:8a2e:0370:7334</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for get (nameserver)
Standard parameters
Attributes
Response parameters for get (nameserver)
Standard parameters
Attributes
Nameserver_List
Examples for get (nameserver)
Example 1
Example 2
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get subreseller
Returns information about a subreseller account.
Suggest Edits
Standard parameters
action = get
object = subreseller
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
username Required Username of the subreseller.
Response parameters for get subreseller
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 nameObligationDefinition/Value
allowed_tld_list Returned if is_success = true List of TLDs that the subreseller is allowed to sell.
ccp_enabled Returned if is_success = true Indicates whether credit card payments are allowed for the subreseller.
N—No
Y—Yes
cert_permission Returned if is_success = true Indicates whether the subreseller is allowed to sell SSL Certificates.
0—No
1—Yes
contact_set Returned if is_success = true Sub-Reseller’s contact information.
The admin contact for a subreseller is the Emergency Contact, which is not the same as a domain admin contact.
The following values are required for the subreseller admin contact: first_name, last_name, org_name, phone, and email.
The tech contact, can include any of the fields explained in the contact_set section; however, it must include first_name, last_name, org_name, address1, city, phone, and email.
If country is Canada or U.S , it also includes the state and postal code parameters.
low_balance_email Returned if is_success = true The email address to which notices are sent when the subreseller's account balance falls to a predefined level.
nameservers Optional List of default nameservers for the subreseller.
payment_email Optional The email address to which payment notices are sent.
pricing_plan Returned if is_success= true The pricing plan assigned to the subreseller.
reseller_id Returned if is_success= true The ID of the reseller who created and manages the subreseller.
status Returned if is_success= true Set the status of the account.
Allowed values are active, onhold, locked, canceled, and paid_only.
storefront_rwi Optional Indicates whether the Storefront link displays in the RWI for this subreseller (and hence whether the subreseller can configure a Storefront).
N—Do not display the Store front link
Y—Display the Store front link
system_status_email Returned if is_success= true The email address that will receive system status messages.
url Optional The web address of the account.
username Returned if is_success= true Username for the new subreseller.
Examples for get subreseller
RequestResponse
<?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">GET</item> <item key="object">SUBRESELLER</item> <item key="attributes"> <dt_assoc> <item key="username">subtest</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="object">SUBRESELLER</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Query Successful</item> <item key="pricing_plan_id">84</item> <item key="pricing_plan">silver</item> <item key="attributes"> <dt_assoc> <item key="system_status_email">[email protected]</item> <item key="low_balance_email">[email protected]</item> <item key="status">cancelled</item> <item key="cert_permission">0</item> <item key="nameservers"> <dt_assoc> <item key="fqdn4" /> <item key="fqdn2">ns2.systemdns .com</item> <item key="fqdn5" /> <item key="fqdn1">ns1.systemdns .com</item> <item key="fqdn6" /> <item key="fqdn3" /> </dt_assoc> </item> <item key="payment_email">[email protected]</item> <item key="username">subtest</item> <item key="allowed_tld_list"> <dt_array> <item key="0">.cc</item> <item key="1">.com.vc </item> <item key="2">.net</item> <item key="3">.com</item> <item key="4">.nl</item> <item key="5">.mobi</item> <item key="6">.fr</item> <item key="7">.tv</item> <item key="8">.ltd.uk </item> <item key="9">.co.uk </item> <item key="10">.me.uk </item> <item key="11">.vc</item> <item key="12">.at</item> <item key="13">.info</item> <item key="14">.it</item> <item key="15">.ch</item> <item key="16">.net.uk </item> <item key="17">.mx</item> <item key="18">.us</item> <item key="19">.es</item> <item key="20">.org.vc </item> <item key="21">.asia</item> <item key="22">.org</item> <item key="23">.be</item> <item key="24">.tel</item> <item key="25">.eu</item> <item key="26">.net.vc </item> <item key="27">.plc.uk </item> <item key="28">.biz</item> <item key="29">.ca</item> <item key="30">.name</item> <item key="31">.de</item> <item key="32">.dk</item> <item key="33">.org.uk </item> <item key="34">.li</item> <item key="35">.me</item> </dt_array> </item> <item key="wsb_permission">0</item> <item key="contact_set"> <dt_assoc> <item key="admin"> <dt_assoc> <item key="email">[email protected]</item> <item key="org_name" /> <item key="phone">+1.4165551234 </item> <item key="phone2">+1.4165551123 </item> <item key="first_name">John</item> <item key="last_name">Doe</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="org_name">Sub Reseller Company Inc.</item> <item key="first_name">John</item> <item key="last_name">Doe</item> <item key="title">CEO</item> <item key="phone">+1.4165551122 x333</item> <item key="fax">+1.4165551221 </item> <item key="email">[email protected]</item> <item key="address1">55 Reseller Ave</item> <item key="address2">Suite 99</item> <item key="address3"></item> <item key="city">New York</item> <item key="state">NY</item> <item key="country">US</item> <item key="postal_code"> 70218</item> </dt_assoc> </item> </dt_assoc> </item> <item key="storefront_rwi">Y</item> <item key="ccp_enabled">Y</item> <item key="reseller_id">9782</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 2 years ago
* * *
Table of Contents
Standard parameters
Attributes
Response parameters for get subreseller
Standard parameters
Attributes
Examples for get subreseller
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get (subuser)
Queries a domain's sub-user data.
Suggest Edits
Request parameters for get (subuser)
Standard parameters
action = get
object = subuser
registrant_ip = valid IP address of the registrant (optional)
username = name of the user (parent) account
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The relevant domain.
Response parameters for get (subuser)
Standard parameters
action = reply
object = subuser
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.
(If there is no sub-user on the domain, the attributes are empty.)
Parameter nameObligationDefinition/Value
d Returned if is_success = true The sub-user's ID.
permission Returned if is_success = true The sub-user's permission level.
The permissio value is a bit mask indicating which parts of th domain information the sub-user can change.
1—Owner
2—Admin
4—Billing
8—Tech
16—Nameservers
32—Rsp_whois_info
username Returned if is_success = true The sub-user's username.
Examples for get (subuser)
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">get</item> <item key="object">subuser</item> <item key="domain">yourdomain.com </item> <item key="username">aaaa</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">SUBUSER</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command Successful</item> <item key="attributes"> <dt_assoc> <item key="permission">2</item> <item key="username">subludak</item> <item key="id">2532880</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for get (subuser)
Standard parameters
Attributes
Response parameters for get (subuser)
Standard parameters
Attributes
Examples for get (subuser)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get (userinfo)
Retrieves a user's general information.
Suggest Edits
Request parameters for get (userinfo)
Standard parameters
action = get
object = user_info
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The relevant domain.
Response parameters for get (userinfo)
Standard parameters
action = reply
object = userinfo
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
The Reseller Agent (RSA) could respond with a 250 response_code, which indicates that the action was submitted for processing in an asynchronous registry.
OpenSRS processes the request when the registry's reply is received.
Performing a get userinfo command indicates if there is an action currently waiting on a domain.
This information can be used to alert the user that there is a waiting request.
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter nameObligationDefinition/Value
capabilities Returned if is_success = true An associative array containing parameters specific to the action.
dns_errors Returned for .DE if is_success = true This contains the DNS errors if any, in text format .DE only
domain Returned if is_success = true Fully qualified domain name.
IDN names are returned in Punycode for .COM/.NET and in RACE for .ORG.
domain_count Returned if is_success = true Total number of domains in the current user profile.
A domain count > 1 indicates that the get domain list action is possible.
encoding_type Optional Encoding type for the domain.
For a list of languages and codes, see
“Appendix C: Encoding Types for IDNs”.
expiredate Returned if is_success= true Expiration date for the domain as specified in the 'domain' field.
f_owner Returned if is_success= true A flag indicating whether the current user is the owner of the domain(s).
If set to 1 then the current user is the owner of the domain, if set to 0, then the user is a subuser of the domain and may only be authorized to do certain actions.
permission Returned if is_success = true An associative array containing parameters specific to the action.
1—Owner
2—Admin
4—Billing
8—Tech
16—Nameservers
32—Rsp_whois_info
username Returned if is_success = true The sub-user's username
waiting_requests_no Returned if is_success = true The number of registry requests in the waiting state.
Capabilities
Parameters within the capabilities associative array are described below.
Parameter nameObligationDefinition/Value
change_ips_tag Optional Indicates if option is available for end user to change the Domain Tag; applicable to .UK domains only.
1—Option available for end user to change Domain Tag
0—Option not available for end user to change Domain Tag
domain_auth_info Always returned Secret pass phrase stored at the registry, which is used to authorize transfers of domains.
1—True
0—False
The absence of a key also signifies false.
dnssec Always returned Indicates whether DNSSEC is supported for domain.
1—True
0—False
forwarding_email Always returned Some TLDs offer an email forwarding service.
Often the end user must explicitly purchase this service.
1—True
0—False
The absence of a key also signifies false.
uk_whois_opt Optional Indicates if option is available for end user to opt out of display of personal information in WHOIS for .UK.
The WHOIS opt-out is available for .UK domains only, and only to individuals (i.e .
not corporations).
1—End user is eligible to use the opt-out feature for .UK WHOIS
0—End user is not eligible to use the opt- out feature for .UK WHOIS
Examples for get (userinfo)
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">GET</item> <item key="object">USERINFO</item> <item key="domain">yourdomain.com </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">USERINFO</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command Successful</item> <item key="attributes"> <dt_assoc> <item key="waiting_requests_no">8</item> <item key="domain">example.org .uk</item> <item key="encoding_type" /> <item key="expiredate">2007-11-25 00:00:00</item> <item key="permission" /> <item key="domain_count">131</item> <item key="f_owner">1</item> <item key="username">aaaa</item> <item key="capabilities"> <dt_assoc> <item key="forwarding_email">0</item> <item key="domain_auth_info">0</item> <item key="dnssec">1</item> <item key="uk_whois_opt">1</item> <item key="change_ips_tag">1</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 2 years ago
* * *
Table of Contents
Request parameters for get (userinfo)
Standard parameters
Attributes
Response parameters for get (userinfo)
Standard parameters
Attributes
Capabilities
Examples for get (userinfo)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_balance
Queries the requester's account, and returns the total amount of money in the account and the amount that is allocated to pending transactions.
Suggest Edits
Request parameters
Standard request parameters
action = get_balance
object = domain
* * *
Response parameters
Standard response parameters
action = reply
object = domain
is_success = Boolean 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.
Response attributes
If the request is successful, the attributes associative array may include the following:
ParameterObligationDefinition/Value
balance Always returned The total amount of money in the requester's account, including the amount that is allocated to pending transactions.
hold_balance Always returned The amount of money in the requestor's account that is allocated to pending transactions.
* * *
Example
RequestResponse
<?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">GET_BALANCE</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="balance">9000.01 </item> <item key="hold_balance">0.00 </item> </dt_assoc> </item> <item key="response_code">200</item> <item key="response_text">Command successful</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters
Response parameters Response attributes
Example
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_capabilities
Returns a list of available product types enabled on the account.
Suggest Edits
Request parameters
Standard request parameters
action = get_capabilities
object = trust_service
* * *
Response parameters
Standard response parameters
action = get_capabilities:reply
object = trust_service
is_success = Boolean 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.
Response attributes
If the request is successful, the attributes associative array may include the following:
ParameterObligationDefinition/Value
enabled_product_types Always returned An associative array containing enabled product types.
* * *
Example
RequestResponse
<?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">get_capabilities</item> <item key="object">trust_service</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">GET_CAPABILITIES:REPLY<item> <item key="object">TRUST_SERVICE<item> <item key="is_success">1<item> <item key="attributes"> <dt_assoc> <item key="enabled_product_types"> <dt_array> <item key="0">positivessl_wildcard<item> <item key="1">digicert_sslplus<item> <item key="2">sslwebserver_ev<item> <item key="3">rapidssl<item> <item key="4">trustwave_ev_san5<item> <item key="5">truebizid<item> <item key="6">comodo_premiumssl_wildcard<item> <item key="7">comodo_ssl<item> <item key="9">comodo_instantssl<item> <item key="10">digicert_sslplus_ev<item> ...
<dt_array> <item> <dt_assoc> <item> <item key="response_code">200<item> <item key="response_text">Command completed successfully.<item> <dt_assoc> <data_block> <body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Standard request parameters
Response parameters Response attributes
Example
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_cert
Returns the certificate for the specified SSL service product as well as associated product information.
Suggest Edits
Request parameters
Standard request parameters
action = get_cert
object = trust_service
Request attributes
Parameters within the attributes associative array are described below:
ParameterObligationDefinition/Value
product_id Required The SSL service product ID number.
return_ca_certs Optional If this parameter is included and set to 1, the response will include root CA and intermediate certificates.
return_pkcs7_cert Optional If this parameter is included and set to 1, the response will include the PKCS7 format certificate.
* * *
Response parameters
Standard response parameters
action = reply
object = trust_service
is_success = Boolean 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.
Response attributes
If the request is successful, the attributes associative array may include the following:
ParameterObligationDefinition/Value
cert_data Always returned The SSL service certificate, for more information please see the cert_data table below.
contact_email Always returned The contact email address that was submitted with the SSL service order; may be the admin email address or the organization email address, depending on the product type.
domain Always returned The domain associated with the SSL service.
expiry_date Always returned The date the SSL service expires.
issue_date Always returned The date the SSL service was issued.
product_id Always returned The product ID number for the SSL service.
product_type Always returned The product type of the SSL service.
start_date Always returned The start date of the SSL service.
state Always returned The state of the product.
Allowed values are:
expired
active
renewing
renewed
revoked
Response parameters within the cert_data associative array may include the following:
ParameterObligationDefinition/Value
ca_certificates Returned if return_ca_certs=1 An array that includes the root CA or intermediate CA certificates in order.
Note: Trustwave products do not return CA certificates; however, the intermediate bundle can be downloaded by visiting the Trustwave Support page.
certificate Always returned The SSL certificate issued.
pkcs7 Returned if return_pkcs7_cert=1 The PKCS7 format certificate issued.
* * *
Example
RequestResponse
<?xml version='1.0 ' encoding='UTF-8'?> <OPS_envelope> <header> <version>0.9 </version> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">get_cert</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="product_id">2096</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="object">TRUST_SERVICE</item> <item key="is_success">1</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="cert_data"> <dt_assoc> <item key="certificate" -----BEGIN CERTIFICATE REQUEST----- MIICuzCCAaMCADB3MQswCQYDVQQGEwJVUzEUMBIGA1UEAxMLZXhhbXBsZS5jb20x FDASBgNVBAcTC1NhbnRhIENsYXJhMRUwEwYDVQQKEwxFeGFtcGxlIEluYy4xEzAR BgNVBAgTCkNhbGlmb3JuaWExEDAOBgNVBAsTB1N1cHBvcnQwggEiMA0GCSqGSIb3 DQEBAQUAA4IBDwAwggEKAoIBAQDTCJ1qnH3gaKVd8VXTOx5GR+MYinU36Z9psxuG haMZ70qhTwng5zcbC93XIpAJRkbMwMu1EI10QDNi91Z4ORI9ExbBg0HBrAz+k85O lMUk1xTR8FQ8eHWXLnL3uXDevi5XMsb0ASB6wADDdvVm2Eb4qu+B1KD5qCSPiRJ2 FLeNNI3JNosmKmtmhqgy6+0qYYTP5RPFJeIu55cvX+r9ghiL11eBg/A+3RBhLdLR +z0CsngOFMlNxzmP0csINw4FIj4AoAkMiA/2Hf6rT6bHiAtJDbkW6jAS3AQjB1IC LlkFbr12e5P7USqSsKSbwslOHHBJpfYceA6582MI4ZZ3CerNAgMBAAGgADANBgkq hkiG9w0BAQsFAAOCAQEAaUwWHGCekeDC9U0OqLHlaXT9yRTpBcMu3waqWWhIgxLP 6ut1YlYjz1yAc7XIJPNo+uyXX1BtrMpGgXt7cJmwLeXPHHs1WoleQfKOGjVRf3+8 sQgdVroMR8HtOPid00Vxd4v1caUQtM7N2e2sWe5IL5OS2ziAflc3UhSoLu7JQwNg pKCQbOVbq5Y+uWYmMkKaZewIiziUvqngUMgA2ci+BJ2xCZmq00Leq+AZMLKPI2NE NcKsc4yjB4envG4vzc4qMFQakvH0uvsswZc80H7R7neThUgpfQM+PhDI/z3woTPG exAECZo+AqWhnwdut/Socu+aFkMO0vl77JD4acjODA== -----END CERTIFICATE REQUEST----- </item> </dt_assoc> </item> <item key="expiry_date">2012-05-08T07:34:49.000 -04:00</item> <item key="state">active</item> <item key="product_type">quickssl</item> <item key="domain">example.com </item> <item key="issue_date">2012-04-30T11:27:59.000 -04:00</item> <item key="product_id">2096</item> <item key="contact_email">[email protected]</item> <item key="start_date">2012-04-28T19:42:30.000 -04:00</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Response attributes
Example
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_contract
Retrieves the text of the reseller agreement known as Exhibit A.
Suggest Edits
Request parameters
Standard request parameters
action = get_contract
object = domain
Request attributes
Parameters within the attributes associative array are described below:
ParameterObligationDefinition/Value
type Required Type of query.
Allowed value is: exhibit_a
* * *
Response parameters
Standard response parameters
action = reply
object = domain
is_success = Boolean 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.
Response attributes
If the request is successful, the attributes associative array may include the following:
ParameterObligationDefinition/Value
contract Always returned The text of the reseller agreement known as Exhibit A.
* * *
Example
RequestResponse
<?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">GET_CONTRACT</item> <item key="attributes"> <dt_assoc> <item key="type">exhibit_a</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="response_text">Contract data successfully retrieved</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="contract"> <dt_assoc> <item key="text">1.
AGREEMENT.
In this Registration Agreement ("Agreement") "you" and "your" refer to the registrant of each domain name registration.....etc.....</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Response attributes
Example
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_deleted_domains
Lists domains that have been deleted due to expiration or deleted by request (revoked).
This command applies to all domains in a reseller's profile.
Results include the domain, status, and deleted date.
All attributes are optional, but can be used to narrow the search criteria.
If no attributes are specified, the response contains all domains that were ever deleted from your profile.
Suggest Edits
Request parameters
Standard request parameters
action = get_deleted_domains
object = domain
Request attributes
Parameters within the attributes associative array are described below:
ParameterObligationDefinition/Value
admin_email
billing_email
owner_email
tech_email Optional Can be used to search for deleted domains associated with a specific email.
Wildcards (*) are accepted.
del_from
del_to Optional Specify a start/end date, in the format YYYY-MM-DD from which to return deleted domains.
Use both del_from and del_to to specify a range to search.
If not used with del_to, all domains from the del_from date onward are returned.
If not used with del_from, all domains ever deleted from the del_to date and earlier are returned.
Note: The year specified cannot exceed 2030; otherwise an error is returned.
exp_from
exp_to Optional Specify a start/end date, in the format YYYY-MM-DD, from which to return expired-deleted domains.
Use both exp_from and exp_to to specify a range to search.
If not used with exp_to, all expired-deleted domains from the exp_from date onward are returned.
If not used with exp_from, all domains ever expired-deleted from the exp_to date and earlier are returned.
Note: The year specified cannot exceed 2030; otherwise an error is returned.
domain Optional Submit this attribute only to check if a specific domain has been deleted.
limit Optional Maximum number of orders to display on a page; the default is 40.
page Optional Determines which page to retrieve, using the page number; the default is 1 and the page index starts at 0 (zero).
* * *
Response parameters
Standard response parameters
action = reply
object = domain
is_success = Boolean 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.
Response attributes
If the request is successful, the attributes associative array may include the following:
ParameterObligationDefinition/Value
del_domains Always returned Associative array which list details about each deleted domain.
For more information, see the del_domains table below.
page_size Always returned The maximum number of domains returned per page.
total Always returned The number of deleted domains.
Response parameters within the del_domains associative array may include the following:
ParameterObligationDefinition/Value
delete_date Always returned The date the domain was deleted, in the format DD-MMM-YYYY hh:mm:ss
delete_date_epoch Always returned The date the domain was deleted, in UNIX time.
expiredate Always returned The date the domain expired, in the format DD-MMM-YYYY hh:mm:ss
expiredate_epoch Always returned The date the domain expired, in UNIX time.
name Always returned The domain name that was deleted.
reason Always returned Indicates the reason the domain was deleted.
Possible values are:
Auction
By-Request
Expired
Historical
Transferred
* * *
Example
RequestResponse
<?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">GET_DELETED_DOMAINS</item> <item key="attributes"> <dt_assoc> <item key="del_from">2021-01-01</item> <item key="del_to">2022-11-01</item> <item key="exp_from">2021-01-01</item> <item key="exp_to">2022-11-01</item> <item key="owner_email">*</item> <item key="admin_email">*</item> <item key="billing_email">*</item> <item key="tech_email">*</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="page">1</item> <item key="page_size">40</item> <item key="total">3</item> <item key="del_domains"> <dt_array> <item key="0"> <dt_assoc> <item key="name">example1.com </item> <item key="delete_date">01-MAR-2021 12:08:11</item> <item key="delete_date_epoch">1614618491</item> <item key="expiredate">01-MAR-2022 17:07:17</item> <item key="expiredate_epoch">1646172437</item> <item key="reason">By-Request</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">example2.com </item> <item key="delete_date">16-NOV-2021 02:52:51</item> <item key="delete_date_epoch">1637049171</item> <item key="expiredate">20-OCT-2022 14:14:21</item> <item key="expiredate_epoch">1666289661</item> <item key="reason">Transfered</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">example3.com </item> <item key="delete_date">17-FEB-2021 10:52:25</item> <item key="delete_date_epoch">1613577145</item> <item key="expiredate">20-JAN-2021 14:25:14</item> <item key="expiredate_epoch">1611170714</item> <item key="reason">Delete-Domain-API</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> <item key="response_code">200</item> <item key="response_text">Command successful</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Response attributes
Example
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_dns_zone
View the DNS records for a specified domain.
Suggest Edits
Request parameters for get_dns_zone
Standard parameters
action = get_dns_zone
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The domain whose DNS you want to view.
Response parameters for get_dns_zone
Standard parameters
action = reply
object = domain
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 nameObligationDefinition/Value
nameservers_ok Returned if is_success = true Indicates whether the domain is set up to use the OpenSRS nameservers.
0—Nameservers are not set to the DNS service nameservers
1—Nameservers are set to the DNS service nameservers
records Returned if is_success = true A list of the record types defined for the domain; each record includes the settings for that record.
Record types may be:
A
AAAA
CNAME
MX
SRV
TXT
For more information, see the Records table below.
Records
Parameters within the records associative array are described below.
Parameter nameObligationDefinition/Value
A Optional Maps the domain name to the IP address.
The A record consists of the following:
ip_address—InternetProtocolAddress.A numeric address that computers recognize, for example, 123.45 .54.123 .
subdomain—The third level of the domain name, such as www or ftp.
AAAA Optional Maps the domain name to the IPv6 address.
The AAAA record consists of the following:
subdomain—The third level of the domain name, such as www or ftp.
ipv6_address—The next generation Internet Protocol designed as the successor to version 4.
It is normally written as eight groups of four hexadecimal digits (i.e .
2003:0db8: 85a3:0000:0000:8a2e: 0370:7334
CNAME Optional Canonical Name.
CNAME records can be used when you want a subdomain to point to another hostname.
Allows you to create an alias for your domain.
The CNAME record consists of the following:
hostname—The FQDN of the domain that you want to access.
subdomain—The third level of the domain name, such as www or ftp.
MX Optional Mail Exchange.
MX records determine how mail is delivered to your domain.
Ensures that email that is sent to you is routed to the correct destination.
The MX record consists of the following:
priority—The priority of the target host,lower
value means more preferred.
subdomain—The third level of the domain
name, such as www or ftp.
* hostname—The FQDN of the domain that you want to access.
SRV Optional Service Record.
The SRV record consists of the following:
priority—The priority of the target host,lower
value means more preferred.
weight—Arelative weight for records with the
same priority.
subdomain—The third level of the domain
name, such as www or ftp.
hostname—The FQDN of the domain that you
want to access.
* port—The TCP or UDP port on which the service is to be found.
TXT Optional Text Record.
Allows you to attach comments to a hostname, for example, SPF data to validate that email is being sent from the IP address of the domain's mail server.
The TXT record consists of the following:
subdomain—The third level of the domain
name, such as www or ftp.
text—The comments that you want to include.
Examples for get_dns_zone
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">get_dns_zone</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command Successful</item> <item key="attributes"> <dt_assoc> <item key="records"> <dt_assoc> <item key="A"> <dt_array> <item key="0"> <dt_assoc> <item key="subdomain"></item> <item key="ip_address">17.16 .156.5 </item> </dt_assoc> </item> </dt_array> </item> <item key="MX"> <dt_array> <item key="0"> <dt_assoc> <item key="priority">10</item> <item key="subdomain">www</item> <item key="hostname">example.org </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="priority">1</item> <item key="subdomain"></item> <item key="hostname">mx.cust .aug17dnstest1.com .hostedemail.com </item> </dt_assoc> </item> </dt_array> </item> <item key="SRV"> <dt_array> <item key="0"> <dt_assoc> <item key="priority">1</item> <item key="weight">3</item> <item key="subdomain">w3</item> <item key="hostname">yummynames.com </item> <item key="port">81</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> <item key="nameservers_ok">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for get_dns_zone
Standard parameters
Attributes
Response parameters for get_dns_zone
Standard parameters
Attributes
Examples for get_dns_zone
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_domain_affiliate_id
Retrieves the affiliate id associated with a domain.
Suggest Edits
Request parameters
Standard request parameters
action = get_domain_affiliate_id
object = domain
Request attributes
ParameterObligationDefinition/Value
domain Required The domain name to be queried.
* * *
Response parameters
Standard response parameters
action = reply
object = domain
is_success = Boolean 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.
Response attributes
If the request is successful, the attributes associative array may include the following:
ParameterObligationDefinition/Value
affiliate_id Always returned The affiliate id associated with the domain.
* * *
Example
RequestResponse: if affiliate_id existsResponse: if affiliate_id does not exist
<?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">GET_DOMAIN_AFFILIATE_ID</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="affiliate_id">AFFILIATE_ID</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="response_text">Command Successful</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="affiliate_id"></item> </dt_assoc> </item> <item key="response_code">200</item> <item key="response_text">Command Successful</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Response attributes
Example
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_domain_forwarding
Queries the domain forwarding settings for a specified domain.
Suggest Edits
Request parameters for get_domain_forwarding
Standard parameters
action = get_domain_forwarding
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The relevant domain.
Response parameters for get_domain_forwarding
Standard parameters
action = reply
object = domain
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 nameObligationDefinition/Value
forwarding Returned if is_success = true A list of the subdomains that are forwarded; can be empty.
For more information, see the Forwarding table below.
Forwarding
Parameters within the forwarding associative array are described below.
Parameter nameObligationDefinition/Value
description Optional The description of the website; used by search engines.
destination_url Optional The full address of the destination website, for example, http://www.mycompany .com/ mybestpage.html , or the IP address, for example, http://12.34 .56.123
enabled Optional Indicates whether domain forwarding is in effect.
0—Domain forwarding is off
1—Domain forwarding is on
keywords Optional Descriptive words that a visitor might use when searching for the website; used by search engines.
masked Optional Indicates whether the destination website address appears in the browser address field.
0—The actual destination address displays.
1—The destination address is masked and the original domain address is displayed instead.
subdomain Always returned The third level of the domain name, such as www or ftp.
Note: Although this parameter is required, its value can be null.
title Optional The text that appears in the browser title bar.
Examples for get_domain_forwarding
Example 1
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="forwarding" /> <item key="action">get_domain_forwarding</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </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">DOMAIN</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="forwarding"> <dt_array> <item key="0"> <dt_assoc> <item key="keywords" /> <item key="masked">0</item> <item key="subdomain">mail</item> <item key="destination_url">http://mail.example .org/webmail</item> <item key="title">Main Web Mail Access 1</item> <item key="description">Default Web Mail Access</item> <item key="enabled">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="keywords" /> <item key="masked">1</item> <item key="subdomain">www</item> <item key="destination_url">http://www.example .org</item> <item key="title">Main Web Access 1</item> <item key="description">Default Site Access Forward</item> <item key="enabled">1</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
Without end-user credentials
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">get_domain_forwarding</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </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">DOMAIN</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="forwarding"> <dt_array> <item key="0"> <dt_assoc> <item key="keywords" /> <item key="masked">1</item> <item key="subdomain">mail</item> <item key="destination_url">http://mail.example .org/webmail</item> <item key="title">Main Web Mail Access 1</item> <item key="description">Default Web Mail Access</item> <item key="enabled">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="keywords" /> <item key="masked">1</item> <item key="subdomain">www</item> <item key="destination_url">http://www.example .org</item> <item key="title">Main Web Access 1</item> <item key="description">Default Site Access Forward</item> <item key="enabled">1</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for get_domain_forwarding
Standard parameters
Attributes
Response parameters for get_domain_forwarding
Attributes
Forwarding
Examples for get_domain_forwarding
Example 1
Example 2
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_domains_by_expiredate
Retrieves domains that expire within a specified date range.
Suggest Edits
Request parameters
Standard request parameters
action = get_domains_by_expiredate
object = domain
Request attributes
ParameterObligationDefinition/Value
exp_from
exp_to Required Specify a start/end date range from which to return expired domains, in the format: yyyy-MM-dd.
limit Optional The maximum number of domains to return per page.
The default is set to 40 if not specified.
page Optional Determines which page to retrieve, using the page number.
The page index starts at 0 (zero) and default is 1 if not specified.
* * *
Response parameters
Standard response parameters
action = reply
object = domain
is_success = Boolean 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.
Response attributes
If the request is successful, the attributes associative array may include the following:
ParameterObligationDefinition/Value
exp_domains Always returned An associative array which lists the domains that expire during the specified period.
For more information, see the exp_domains table.
page Always returned The number of the page retrieved.
remainder Always returned Indicates if some expiring domains were not returned due to restrictions set by the page and limit values.
0—No, all expiring domains are listed.
1—Yes, there are remaining expiring domains not listed.
total Always returned The total number of domains expiring in the specified date range.
Response parameters within the exp_domains associative array may include the following:
ParameterObligationDefinition/Value
name Always returned The name of the domain that is expiring.
expiredate Always returned The date the domain expires, in the format yyyy-MM-dd.
f_auto_renew Always returned Indicates whether the domain is set to automatically renew.
Y—Domain is set to auto-renew.
N—Domain is not set to auto-renew.
f_let_expire Always returned Indicates whether the domain will send renewal notices or expire silently.
Y—Expire domain silently, ICANN mandated notifications will continue to be sent to the registrant.
N—Do not expire domain silently.
* * *
Example
RequestResponse
<?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">GET_DOMAINS_BY_EXPIREDATE</item> <item key="attributes"> <dt_assoc> <item key="exp_from">2021-01-01</item> <item key="exp_to">2022-11-07</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="page">1</item> <item key="total">3</item> <item key="remainder">0</item> <item key="exp_domains"> <dt_array> <item key="0"> <dt_assoc> <item key="name">example1.com </item> <item key="expiredate">2022-09-25 00:03:39</item> <item key="f_let_expire">N</item> <item key="f_auto_renew">N</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">example2.com </item> <item key="expiredate">2022-09-30 20:07:10</item> <item key="f_let_expire">N</item> <item key="f_auto_renew">N</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">example3.com </item> <item key="expiredate">2022-10-18 17:13:19</item> <item key="f_let_expire">Y</item> <item key="f_auto_renew">N</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> <item key="response_code">200</item> <item key="response_text">Command successful</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Response attributes
Example
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_domains_contacts
Queries the contact information for the specified domains.
Suggest Edits
Request parameters
Standard request parameters
action = get_domains_contacts
object = domain
Request attributes
Parameters within the attributes associative array are described below:
ParameterObligationDefinition/Value
domain_list Required An array which lists the domain names for which to query contact information.
The maximum number of domains that can be specified in a single request is 100.
active_contacts_only Optional Retrieves the currently active contact information for owner, admin, billing and tech, as they are currently set on the domain.
This info will be returned regardless of whether there is a pending trade in progress.
0—Returns pending contacts when a trade has been initiated.
1—Returns active contacts.
* * *
Response parameters
Standard response parameters
action = reply
object = domain
is_success = Boolean 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.
Response attributes
The attributes array includes an array of associative arrays, one for each domain queried.
The associative array for each domain includes the contact set for that domain.
If the request is successful, each domain in the attributes associative array may include the following:
ParameterObligationDefinition/Value
contact_set Always returned An associative array containing the contact information for the domain.
status Always returned The status of the contact.
Possible values are:
active
pending_current_registrant
pending_new_registrant
* * *
Example
RequestResponse
<?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">GET_DOMAINS_CONTACTS</item> <item key="attributes"> <dt_assoc> <item key="active_contacts_only">1</item> <item key="domain_list"> <dt_array> <item key="0">example.com </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="example.com "> <dt_assoc> <item key="contact_set"> <dt_assoc> <item key="admin"> <dt_assoc> <item key="status">active</item> <item key="first_name">Firstname</item> <item key="last_name">Lastname</item> <item key="org_name">OpenSRS</item> <item key="address1">96 Mowat Ave</item> <item key="address2"/> <item key="address3"/> <item key="city">Toronto</item> <item key="state">ON</item> <item key="country">CA</item> <item key="postal_code">M6K 3M1</item> <item key="email">[email protected]</item> <item key="phone">+1.4165350123 </item> <item key="fax"/> </dt_assoc> </item> <item key="billing"> <dt_assoc> <item key="status">active</item> <item key="first_name">Firstname</item> <item key="last_name">Lastname</item> <item key="org_name">OpenSRS</item> <item key="address1">96 Mowat Ave</item> <item key="address2"/> <item key="address3"/> <item key="city">Toronto</item> <item key="state">ON</item> <item key="country">CA</item> <item key="postal_code">M6K 3M1</item> <item key="email">[email protected]</item> <item key="phone">+1.4165350123 </item> <item key="fax"/> </dt_assoc> </item> <item key="owner"> <dt_assoc> <item key="status">active</item> <item key="first_name">Firstname</item> <item key="last_name">Lastname</item> <item key="org_name">OpenSRS</item> <item key="address1">96 Mowat Ave</item> <item key="address2"/> <item key="address3"/> <item key="city">Toronto</item> <item key="state">ON</item> <item key="country">CA</item> <item key="postal_code">M6K 3M1</item> <item key="email">[email protected]</item> <item key="phone">+1.4165350123 </item> <item key="fax"/> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="status">active</item> <item key="first_name">Firstname</item> <item key="last_name">Lastname</item> <item key="org_name">OpenSRS</item> <item key="address1">96 Mowat Ave</item> <item key="address2"/> <item key="address3"/> <item key="city">Toronto</item> <item key="state">ON</item> <item key="country">CA</item> <item key="postal_code">M6K 3M1</item> <item key="email">[email protected]</item> <item key="phone">+1.4165350123 </item> <item key="fax"/> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> <item key="response_code">200</item> <item key="response_text">Command successful</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Response attributes
Example
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_notes
Retrieves the domain notes that detail the history of the domain.
Suggest Edits
Request parameters
Standard request parameters
action = get_notes
object = domain
Request attributes
ParameterObligationDefinition/Value
domain Required The domain name to query.
type Required Type of notes to display.
Allowed values are:
domain
order
transfer
order_id Required if type=order The ID number of the order.
transfer_id Required if type=transfer The ID number of the transfer.
limit Optional Maximum number of notes to display on a page
page Optional Determines which page to retrieve, using the page number, using the page number.
The page index starts at 1 and the default is 1 if not specified.
* * *
Response parameters
Standard response parameters
action = reply
object = domain
is_success = Boolean 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.
Response attributes
If the request is successful, the attributes associative array may include the following:
ParameterObligationDefinition/Value
notes Always returned An associative array listing note contents, parameters in the associative array are:
timestamp—Date and time the note was recorded, in the format: DD-MMM-YYYY hh:mm:ss
note—Contents of the note
transaction_id Always returned The ID number of the current request.
page Always returned The number of the page retrieved.
page_size Always returned The maximum number of notes returned per page.
total Always returned The total number of notes returned.
* * *
Example
RequestResponse
<?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="object">DOMAIN</item> <item key="action">GET_NOTES</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="type">domain</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="is_success">1</item> <item key="transaction_id">2022-11-07 14:50:31 1967 101</item> <item key="attributes"> <dt_assoc> <item key="total">1</item> <item key="page">1</item> <item key="page_size">40</item> <item key="notes"> <dt_array> <item key="0"> <dt_assoc> <item key="timestamp">03-NOV-2022 10:14:13</item> <item key="note">Registrant's [email|first_name last_name] was updated from [[email protected]|FirstName LastName] to [[email protected]|FirstName2 LastName2]</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> <item key="response_code">200</item> <item key="response_text">Command successful</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Response attributes
Example
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_order_info
Queries all the information on an order ID.
Suggest Edits
Request parameters
Standard request parameters
action = get_order_info
object = trust_service
Request attributes
Parameters within the attributes associative array are described below:
ParameterObligationDefinition/Value
order_id Required The ID of the order to query.
* * *
Response parameters
Standard response parameters
action = reply
object = trust_service
is_success = Boolean 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.
Response attributes
If the request is successful, the attributes associative array may include the following:
ParameterObligationDefinition/Value
approver_email Always returned for domain vetted certificates The email address used to approve the SSL Service order.
contact_email Always returned
contact_set Always returned
csr Always returned
domain Always returned The domain name for which the SSL certificate was purchased.
notes_list Always returned
order_id Always returned The ID of the SSL Service order.
period Always returned
price Always returned The price charged for the SSL Service.
product_id Always returned if the order is completed.
The ID number of the SSL Service product.
product_type Always returned The product type from the SSL Certificate inventory.
reg_type Always returned Type of order.
Allowed values are:
new
renewal
transfer
upgrade
server_type Always returned The type of server software used to generate the CSR.
special_instructions Always returned User defined instructions regarding the SSL Service certificate purchase.
state Always returned The state of the order.
supplier_order_id Always returned The ID number for the SSL vendor.
* * *
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Standard response parameters
Response attributes
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_orders_by_domain
Retrieves information about orders placed for a specific domain.
Suggest Edits
Request parameters
Standard request parameters
action = get_orders_by_domain
object = domain
Request attributes
Parameters within the attributes associative array are described below:
ParameterObligationDefinition/Value
domain Required The domain to query
limit Optional Maximum number of orders to display on a page; the default is 40.
order_from
order_to Optional Specify a start/end date from which to return orders, in the format YYYY-MM-DD.
Use both order_from and order_to to specify a range to search.
If not used with order_to, all orders from the order_from date onward are returned.
If not used with order_from, all orders from the order_to date and earlier are returned
page Optional Determines which page to retrieve, using the page number.
The default is 1 and the page index starts at 1.
status Optional Status of the order, allowed values are:
completed
pending
declined
cancelled
deleted
waiting
pending_fax
ca_owner_approval
type Optional Type of order query, allowed values are:
new
premium
renewal
sunrise
transfer
* * *
Response parameters
Standard response parameters
action = reply
object = domain
is_success = Boolean 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.
Response attributes
ParameterObligationDefinition/Value
orders Always returned An array of orders, each orders item contains an associative array with the following parameters:
id—The ID number of the order.
order_date—The date the order was created.
status—Current status of the order.
type—The type of order.
If the request is successful, the attributes associative array may include the following:
* * *
Example
RequestResponse
<?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">get_orders_by_domain</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="page">1</item> <item key="order_from">2007-10-01</item> <item key="status">pending</item> <item key="type">new</item> <item key="limit">100</item> <item key="order_to">2007-10-16</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="object">DOMAIN</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="page_size">100</item> <item key="orders"> <dt_array> <item key="0"> <dt_assoc> <item key="order_date">16-OCT-2007 15:21:26</item> <item key="status">pending</item> <item key="type">new</item> <item key="id">103789</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="order_date">16-OCT-2007 15:21:23</item> <item key="status">pending</item> <item key="type">new</item> <item key="id">103788</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Response attributes
Example
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_price
Queries the price of a domain, and can be used to determine the cost of a billable transaction for any TLD.
A returned price for a given domain does not guarantee the availability of the domain, but indicates that the requested action is supported by the system and calculates the cost to register the domain (if available).
Suggest Edits
Request parameters
Standard request parameters
action = get_price
object = domain
Request attributes
Parameters within the attributes associative array are described below:
ParameterObligationDefinition/Value
domain Required The domain to be queried.
period Required The desired registration period, default is 1.
all_periods Optional Return prices for all available periods.
Accepted values are, 1 or 0.
reg_type Optional The type of registration.
Allowed values are:
new—(default)
renewal
transfer
trade
* * *
Response parameters
Standard response parameters
action = reply
object = domain
is_success = Boolean 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.
Response attributes
If the request is successful, the attributes associative array may include the following:
ParameterObligationDefinition/Value
price Always returned The price of the queried domain.
This value includes the OpenSRS price and the ICANN fee.
prices Returned if all_periods=1 An array containing the prices for all available periods.
This value includes the OpenSRS price and the ICANN fee.
is_registry_premium Returned only for premium domains Indicates whether the domain is a registry premium.
registry_premium_group Returned only for premium domains Indicates the type of registry premium domain, for more information, see our help article.
📘Note
A value for is_registry_premium will only be returned if:
1.
The domain is registry premium
2.
The registry premium tier into which the domain falls is enabled in the reseller's account.
3.
The accurate price for the domain will always be returned, regardless of whether or not the premium tier into which the domain falls is enabled.
* * *
Examples
Example 1: Standard domain
RequestResponse
<?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">GET_PRICE</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="period">1</item> <item key="reg_type">new</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="object">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command Successful</item> <item key="attributes"> <dt_assoc> <item key="price">20.2 </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2: Premium domain
RequestResponseResponse for all_periods=1
<?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">GET_PRICE</item> <item key="attributes"> <dt_assoc> <item key="domain">restful.blue </item> <item key="period">1</item> <item key="reg_type">new</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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 Successful</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registry_premium_group">2</item> <item key="price">83.99 </item> <item key="is_registry_premium">1</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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 Successful</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registry_premium_group">2</item> <item key="price">83.99 </item> <item key="is_registry_premium">1</item> <item key="prices"> <dt_assoc> <item key="6">503.93 </item> <item key="3">251.96 </item> <item key="7">587.92 </item> <item key="9">755.89 </item> <item key="2">167.98 </item> <item key="8">671.90 </item> <item key="1">83.99 </item> <item key="4">335.95 </item> <item key="10">839.88 </item> <item key="5">419.94 </item> </dt_assoc> </item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Response attributes
Examples Example 1: Standard domain
Example 2: Premium domain
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_product_info
Queries the properties of the specified SSL Service product.
Suggest Edits
Request parameters for get_product_info
Standard parameters
action = get_product_info
object = trust_service
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
all_info Optional If included and set to 1, the response includes the CSR and contact information.
If the certificate was migrated from TPP, the response includes
the TPP order ID and inventory ID.
inventory_item_id Optional; may be used for
certificates that were migrated
from TPP.
The certificate product ID number that was used in the TPP system.
This value may be used in place of product_id.
product_id Required The SSL Service ID number.
Note: This value is not required for certificates that were migrated from TPP if inventory_item_id is submitted.
Response parameters for get_product_info
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 nameObligationDefinition/Value
contact_email Returned if is_success = true The administrator email address.
csr Returned if is_success = true Certificate Signing Request.
The SSL Service provider uses this information generate the certificate.
domain Returned if is_success = true The domain with which the SSL Service is
associated.
expiry_date Returned if is_success = true The date that the SSL Service certificate expires.
inventory_item_id Returned if is_success = true and cert was migrated from TPP The certificate product ID number that was
used in the TPP system.
is_renewable Returned if is_success = true Indicates whether the product is can be renewed at this time.
SSL Service products can be renewed between 60 days
before the expiry date and 15 days after expiry date.
Allowed values are:
0—Product cannot be renewed at
this time.
1—Product can be renewed.
issue_date Returned if is_success = true The date that the SSL Service certificate was issued.
product_id Returned if is_success = true The ID number for the SSL Service.
product_type Returned if is_success = true The product type from the SSL Certificate inventory.
The product types are detailed in
the allowed values section for this key.
Allowed values are:
comodo_ev
comodo_instantssl
comodo_premiumssl
comodo_premiumssl_wildcard
comodo_ssl
comodo_wildcard
essentialssl
essentialssl_wildcard
positivessl
malwarescan
quickssl
quickssl_premium
securesite
securesite_pro
securesite_ev
securesite_pro_ev
sgcsuper_certs
sitelock_basic
sitelock_premium
sitelock_enterprise
sitelock_find
sitelock_fix
sitelock_prevent
sitelock_911
ssl123
essentialssl_wildcard
sslwebserver
sslwebserver_wildcard
sslwebserver_ev
symantec_ssl_lite
symantec_ssl_lite_wildcard
truebizid
truebizid_wildcard
truste_hpp (Hosted Privacy Policy)
truste_tps (TRUSTE Privacy Policy
with seal)
truebizid_ev
trustwave_dv
trustwave_ev
trustwave_premiumssl
trustwave_premiumssl_wildcard
start_date Returned if is_success = true The effective date for the SSL Service.
state Returned if is_success = true The state of the product.
Allowed values are:
expired
active
renewing
renewed
* revoked
tpp order_id Returned if cert was migrated from TPP and is_success = true The order number that was used in the TPP system.
upgrade_options Returned if is_success = true
and product_type = sitelock_find
or sitelock_fix Indicates the product types to which the existing product can be upgraded.
Currently, this applies to Sitelock products only.
If product_type = sitelock_find, values returned are sitelock_fixand sitelock_prevent; if product_type = sitelock_fix, value returned is sitelock_prevent.
Examples for get_product_info
Example 1
Retrieves the properties for a SSL Service product.
RequestResponse
<?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">get_product_info</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="product_id">99</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="object">TRUST_SERVICE</item> <item key="is_success">1</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="product_type">truebizid_wildcard</item> <item key="issue_date">2010-09-14-04:00</item> <item key="domain">*.example.com </item> <item key="product_id">99</item> <item key="contact_email">[email protected]</item> <item key="start_date">2010-09-13-04:00</item> <item key="expiry_date">2010-09-22-04:00</item> <item key="is_renewable">0</item> <item key="state">expired</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
Retrieves all information for a SSL Service product.
RequestResponse
<?xml version='1.0 ' encoding='UTF-8'?> <OPS_envelope> <header> <version>0.9 </version> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">get_product_info</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="all_info">1</item> <item key="product_id">6015</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">TRUST_SERVICE</item> <item key="response_text">Command completed successfully.</item> <item key="action">GET_PRODUCT_INFO:REPLY</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="csr_data"> <dt_assoc> <item key="country">US</item> <item key="organization_unit">Support</item> <item key="valid_true_domain">1</item> <item key="state">California</item> <item key="locality">Santa Clara</item> <item key="email"></item> <item key="domain">example.com </item> <item key="valid_quick_domain">1</item> <item key="has_bad_extensions">0</item> <item key="organization">Example Inc.</item> </dt_assoc> </item> <item key="notes_list"> <dt_array> <item key="0"> <dt_assoc> <item key="date">2016-04-18T00:20:04.000 -04:00</item> <item key="type">product_active</item> <item key="note">The product with the id [6015] has been created.</item> </dt_assoc> </item> </dt_array> </item> <item key="expiry_date">2017-04-18T19:59:59.000 -04:00</item> <item key="state">active</item> <item key="product_type">quickssl</item> <item key="domain">example.com </item> <item key="issue_date">2016-04-17T23:48:52.000 -04:00</item> <item key="product_id">6015</item> <item key="is_renewable">0</item> <item key="contact_email">[email protected]</item> <item key="contact_set"> <dt_assoc> <item key="organization"> <dt_assoc> <item key="country">US</item> <item key="org_name">Example Inc.</item> <item key="phone">+1.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="title">Organization</item> </dt_assoc> </item> <item key="admin"> <dt_assoc> <item key="country">US</item> <item key="org_name">Example Inc.</item> <item key="phone">+1.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="title">Admin</item> </dt_assoc> </item> <item key="billing"> <dt_assoc> <item key="country">US</item> <item key="org_name">Example Inc.</item> <item key="phone">+1.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="title">Billing</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="country">US</item> <item key="org_name">Example Inc.</item> <item key="phone">+1.4165550123 </item> <item key="last_name">Wayne</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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">Thomas</item> <item key="title">Tech</item> </dt_assoc> </item> </dt_assoc> </item> <item key="csr"> -----BEGIN CERTIFICATE REQUEST----- MIICuzCCAaMCADB3MQswCQYDVQQGEwJVUzEUMBIGA1UEAxMLZXhhbXBsZS5jb20x FDASBgNVBAcTC1NhbnRhIENsYXJhMRUwEwYDVQQKEwxFeGFtcGxlIEluYy4xEzAR BgNVBAgTCkNhbGlmb3JuaWExEDAOBgNVBAsTB1N1cHBvcnQwggEiMA0GCSqGSIb3 DQEBAQUAA4IBDwAwggEKAoIBAQDTCJ1qnH3gaKVd8VXTOx5GR+MYinU36Z9psxuG haMZ70qhTwng5zcbC93XIpAJRkbMwMu1EI10QDNi91Z4ORI9ExbBg0HBrAz+k85O lMUk1xTR8FQ8eHWXLnL3uXDevi5XMsb0ASB6wADDdvVm2Eb4qu+B1KD5qCSPiRJ2 FLeNNI3JNosmKmtmhqgy6+0qYYTP5RPFJeIu55cvX+r9ghiL11eBg/A+3RBhLdLR z0CsngOFMlNxzmP0csINw4FIj4AoAkMiA/2Hf6rT6bHiAtJDbkW6jAS3AQjB1IC LlkFbr12e5P7USqSsKSbwslOHHBJpfYceA6582MI4ZZ3CerNAgMBAAGgADANBgkq hkiG9w0BAQsFAAOCAQEAaUwWHGCekeDC9U0OqLHlaXT9yRTpBcMu3waqWWhIgxLP 6ut1YlYjz1yAc7XIJPNo+uyXX1BtrMpGgXt7cJmwLeXPHHs1WoleQfKOGjVRf3+8 sQgdVroMR8HtOPid00Vxd4v1caUQtM7N2e2sWe5IL5OS2ziAflc3UhSoLu7JQwNg pKCQbOVbq5Y+uWYmMkKaZewIiziUvqngUMgA2ci+BJ2xCZmq00Leq+AZMLKPI2NE NcKsc4yjB4envG4vzc4qMFQakvH0uvsswZc80H7R7neThUgpfQM+PhDI/z3woTPG exAECZo+AqWhnwdut/Socu+aFkMO0vl77JD4acjODA== -----END CERTIFICATE REQUEST----- </item> <item key="let_expire">0</item> <item key="upgrade_options"></item> <item key="start_date">2016-04-17T20:00:00.000 -04:00</item> </dt_assoc> </item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 3
Retrieves all information for a SSL Service product that was migrated from
the TPP system.
RequestResponse
<?xml version='1.0 ' encoding='UTF-8'?> <OPS_envelope> <header> <version>0.9 </version> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">get_product_info</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="all_info">1</item> <item key="product_id">2076</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="object">TRUST_SERVICE</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="tpp_order_id">9997602</item> <item key="csr_data"> <dt_assoc> <item key="country">US</item> <item key="organization_unit">QA Dept</item> <item key="valid_true_domain">1</item> <item key="state">CA</item> <item key="locality">Santa Clara</item> <item key="email">[email protected]</item> <item key="domain">renewtest.example .org</item> <item key="valid_quick_domain">1</item> <item key="has_bad_extensions">0</item> <item key="organization">Example Co.</item> </dt_assoc> </item> <item key="notes_list"> <dt_array> <item key="0"> <dt_assoc> <item key="date">2012-04-12T11:20:11.000 - 05:00</item> <item key="type">product_active</item> <item key="note">The product with the id [2076] has been created.</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="date">2012-04-12T11:20:59.000 - 05:00</item> <item key="type">product_renewing</item> <item key="note">The product with the id [2076] is in the process of being renewed.</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="date">2012-04-12T11:25:07.000 - 05:00</item> <item key="type">product_renewed</item> <item key="note">The product with the id [2076] has been renewed.</item> </dt_assoc> </item> </dt_array> </item> <item key="expiry_date">2012-04-19T20:46:39.000 -05:00</item> <item key="inventory_item_id">8887602</item> <item key="state">renewed</item> <item key="product_type">quickssl</item> <item key="domain">renewtest.example .org</item> <item key="issue_date">2012-04-12T11:19:11.000 -05:00</item> <item key="product_id">2076</item> <item key="is_renewable">0</item> <item key="contact_email">[email protected]</item> <item key="contact_set"> <dt_assoc> <item key="admin"> <dt_assoc> <item key="first_name">Adler</item> <item key="last_name">Adams</item> <item key="title">Administrator</item> <item key="org_name">Example Co.</item> <item key="address1">32 Oak Street</item> <item key="address2">Suite 100</item> <item key="address3" /> <item key="city">Santa Clara</item> <item key="state">CA</item> <item key="postal_code">90210</item> <item key="country">US</item> <item key="phone">+1.4165550123x1812 </item> <item key="fax">+1.4165550125 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="first_name">Ted</item> <item key="last_name">Tucker</item> <item key="title" /> <item key="org_name">Example Co.</item> <item key="address1">32 Oak Street</item> <item key="address2">Suite 100</item> <item key="address3" /> <item key="city">Santa Clara</item> <item key="state">CA</item> <item key="postal_code">90210</item> <item key="country">US</item> <item key="phone">+1.4165550123x1243 </item> <item key="fax">+1.4165550125 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="organization"> <dt_assoc> <item key="first_name">Jim</item> <item key="last_name">Johnson</item> <item key="title">Director</item> <item key="org_name">Example Co.</item> <item key="address1">32 Oak Street</item> <item key="address2">Suite 100</item> <item key="address3" /> <item key="city">Santa Clara</item> <item key="state">CA</item> <item key="country">US</item> <item key="postal_code">90210</item> <item key="phone">+1.4165550123x1224 </item> <item key="email">[email protected]</item> <item key="fax">+1.4165550126 </item> </dt_assoc> </item> <item key="billing"> <dt_assoc> <item key="first_name">Bill</item> <item key="last_name">Burton</item> <item key="title" /> <item key="org_name">Example Co.</item> <item key="address1">32 Oak Street</item> <item key="address2">Suite 200</item> <item key="address3" /> <item key="city">Santa Clara</item> <item key="state">CA</item> <item key="country">US</item> <item key="postal_code">90210</item> <item key="phone">+1.4165550123x1248 </item> <item key="fax">+1.4165550136 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="csr">-----BEGIN CERTIFICATE REQUEST----- MIIC3DCCAcQCAQAwgZYxIzAhBgNVBAMTGnJlbmV3dGVzdC5xYXJlZ3Jlc3Npb24ub3JnMQs wCQYDVQQGEwJDQTELMAkGA1UECBMCT04xEDAOBgNVBAcTB1Rvcm9udG8x DzANBgNVBAoTBlR1Y293czEQMA4GA1UECxMHUUEgRGVwdDEgMB4GCSqGSIb3DQEJARYRcWF maXZlQHR1Y293cy5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK AoIBAQDS7+XQflaRIXlWlRv9MRwa5vidu4uKciZdthDVkWo50lYPVZcwSY1v5bhTwIGpGna 22ak3snH+GDcYKqy9umY0cVbJRM16jsWNiVc4xgylR6JD/rGxG7DVlUu/ qJK1T8tl09PGLz9yRWnLSb9BbZ85tRgq1+up57/O4zXNgznRZhxibr5mgb4w/5yWga/elUa t6GJNLsbvZo+k516JgCk2trudH9+tr72454T8ZR5fbdw23GruqvQGilUY UsKe1Uywv8vgml1AIGTPctPwfxcFhRPMdWbZ/YmmaxNvd1/DBXZKL8F0wh672aGNEx5DXTk so2tVPwpadgyLJFqMaHdzAgMBAAGgADANBgkqhkiG9w0BAQQFAAOCAQEA YYLY/3lGaxxxQASKwm4mUY4QAytqp24A0/i1OSOJNG86OOR8ws7VtFSGKa2B//gx6y2KAI6 zomWL4Zpl4DcD8ttckv343DqFwjzJWn5P5/uLBg1z1QVJfVXAyWOt7PQb qx3EfaiVMgoHYCyQgXx50/iKg1w+k2Q2PUGPVJQFTBdXKBn5eaRJJW2JNJVhaNok9peAgsE adXTUGMrKpU0iaExWTvHBN3v9jjF1tow/hhbUqBGk80OVb2MGsa5Rp5aP WG8wWgI67EYcDe2IKvRfoPfzKw6WsLHq2GHp+qqJjXAUB4TBP3/cb3nIrAA8+h9lR3UCZ0L yB0rQM7pkk0t9Jw== -----END CERTIFICATE REQUEST-----</item> <item key="start_date">2012-04-11T09:02:43.000 -05:00</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated almost 8 years ago
* * *
Table of Contents
Request parameters for get_product_info
Standard parameters
Attributes
Response parameters for get_product_info
Standard parameters
Attributes
Examples for get_product_info
Example 1
Example 2
Example 3
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_products
Suggest Edits
Request parameters for get_products
Standard parameters
action = get_products
object = trust_service
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
max_expiry_date Required Used in conjunction with min_expiry_date attribute
The latest expiry date to use to generate a list of Trust Service products.
Date must be in the format YYYY-MM-DD.
min_expiry_date Required Used in conjunction with max_expiry_date attribute.
The earliest expiry date to use to generate a list of Trust Service products.
Date must be in the format YYYY-MM-DD.
state Optional The state of the Trust Service products that you want returned.
Allowed values are:
activated
active
expired
renewed
revoked
upgraded
Response parameters for get_products
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
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
product_list Returned if is_success =
true An array that lists the products whose expiry dates are within a specific date range.
For more information, see the product_list table below.
product_list
Parameters within the product_list associative array are described below.
Parameter nameObligationDefinition/Value
contact_email Returned if is_success = true The email contact from the order.
domain Returned if is_success = true The domain or hostname to which the Trust Service applies.
expiry_date Returned if is_success = true The date that the Trust Service product expires.
is_renewable Returned if is_success = true Indicates whether the product is can be renewed at this time.
Trust Service products can be renewed between 60 days before the expiry date and 15 days after expiry date.
Allowed values are:
0—Product cannot be renewed at this
time.
1—Product can be renewed.
issue_date Returned if is_success = true The date that the Trust Service product was
issued.
product_id Returned if is_success =
true The ID number of the Trust Service product
product_type Returned if is_success =
true The product type from the SSL Certificate inventory.
Allowed values are:
comodo_ev
comodo_instantssl
comodo_premiumssl
comodo_premiumssl_wildcard
comodo_ssl
comodo_wildcard
essentialssl
essentialssl_wildcard
positivessl
malwarescan
quickssl
quickssl_premium
securesite
securesite_ev
securesite_pro
securesite_pro_ev
sgcsuper_certs
sitelock_basic
sitelock_premium
sitelock_enterprise
sitelock_find
sitelock_fix
sitelock_prevent
sitelock_911
ssl123
sslwebserver
sslwebserver_ev
sslwebserver_wildcard
symantec_ssl_lite
symantec_ssl_lite_wildcard
truebizid
truebizid_ev
truebizid_wildcard
truste_hpp (Hosted Privacy Policy)
truste_tps (TRUSTE Privacy Policy with
seal)
trustwave_dv
trustwave_ev
trustwave_premiumssl
* trustwave_premiumssl_wildcard
start_date Returned if is_success =
true The effective date for the Trust Service.
state Returned if is_success =
true The state of the Trust Service product.
Allowed values are:
approver-confirmed—Owner has confirmed the domain vetted certificate.
awaiting-approval—Order processed successfully; waiting for supplier
approval.
cancelled —Pending order was
cancelled.
completed—Order is complete.
declined—Order cancelled after it was
processed or declined by the supplier.
in-progress—Order is in progress.
* pending—Order saved as pending.
Examples for get_products
Request
<?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">get_products</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="min_expiry_date">2012-04-23</item> <item key="state">expired</item> <item key="max_expiry_date">2012-09-22</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
<?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">REPLY</item> <item key="object">TRUST_SERVICE</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="product_list"> <dt_array> <item key="0"> <dt_assoc> <item key="expiry_date">2012-04-23T10:41:04.000 - 04:00</item> <item key="state">expired</item> <item key="product_type">quickssl</item> <item key="issue_date">2012-04-16T09:17:46.000 - 04:00</item> <item key="domain">example.org </item> <item key="product_id">2094</item> <item key="contact_email">[email protected]</item> <item key="is_renewable">0</item> <item key="start_date">2012-04-14T20:14:48.000 - 04:00</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="expiry_date">2012-05-08T07:34:49.000 - 04:00</item> <item key="state">expired</item> <item key="product_type">securesite_pro</item> <item key="issue_date">2012-04-30T11:27:59.000 - 04:00</item> <item key="domain">example.net </item> <item key="product_id">2096</item> <item key="contact_email">[email protected]</item> <item key="is_renewable">0</item> <item key="start_date">2012-04-28T19:42:30.000 - 04:00</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated almost 8 years ago
* * *
Table of Contents
Request parameters for get_products
Standard parameters
Attributes
Response parameters for get_products
Standard parameters
Attributes
product_list
Examples for get_products
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_registrant_verification_status
When a domain is registered or transferred, or when the registrant contact information is changed, the registrant must reply to an email requesting them to confirm that the submitted contact information is correct.
This command returns the current state of the verification request.
Suggest Edits
Request parameters
Standard request parameters
action = get_registrant_verification_status
object = domain
Request attributes
ParameterObligationDefinition/Value
domain Required The domain name to retrieve the registrant verification status for.
* * *
Response parameters
Standard response parameters
action = reply
object = domain
is_success = Boolean 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.
Response attributes
Parameters within the attributes associative array are described below:
ParameterObligationDefinition/Value
registrant_verification_status Always returned The current status of the verification.
Allowed values are:
admin_reviewing—The registrant data has been submitted and is being validated manually by the Tucows Compliance team.
pending—The verification process has been initiated, and the verification email will be sent.
suspended—The registrant has failed verification and the domain has been suspended.
verified—The registrant has been validated.
verifying—The verification process has been initiated and is waiting for registrant response.
unverified—The verification process has not been initiated.
verification_deadline Returned for unverified domains The date by which the domain will be suspended.
days_to_suspend Returned for unverified domains The number of days remaining until the domain is suspended if the registrant information is not validated.
If the domain has already been suspended, this value will be a negative number.
email_bounced Returned for unverified domains Returns 1, if the verification email was triggered because the WDRP or the renewal notice bounced.
* * *
Example
RequestResponse
<?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">get_registrant_verification_status</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command Successful</item> <item key="attributes"> <dt_assoc> <item key="registrant_verification_status">suspended</item> <item key="verification_deadline">2013-11-02 00:00:00</item> <item key="email_bounced">1</item> <item key="days_to_suspend">2</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Response attributes
Example
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_trade_designated_agent
Queries the current state (enabled or disabled) of the designated agent setting for the specified domain.
Suggest Edits
Request Parameters for get_trade_designated_agent
Standard parameters
action = get_trade_designated_agent
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The domain to which the trade pertains.
Response Parameters for get_trade_designated_agent
Standard parameters
action = reply
object = domain
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
The attributes array includes an array of associative arrays, one for each
domain queried.
The associative array for each domain includes the contact
set for that domain.
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
allow_designated_agent Always returned Indicates whether TUCOWS is allowed to act as the designated agent.
Possible values are:
0 - Indicates that TUCOWS does not have permission act as a "designated agent".
The registrant/owner will therefore approve any and all contact owner changes for their domains via email.
1 - Indicates that TUCOWS may act on behalf of the registrant as a "designated agent".
The registrant has agreed to all terms and conditions outlined in TUCOWS' service agreement).
Examples for get_trade_designated_agent
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">GET_TRADE_DESIGNATED_AGENT</item> <item key="attributes"> <dt_assoc> <item key="domain">icanntradetest2.com </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 successful</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="allow_designated_agent">0</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request Parameters for get_trade_designated_agent
Standard parameters
Attributes
Response Parameters for get_trade_designated_agent
Standard parameters
Attributes
Examples for get_trade_designated_agent
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_trade_lock_setting
Queries the current state of the 60 day transfer lock setting for the specified domain, and whether or not it can be modified at this time.
You can modify this setting as long as the 60 day transfer lock is not currently in progress.
Suggest Edits
Request Parameters for get_trade_lock_setting
Standard parameters
action = get_trade_lock_setting
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The domain to which the trade pertains.
Response Parameters for get_trade_lock_setting
Standard parameters
action = reply
object = domain
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
The attributes array includes an array of associative arrays, one for each
domain queried.
The associative array for each domain includes the contact
set for that domain.
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
can_modify Always returned Indicates whether the 60-day trade lock can be modified at this time.
Possible values are:
1 - Modification is allowed
0 - Modification is not currently allowed
allow_hold_after_trade Always returned Indicates whether the standard post-trade-completion 60-day transfer lock setting is enabled.
The default value is always 1 unless it is explicitly disabled.
Possible values are:
1 - Enabled
0 - Disabled
Examples for get_trade_lock_setting
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">GET_TRADE_LOCK_SETTING</item> <item key="attributes"> <dt_assoc> <item key="domain">icanntradetest2.com </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 successful</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="can_modify">1</item> <item key="allow_hold_after_trade">0</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated almost 8 years ago
* * *
Table of Contents
Request Parameters for get_trade_lock_setting
Standard parameters
Attributes
Response Parameters for get_trade_lock_setting
Standard parameters
Attributes
Examples for get_trade_lock_setting
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_transfers_away
Lists domains that have been transferred away.
This command applies to all domains in a reseller's profile.
All attributes are optional, but can be used to narrow the search criteria.
If no attributes are specified, all domains that were ever transferred-away from your profile are returned.
Suggest Edits
Request parameters for get_transfers_away
Standard parameters
action = get_transfers_away
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Optional Submit the domain name attribute only if you want to check if a particular domain has been transferred away.
gaining_registrar Optional Search for transfers-away according to gaining registrar.
String and wildcards (*) accepted.
limit Optional The maximum number of domains to return per page, up to 40.
owner_confirm_from Optional Search for transferred-away domains according to the date from when the owner confirmed or denied the transfer.
Can be used with the owner_confirm_to attribute to specify a range within which to search.
The year specified cannot exceed 2030.
Use the format YYYY-MM-DD.
owner_confirm_to Optional Search for transferred-away domains according to the date prior to when the owner confirmed or denied the transfer.
Can be used with the owner_confirm_from attribute to specify a range within which to search.
The year specified cannot exceed 2030.
Use the format YYYY-MM-DD.
owner_request_from Optional Search for transferred domains according to
the date when the email was been sent to the request_address.
Can be used with the owner_request_to attribute to specify a range within which to search.
If not used with owner_request_to, all domains from the owner_request_from date onward are returned.
The year specified cannot exceed 2030; otherwise an error is returned.
Use the format YYYY-MM-DD.
owner_request_to Optional Search for transferred domains according to the date prior to when the email was sent to the request_address.
Can be used with the owner_request_from attribute to specify a range within which to search.
If not used with owner_request_from, all domains ever transferred away from the owner_request_to date and earlier are returned.
The year specified cannot exceed 2030; otherwise an error is returned.
Use the format YYYY-MM-DD.
page Optional Determines which page to retrieve, using the page number.
The page index starts at 0 (zero).
req_from Optional Search for transferred domains according to the date when the transfer notification was sent.
Can be used with the req_to attribute to specify a range within which to search.
If not used with req_to, all domains from the req_from date onward are returned.
The year specified cannot exceed 2030; otherwise an error is returned.
Use the format YYYY-MM-DD.
req_to Optional Search for transferred domains according to the date up until the transfer notification was sent.
Can be used with the req_from attribute to specify a range within which to search.
If not used with req_from, all domains prior to the req_to date onward are returned.
The year specified cannot exceed 2030; otherwise an error is returned.
Use the format YYYY-MM-DD.
request_address Optional The admin email address at the time of notification.
Wildcards (*) accepted.
status Optional Search for transferred domains by status.
Allowed values are pending_admin, pending_owner,pending_registry, completed, or cancelled.
Response parameters for get_transfers_away
Standard parameters
action = reply
object = domain
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 nameObligationDefinition/Value
page Returned if specified in the request and is_success=
true The number of the page retrieved.
page_size Returned if specified in the request and is_success =
true The maximum number of domains returned per page.
total Returned if is_success = true The number of transferred-away domains.
transfers Returned if a transferred- away domain exists and
meets the specified search criteria and is_success = true Contains arrays that list details about each transfer-away.
For more information, see the Transfers table below.
Transfers
Parameters within the transfers associative array are described below.
Parameter nameObligationDefinition/Value
domain Returned if a transferred-away domain exists and meets the specified search criteria.
The domain that was transferred-away.
gaining_registrar Always returned for transferred away domains.
The registrar that gained the transferred-away domain.
owner_choice Always returned for transferred away domains.
Indicates the owner's response to the transfer-away request.
I—Ignored
Y—Approved
* N—Declined
owner_confirm_date Always returned for transferred away domains.
Date when the owner responded to the transfer request.
owner_confirm_date_epoch Always returned for transferred away domains.
Date when the owner responded to the transfer request, in UNIX time.
owner_request_date Always returned for transferred away domains.
Date when transfer request was sent to the owner.
owner_request_date_epoch Always returned for transferred away domains.
Date when transfer request was sent to the owner, in UNIX time.
registry_request_date Always returned for transferred away domains.
The date when the transfer request was sent to the registry.
registry_request_date_epoch Always returned for transferred away domains.
The date when the transfer request was sent to the registry, in UNIX time.
request_address Always returned for transferred away domains.
The admin contact email address, at the time of transfer notification
request_date Always returned for transferred away domains.
The date when the transfer request was sent.
request_date_epoch Always returned for transferred away domains.
The date when the transfer request was sent, in UNIX time.
status Always returned for transferred away domains.
The status of the transfer:
Allowed values are
pending_admin
pending_owner
pending_registry
completed
* cancelled.
Examples for get_transfers_away
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">GET_TRANSFERS_AWAY</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="status">completed</item> <item key="request_address">[email protected]</item> <item key="gaining_registrar">Tucows Inc.</item> <item key="limit">40</item> <item key="page">1</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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command successful</item> <item key="attributes"> <dt_assoc> <item key="page">1</item> <item key="page_size">2</item> <item key="total">1</item> <item key="transfers"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">example.com </item> <item key="status">completed</item> <item key="gaining_registrar">Tucows Inc.</item> <item key="owner_choice">Y</item> <item key="owner_confirm_ip">10.0 .12.165 </item> <item key="owner_request_date">20-JUL- 2006 16:14:41</item> <item key="owner_request_date_epoch">1153426481</item> <item key="owner_confirm_date">20-JUL- 2006 16:18:08</item> <item key="owner_confirm_date_epoch">1153426688</item> <item key="request_address">[email protected]</item> <item key="request_date">20-JUL-2006 16:14:36</item> <item key="request_date_epoch">1153426476</item> <item key="registry_request_date">20-JUL- 2006 16:18:09</item> <item key="registry_request_date_epoch">1153426689</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for get_transfers_away
Standard parameters
Attributes
Response parameters for get_transfers_away
Standard parameters
Attributes
Transfers
Examples for get_transfers_away
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
get_transfers_in
Lists domains that have been transferred in.
This command applies to all domains in a reseller's profile.
All attributes are optional, but can be used to narrow the search criteria.
If no attributes are specified, all domains that were ever transferred into your profile are returned.
Suggest Edits
Request parameters for get_transfers_in
Standard parameters
action = get_transfers_in
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
completed_from Optional Definition/Value
completed_to Optional Specify the end date for the search.
Only domains transferred on or before the specified date are returned.
Use the format YYYY-MM-DD.
domain Optional Submit the domain name attribute only if you want to check if a particular domain has been transferred in.
limit Optional The maximum number of domains to return per page, up to 40.
losing_registrar Optional Search for transfers-in according to losing registrar.
String and wildcards (*) accepted.
order_id Optional ID number of the order.
order_from Optional Specify a starting date, in the format YYYY- MM-DD from which to return orders.
Can be used with the order_to parameter to specify a range within which to search.
If not used with order_to, all orders from the order_from date onward are returned.
order_to Optional Specify an end date, in the format YYYY- MM-DD, before which to return orders.
Can be used with the attribute order_from parameter to specify a range within which to search.
If not used with order_from, all orders from the order_to date and earlier are returned.
owner_confirm_from Optional Search for transferred-in domains according to the date from when the owner confirmed or denied the transfer.
Can be used with the owner_confirm_to attribute to specify a range within which to search.
Use the format YYYY-MM-DD.
Note: The year specified cannot exceed
2030.
owner_confirm_ip Optional The IP address from which the owner confirmed or denied the transfer-in request.
owner_confirm_to Optional Search for transferred-in domains according to the date prior to when the owner confirmed or denied the transfer.
Can be used with the owner_confirm_from attribute to specify a range within which to search.
Use the format YYYY-MM-DD.
Note: The year specified cannot exceed
2030.
owner_request_from Optional Search for transferred domains according to the date when the email was been sent to the request_address.
Can be used with the owner_request_to attribute to specify a range within which to search.
If not used with owner_request_to, all domains from the owner_request_from date onward are returned.
The year specified cannot exceed 2030; otherwise an error is returned.
Use the format YYYY-MM-DD.
owner_request_to Optional Search for transferred domains according to the date prior to which the email was been sent to the request_address.
Can be used with the owner_request_from attribute to specify a range within which to search.
If not used with owner_request_from, all domains ever transferred in prior to the owner_request_to date are returned.
Use the format YYYY-MM-DD.
Note: The year specified cannot exceed 2030; otherwise an error is returned.
page Optional Determines which page to retrieve, using the page number.
The page index starts at 0 (zero).
request_address Optional The admin email address at the time of notification.
Wildcards (*) accepted.
status Optional Search for transferred domains by status.
Allowed values are pending_admin, pending_owner, pending_registry, completed, or cancelled.
transfer_id Optional ID number of the transfer.
Response parameters for get_transfers_in
Standard parameters
action = reply
object = domain
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 nameObligationDefinition/Value
page Returned if specified in the request and is_success = true The number of the page retrieved.
page_size Returned if specified in the request and is_success = true The maximum number of domains returned per page.
total Returned if is_success = true The number of transferred-in domains.
transfers Returned if a transferred-in domain exists and meets the specified search criteria and is_success = true Contains arrays that list details about each transfer-in.
For more information, see the Transfers table below.
Transfers
Parameters within the transfers associative array are described below.
Parameter nameObligationDefinition/Value
affiliate_id Returned if specified in the transfer order.
The unique identifier of an RSP's affiliate, which allows the RSP to track orders
coming through different affiliates.
completed_date Always returned in the case of a transferred-in domain.
Date when the transfer was completed.
completed_date_epoch Always returned in the case of a transferred-in domain.
Date when the transfer was completed, in UNIX time.
domain Returned if a transferred- in domain exists and meets the specified search criteria.
The domain that was transferred in.
gaining_registrar Always returned in the case of a transferred-in domain.
The registrar that gained the transferred-in domain.
losing_registrar Always returned in the case of a transferred-in domain.
The registrar that lost the transferred-in domain.
order_date Always returned in the case of a transferred-in domain.
Date the order was created.
order_date_epoch Always returned in the case of a transferred-in domain.
Date the order was created, in UNIX time.
owner_choice Always returned in the case of a transferred-in domain.
Indicates the owner's response to the transfer-in request.
I—Ignored
Y—Approved
* N—Declined
owner_confirm_date Always returned in the case of a transferred-in domain.
Date when the owner responded to the transfer request.
owner_confirm_date_epoch Always returned in the case of a transferred-in domain.
Date when the owner responded to the transfer request, in UNIX time.
owner_confirm_ip Always returned in the case of a transferred-in domain.
The IP address from which the owner responded to the transfer request.
owner_request_date Always returned in the case of a transferred-in domain.
Date when transfer request was sent to the owner.
owner_request_date_e poch Always returned in the case of a transferred-in domain.
Date when transfer request was sent to the owner, in UNIX time.
registry_request_date Always returned in the case of a transferred-in domain.
The date when the transfer request was sent to the registry.
registry_request_date_epoch Always returned in the case of a transferred-in domain.
The date when the transfer request was sent to the registry, in UNIX time.
request_address Always returned in the case of a transferred-in domain.
The admin contact email address, at the time of transfer notification.
request_date Always returned in the case of a transferred-in domain.
The date when the transfer request was sent.
request_date_epoch Always returned in the case of a transferred-in domain.
The date when the transfer request was sent, in UNIX time.
status Always returned in the case of a transferred-in domain.
The status of the transfer: pending_owner, pending_registry, completed, or cancelled.
Note: pending_admin has been deprecated.
transfer_id Always returned.
ID number of the transfer.
Examples for get_transfers_in
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">GET_TRANSFERS_IN</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="owner_request_to">2006-10-06</item> <item key="page">1</item> <item key="status">cancelled</item> <item key="transfer_id">1234</item> <item key="request_address">[email protected]</item> <item key="losing_registrar">Tucows</item> <item key="completed_to">2006-10-06</item> <item key="domain">example.cc </item> <item key="order_from">2006-10-04</item> <item key="order_to">2008-10-06</item> <item key="order_id">987625</item> <item key="completed_from">2006-10-04</item> <item key="limit">20</item> <item key="owner_confirm_to">2006-10-06</item> <item key="owner_request_from">2006-10-04</item> <item key="owner_confirm_from">2006-10-04</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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command successful</item> <item key="attributes"> <dt_assoc> <item key="page_size">20</item> <item key="page">1</item> <item key="total">1</item> <item key="transfers"> <dt_array> <item key="0"> <dt_assoc> <item key="owner_request_date">06-OCT- 2006 14:23:54</item> <item key="status">cancelled</item> <item key="affiliate_id">NUAffiliate123</item> <item key="registry_request_date" /> <item key="owner_confirm_date" /> <item key="registry_request_date_epoch" /> <item key="owner_confirm_ip" /> <item key="completed_date">06-OCT-2006 14:59:01</item> <item key="order_date_epoch">1159729141</item> <item key="owner_confirm_date_epoch" /> <item key="request_address">[email protected]</item> <item key="losing_registrar">Tucows</item> <item key="domain">kaka.cc </item> <item key="order_date">06-OCT-2006 14:23:52</item> <item key="completed_date_epoch">1160159032</item> <item key="owner_request_date_epoch">1160159034</item> <item key="transfer_id">1234</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for get_transfers_in
Standard parameters
Attributes
Response parameters for get_transfers_in
Standard parameters
Attributes
Transfers
Examples for get_transfers_in
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
icann_trade_status_change
Suggest Edits
Response Parameters for icann_trade_status_change
If the request is successful, the attributes associative array may include the
following:
Parameter nameObligationDefinition/Value
trade_status Always returned The updated status of the trade.
Possible values include:
initiated
pending_current_registrant
current_registrant_approved
current_registrant_approved_by_da
pending_new_registrant
new_registrant_approved
new_registrant_approved_by_da
cancelled_by_new_change
cancelled_by_current_registrant
cancelled_by_new_registrant
cancelled_by_reseller
timeout
* completed
Example Response for icann_trade_status_change
<?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">EVENT</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="transaction_id">2016-09-23 16:30:11 31690 101</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="events"> <dt_array> <item key="0"> <dt_assoc> <item key="object_data"> <dt_assoc> <item key="domain_name">testing-icann-trades.org </item> <item key="domain_id">310477</item> <item key="trade_status">cancelled_by_new_registrant</item> </dt_assoc> </item> <item key="object">DOMAIN</item> <item key="event_id">e197776ce1270f0fab27da6836a22617</item> <item key="event">ICANN_TRADE_STATUS_CHANGE</item> <item key="event_date">2016-09-23T19:56:38Z</item> </dt_assoc> </item> </dt_array> </item> <item key="total">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Response Parameters for icann_trade_status_change
Example Response for icann_trade_status_change
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
lookup (domain)
Determines the availability of a specified domain name.
Suggest Edits
Request parameters
Standard request parameters
action = lookup
object = domain
registrant_ip = valid IP address of the registrant (optional)
Request attributes
Parameters within the attributes associative array are described below:
ParameterObligationDefinition/Value
domain Required The domain name to be queried.
no_cache Optional In order to obtain results quickly, the default for the lookup command is to check the local OpenSRS cache to determine domain name availability.
If you specify no_cache = 1, instead of checking the cache, the lookup command queries the applicable registry to determine domain name availability.
Note: Setting no_cache to 1 increases the amount of time it takes to get results.
* * *
Response parameters
Standard response parameters
action = reply
object = domain
is_success = Boolean 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.
📘Note
If the domain being queried is taken (response_code = 211), is_success is set to 1 because the query was successful.
Therefore, be sure to check the response_code and response_text when reading the reply.
Response attributes
If the request is successful, the attributes associative array may include the following:
ParameterObligationDefinition/Value
status Always returned Whether the domain is available or taken.
price_status Always returned The pricing status.
Undef—Non .TV domains
Fixed—Price is fixed for .TV domains.
has_claim Returned for new TLDs during the claim period Indicates whether the domain name has a matching mark registered at the Trademark Clearinghouse (TMCH).
0—No matching marks exist at the TMCH.
1—A mark is registered at the TMCH that matches the domain name.
email_available Returned for .NAME domains Indicates whether a forwarding email is available or not.
Applies to .NAME domains only.
0—No forwarding email available
1—Forwarding email available
noservice Returned for .NAME domains Indicates Registry Agent availability.
If RA is available, noservice does not appear in response.
1—Supplier unavailable
Note: when noservice = 1, is_success = 0.
Registry Premium Domain
📘Note
Querying a registry premium domain will always generate a taken response if the reseller has not enabled the registry premium tier to which the domain belongs.
If the request is successful and the domain is a registry premium domain, the attributes associative array will also include:
ParameterObligationDefinition/Value
reason Always returned Indicates that the domain is registry premium.
Value if returned: Premium Name.
* * *
Examples
Standard lookup
RequestResponse, if availableResponse, if taken
<?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">LOOKUP</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="no_cache">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">Domain available</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="price_status">undef</item> <item key="email_available">undef</item> <item key="status">available</item> </dt_assoc> </item> <item key="response_code">210</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">Domain taken</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="price_status">undef</item> <item key="email_available">undef</item> <item key="status">taken</item> </dt_assoc> </item> <item key="response_code">211</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
New TLD lookup during the claims period.
RequestResponse
<?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">LOOKUP</item> <item key="attributes"> <dt_assoc> <item key="domain">example.guru </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">Domain available</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="status">available</item> <item key="has_claim">1</item> </dt_assoc> </item> <item key="response_code">210</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Premium domain lookup
RequestResponse, enabled in accountResponse, not enabled in account
<?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">LOOKUP</item> <item key="attributes"> <dt_assoc> <item key="domain">ddd.bike </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">Domain available</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="status">available</item> <item key="reason">Premium Name</item> </dt_assoc> </item> <item key="response_code">210</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">Domain taken</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="status">taken</item> <item key="reason">Premium Name</item> </dt_assoc> </item> <item key="response_code">211</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated almost 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Response attributes
Registry Premium Domain
Examples Standard lookup
New TLD lookup during the claims period.
Premium domain lookup
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
modify (DNSSEC)
Adds or removes DS records for a given domain.
Suggest Edits
Request parameters
Standard request parameters
action = modify
object = domain
Request attributes
Parameters within the attributes associative array are described below:
ParameterObligationDefinition/Value
domain Required The domain name you wish to apply DNSSEC to.
dnssec Required Contains an array specifying the DNSSEC details to be added.
For more information, please see the dnssec table below.
Request parameters within the dnssec array includes the following:
ParameterObligationDefinition/Value
algorithm Required The cryptographic algorithm that generates the signature.
Allowed values are:
5—RSA/SHA-1
6—DSA-NSEC3/SHA1
7—RSASHA1-NSEC3/SHA1
8—RSA/SHA-256
10—RSA/SHA-512
253—Private [PRIVATEDNS]
254—Private [PRIVATEOID]
key_tag Required An integer value that identifies the DNSSEC record for this domain name.
Note: This value cannot exceed 65535.
digest_type Required The algorithm type that constructs the digest, allowed values are:
1—SHA-1
2—SHA-256
3—GOST
4—SHA-384
digest Required The digest is an alpha-numeric string value.
The length depends on the digest type used: SHA-1 is 40 characters, SHA-256 & GOST is 64 characters, SHA-384 is 96 characters.
Response parameters
Standard response parameters
action = reply
object = domain
is_success = Boolean 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
RequestResponse
<?xml version="1.0 " encoding="UTF-8"?> <OPS_envelope> <header> <version>0.9 </version> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">modify</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="data">dnssec</item> <item key="dnssec"> <dt_array> <item key="0"> <dt_assoc> <item key="algorithm">5</item> <item key="key_tag">333</item> <item key="digest_type">1</item> <item key="digest">da39a3ee5e6b4b0d3255bfef95601890afd80709</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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 successful</item> <item key="action">REPLY</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters
Examples
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
modify (domain)
Changes information associated with a domain, such as contact info.
The action request message is different depending on the type of modification being made, and is shown separately for each type.
This command also allows you to set an auto-renew flag for the domain from which you logged in.
If you are using the affected_domains option, you can set the renewal action flags for all domains in the user's profile.
Suggest Edits
Request parameters
Standard request parameters
action = modify
object = domain
registrant_ip = valid IP address of the registrant (optional)
Request attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
affect_domains Required Flag indicating the domains to which to apply the change.
0—Change applies only to the specified domain.
1—Change applies to all domains linked to this profile.
data Required Type of data.
Allowed values are:
ca_whois_display_setting—For changes to the CIRA Whois Privacy setting for .CA domains.
Only allowed for individual registrants, including Canadian citizens, Permanent residents, Legal representatives, and Aboriginal peoples.
change_ips_tag— For transfers of .UK domains between registrars.
The
domain's IPS tag must be changed to that of the gaining registrar in order to transfer a .UK domain.
cira_registrant—Used to change the owner of a .CA domain.
Warning: When you include the
cira_registrant parameter, you transfer the ownership of a domain to the specified contact.
contact_info— For contact information changes.
domain_auth_info— For changes to domain-auth-info.
expire_action— For changes to domain renewal action flags.
Requires both
auto_renew and let_expire flags to be specified.
forwarding_email— For forwarding feature on .NAME domains (cannot be set if it was missing from the capabilities in the response to the 'Get User Info'.).
it_whois_display_setting— Used to enable/disable WHOIS Privacy.
parkpage_state— Enables or disables the parked pages service for a particular
domain.
status— To control the lock state of the domain.
rsp_whois_info— To control 'RSP Info in Whois' feature
tld_data— For changes to the tld_data information that is required to satisfy the regional presence and other requirements of the registry.
Used for .ASIA, .COOP, .JOBS, .LV, .MX, .PRO, .RO, .US, ZA; optional for .XXX.
If you submit this value, you must also submit the tld_data array (see below).
whois_privacy_state— Used to enable or disable WHOIS Privacy.
whois_publicity_state— Used to enable or disable WHOIS Publicity.
domain Required The relevant domain.
tld_data Required for changes to
tld_data values for .ASIA,
.COOP, .JOBS, .LV, .MX, .PRO, .RO, .US, ZA; optional for .XXX An associative array that contains additional information required by the registry, such as the residency of the registrant.
If you submit a request that contains this array, you must also include data = tld_data.
Allowed values are:
ced_info—An array that contains Charter Eligibility (CED) information for .ASIA domains.
ipr_data—Used to make changes to the ICM information associated with .XXX domains.
it_registrant_info—For changes to the .IT identification information.
nexus—For changes to the .US Nexus information.
professional_data—Used to make changes to the professional designation information that is associated with the .PRO domain.
registrant_extra_info—additional registrant information.
For more information see tld_data.
For data = ca_whois_display_setting
When the data parameter uses the ca_whois_display_setting value, the following additional request attribute parameters can be used:
Parameter nameObligationDefinition/Value
display Required The setting for the CIRA Whois Privacy.
Allowed values are:
PRIVATE—When a WHOIS lookup is done on the domain name, do not display personal information.
FULL—When a WHOIS lookup is done on the domain name, display all of the data that is on the WHOIS directory, including name, address, telephone number and email address.
For data = change_ips_tag
When the data parameter uses the change_ips_tag value, the following additional request attribute parameters can be used:
Parameter nameObligationDefinition/Value
change_tag_all Optional Flag to change all domains on the registrant's profile.
0—Change Domain Tag for specified domain only; this is the default.
1—Change Domain Tag for all .UK domains on this profile.
domain Required The domain whose Domain Tag is being changed.
gaining_registrar_tag Required The Domain Tag of the gaining registrar.
rsp_override Optional Flag to enable or disable the ability of the RSP to override the End User's Domain Tag change settings.
0—Reseller cannot override End User's Domain Tag change settings.
1—Reseller can change Domain Tag, regardless of End User's settings.
For data = contact_info
Note: The contact_info value is not supported for .DK.
Use the update_all_info command to change the contact information for .DK domains.
When the data parameter uses the contact_info value, the following additional request attribute parameters can be used:
Parameter nameObligationDefinition/Value
contact_set Required A hash containing the modified contact information of a specific type:
admin
billing
tech
owner
Note: The owner contact for .IT domains has three additional parameters: entity_type, nationality_code, and reg_code.
For information about these parameters, see .IT contact requirements.
For more information about contact_set values, see Examples for contact set.
org_name Required Organization name.
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'.
You can submit different contact information for each contact type, or you can use the also_apply_to parameter to apply the changes to other contact types.
Additional request parameters in the contact_set associative array are described below:
Parameter nameObligationValue/Definition
also_apply_to Optional An array of other contact types to which you want to apply the changes.
For example, if you want to apply the changes indicated in the admin contact set to the owner and
tech types as well, use:
also_apply_to => ['owner', 'tech']
If only one contact type is specified and also_apply_to is empty, update only that contact type.
If also_apply_to is specified, but the complete contact set for the contact types in also_apply_to is also submitted, the complete contact set is used, and also_apply_to is ignored.
Allowed values are:
owner— Owner contact information.
admin— Administrator contact information.
billing— Billing contact information.
tech— Tech contact information
Note: The tech value is not supported for .IT domains; if submitted, the command will fail.
For data = cira_registrant
When the data parameter uses the cira_registrant value, the following additional request attribute parameters can be used:
Parameter nameObligationDefinition/Value
address1 Optional The new registrant's address.
Maximum 64 characters.
address2 Optional The new registrant's address.
Maximum 64 characters.
address3 Optional The new registrant's address.
Maximum 64 characters.
city Optional The new registrant's city.
Maximum 64 characters.
country Optional The 2 letter ISO country code.
email Optional Maximum 64 characters, validated according to rfc822.
fax Optional Maximum 20 characters, in the format +CCC.NNNNNNNNNNxEEEE , where C = country code, N = phone number, and E = extension (optional).
first_name Required New registrant's first name.
lang Optional The registrant's language preference.
The default is
English.
Allowed values are:
EN—English
FR—French
last_name Required New registrant's last name.
legal_type Required The code that indicates the new registrant's legal classification to satisfy CIRA's Canadian Presence Requirement (CPR).
Allowed values are:
ABO—Aboriginal
ASS—Association
CCO—Canadian Corporation
CCT—Canadian Citizen
EDU—Educational Institution
GOV—Government
HOP—Hospital
INB—Indian Band
LAM—Library, Archive, or Museum
LGR—Legal Representative
MAJ—His Majesty the King
OMK—Protected by Trademarks Act
PLT—Political Party
PRT—Partnership
RES—Permanent Resident
TDM—Trademark Owner
TRD—Trade Union
TRS—Trust
org_name Optional for individuals The name of the organization.
phone Optional Maximum 20 characters, in the format +CCC.NNNNNNNNNNxEEEE , where C = country code, N = phone number, and E = extension (optional).
postal_code Optional Maximum 16 characters.
state Optional A valid 2 letter code for the Canadian province:
AB—Alberta
BC—British Columbia
MB—Manitoba
NB—New Brunswick
NL—Newfoundland and Labrador
NT—Northwest Territories
NS—Nova Scotia
NU—Nunavut
ON—Ontario
PE—Prince Edward Island
QC—Quebec
SK—Saskatchewan
YT—Yukon
For data = domain_auth_info
When the data parameter uses the domain_auth_info value, the following additional request attribute parameters can be used:
Parameter nameObligationDefinition/Value
domain_auth_info Required Domain authentication code.
For data = expire_action
📘Note
The modify_expire_action command will return the response code 220 (Nothing to do.
Current auto-renew mode is the same) if attempting to set the expire_action of a domain to the same setting it is currently set to.
When the data parameter uses the expire_action value, the following additional request attribute parameters can be used:
Parameter nameObligationDefinition/Value
auto_renew Required Determines whether the domain renews automatically.
0—Do not set to auto-renew.
1—Set to auto-renew.
let_expire Required Determines whether to allow the domain to expire at the end of the registration term.
0—Do not expire domain silently.
Reseller and registrant renewal reminders will be sent.
1—Expire domain silently.
Expiry notifications will not be sent to the reseller, but any ICANN mandated notifications will continue to be sent to the registrant.
Note: This flag cannot be used for .DE domains.
To delete a .DE name or allow it to expire, you need to complete and submit the Domain Termination/Deletion form at least 5 days prior to the expiry date.
For data = forwarding_email
When the data parameter uses the forwarding_email value, the following additional parameter can be used:
Parameter nameObligationDefinition/Value
forwarding_email Required For use with .NAME forwarding feature.
For data = it_whois_display_setting
When the data parameter uses the it_whois_display_setting value, the following additional parameter can be used:
Parameter nameObligationDefinition/Value
consent_for_publishing Required The setting for the .IT Whois Privacy.
Allowed values are:
N—When a WHOIS lookup is done on the domain name, do not display personal information.
Privacy ON.
Y—When a WHOIS lookup is done on the domain name, display all of the data that is on the WHOIS
directory, including name, address, telephone number and email address.
Privacy OFF.
For data = parkpage_state
This parameter is used to enable or disable the Parked Pages service for a particular domain.
The Parked Pages service is available for .COM, .NET, .ORG, .INFO, .BIZ, .MOBI, .NAME, .ASIA, .BE, .BZ, .CA, .CC, .CO, .EU, .IN, .ME, .NL, .TV, .UK, .US, .WS and .XXX domains.
When the data parameter uses the parkpage_state value, the following additional request attribute parameters can be used:
Parameter nameObligationDefinition/Value
domain Required The domain for which you want to enable or disable Parked Pages.
state Required Used to enable or disable the Parked Pages service
for a domain.
on—Enable Parked Pages
off—Disable Parked Pages
For data = rsp_whois_info
When the data parameter uses the rsp_whois_info value, the following additional parameter can be used:
Parameter nameObligationDefinition/Value
all Required Indicates whether the request is to be applied to all domains in the profile.
0—Do not apply to all domains; this is the default.
1—Apply the request to all domains in the profile.
affect_domains Required Flag indicating the domains to which the change is to be applied.
0—Only change this specific domain.
1—Change applies to all domains linked to this profile.
flag Required Specifies whether to display the RSP info in Whois query results.
Y—Display RSP info.
N—Do not display RSP info.
For data = status
When the data parameter uses the status value, the following additional parameter can be used:
Parameter nameObligationDefinition/Value
domain Required The relevant domain.
lock_state Required Indicates whether to lock the domain.
0—Unlocked
1—Locked
For data = whois_privacy_state
When the data parameter uses the whois_privacy_state value, the following additional parameters can be used:
Parameter nameObligationvDefinition/Value
affect_domains Required Determines whether to apply the change to all domains in the reseller's profile, on just the specified domain.
0—Apply change to this domain only.
1—Apply to all domains linked to this profile.
report_email Optional The End User's email address to which notification of success or failure is sent on behalf of the reseller.
Note: This parameter can only be specified if affect_domains is set to 1.
state Required Used to enable or disable WHOIS Privacy.
Allowed values are enable or disable.
Note: The following values are deprecated, but are still accepted for backward compatibility:
N—Disable WHOIS Privacy
Y—Enable WHOIS Privacy
Response parameters
Standard response parameters
action = reply
object = domain
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
Response attributes
If the request is successful, the attributes associative array may include the following:
Parameter nameObligationDefinition/Value
details Returned if is_success = true A case-by-case 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 “Appendix C: Encoding Types for IDNS”.
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 data = ca_whois_display_setting
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">MODIFY</item> <item key="object">DOMAIN</item> <item key="domain">example.ca </item> <item key="attributes"> <dt_assoc> <item key="data">ca_whois_display_setting</item> <item key="display">FULL</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">DOMAIN</item> <item key="response_text">OK</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
For data = change_ips_tag
RequestResponse (success)Request (tag not found)
<?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">MODIFY</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="affect_domains">0</item> <item key="data">change_ips_tag</item> <item key="domain">example.me .uk</item> <item key="gaining_registrar_tag">q1q1</item> <item key="change_tag_all">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command successfully completed.</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">q1q1 Tag not found on the Nominet's list of valid tags.
Please contact the new Tag Holder to confirm.</item> <item key="action">REPLY</item> <item key="response_code">400</item> <item key="is_success">0</item> </dt_assoc> </data_block> </body> </OPS_envelope>
For data = cira_registrant
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">MODIFY</item> <item key="object">DOMAIN</item> <item key="domain">example.ca </item> <item key="attributes"> <dt_assoc> <item key="data">cira_registrant</item> <item key="first_name">Pierre</item> <item key="last_name">Lalonde</item> <item key="org_name">Example Inc.</item> <item key="address1">32 Oak St.</item> <item key="address2">Suite 100</item> <item key="address3" /> <item key="city">Toronto</item> <item key="state">ON</item> <item key="postal_code">M1M 1M1</item> <item key="country">CA</item> <item key="legal_type">CCT</item> <item key="email">[email protected]</item> <item key="phone">+1.4165551212x1234 </item> <item key="fax">+1.4165551024 </item> <item key="lang">FR</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">DOMAIN</item> <item key="response_text">OK</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
For data = contact_info
Example 1
In this example, only one type is specified and also_apply_to contains other types.
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">MODIFY</item> <item key="object">DOMAIN</item> <item key="domain">acmeinc.biz </item> <item key="attributes"> <dt_assoc> <item key="data">contact_info</item> <item key="affect_domains">0</item> <item key="contact_set"> <dt_assoc> <item key="also_apply_to"> <dt_array> <item key="0">owner</item> <item key="1">billing</item> </dt_array> </item> <item key="admin"> <dt_assoc> <item key="first_name">Adler</item> <item key="last_name">Adams</item> <item key="org_name">Example Inc.</item> <item key="address1">32 Oak St.</item> <item key="address2">Suite 100</item> <item key="address3" /> <item key="city">Santa Clara</item> <item key="state">CA</item> <item key="postal_code">90210</item> <item key="country">US</item> <item key="phone">+1.7075551212x1812 </item> <item key="fax">+1.7075553123 </item> <item key="email">[email protected]</item> <item key="url">http://www.example .com</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="action">REPLY</item> <item key="object">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Modification(s) successful</item> <item key="attributes"> <dt_assoc> <item key="details"> <dt_assoc> <item key="example.com "> <dt_assoc> <item key="response_text">Contact modification successful</item> <item key="response_code">200</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
In this example, admin and tech contact information is changed for a .CA domain.
📘Note:
For .CA domains when data = contact_info, instead of address1,
address2, and address3, you can specify these address attributes:
addr_office, addr_address_number, addr_street_name, addr_street_cat,
and addr_orientation.
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">MODIFY</item> <item key="object">DOMAIN</item> <item key="domain">example.ca </item> <item key="attributes"> <dt_assoc> <item key="affect_domains">0</item> <item key="contact_set"> <dt_assoc> <item key="admin"> <dt_assoc> <item key="org_name">Example Co.</item> <item key="first_name">Adler</item> <item key="last_name">Adams</item> <item key="ddress1">32 Oak Street</item> <item key="address2">Suite 100</item> <item key="address3" /> <item key="city">Saskatoon</item> <item key="state">SK</item> <item key="country">CA</item> <item key="postal_code">M1M1M1</item> <item key="phone">+1/4165551212</item> <item key="fax">+1.4165552222 </item> <item key="email">[email protected]</item> <item key="language">EN</item> </dt_assoc> </item> <item key="also_apply_to"> <dt_array> <item key="0">tech</item> </dt_array> </item> </dt_assoc> </item> <item key="report_email"></item> <item key="data">contact_info</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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Modification(s) successful</item> <item key="attributes"> <dt_assoc> <item key="details"> <dt_assoc> <item key="example.ca "> <dt_assoc> <item key="response_text">Contact modification successful</item> <item key="response_code">200</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 3
In this example, owner contact information is modified for a .IT domain.
The .IT owner contact requires three additional parameters: nationality_code, reg_code, and entity_type.
📘Note:
The other contact types do not require these additional parameters, so
if you change the owner contact information, and you use also_apply_to to
apply the changes to another type, for example, tech, the command will be
successful, but those additional parameters and values are ignored by the
other contact type.
However, also_apply_to billing is not supported for .IT
domains, and if you submit that value, the command will fail.
When the
domain owner is a person (entity_type = 1), changing the owner contact
information also changes the admin contact information as these are
considered to be the same at the Registry.
Request
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">MODIFY</item> <item key="attributes"> <dt_assoc> <item key="domain">example.it </item> <item key="data">contact_info</item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="entity_type">1</item> <item key="nationality_code">IT</item> <item key="first_name">John</item> <item key="last_name">Smith</item> <item key="org_name">Example</item> <item key="address1">Via del Campidoglio, 1</item> <item key="address2"></item> <item key="address3"></item> <item key="city">Rome</item> <item key="state">RM</item> <item key="country">IT</item> <item key="postal_code">00123</item> <item key="email">[email protected]</item> <item key="reg_code">SGLMRA80A01H501E</item> <item key="phone">+39.0612345678 </item> <item key="fax"></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="action">REPLY</item> <item key="object">DOMAIN</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="details"> <dt_assoc> <item key="example.it "> <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> </dt_assoc> </data_block> </body> </OPS_envelope>
For data = domain_auth_info
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">modify</item> <item key="object">domain</item> <item key="domain">acmeinc.biz </item> <item key="attributes"> <dt_assoc> <item key="affect_domains">0</item> <item key="domain_auth_info">mysecret</item> <item key="data">domain_auth_info</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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Domain auth code modification Successful</item> </dt_assoc> </data_block> </body> </OPS_envelope>
For data = expire_action
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">modify</item> <item key="object">domain</item> <item key="domain">acmeinc.biz </item> <item key="attributes"> <dt_assoc> <item key="affect_domains">0</item> <item key="auto_renew">0</item> <item key="let_expire">0</item> <item key="data">expire_action</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">DOMAIN</item> <item key="response_text">Update successful</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
For data = forwarding_email
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">modify</item> <item key="object">domain</item> <item key="domain">acmeinc.biz </item> <item key="attributes"> <dt_assoc> <item key="affect_domains">0</item> <item key="forwarding_email">[email protected]</item> <item key="data">forwarding_email</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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Domain forwarding email modification Successful</item> </dt_assoc> </data_block> </body> </OPS_envelope>
For data = it_whois_display_setting
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">MODIFY</item> <item key="attributes"> <dt_assoc> <item key="domain">ariacorporate.it </item> <item key="consent_for_publishing">N</item> <item key="data">it_whois_display_setting</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">OK</item> <item key="action">REPLY</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
For data = parkpage_state
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">MODIFY</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="affect_domains">0</item> <item key="state">on</item> <item key="data">parkpage_state</item> <item key="domain">example.com </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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Parked page successfully enabled for domain example.com </item> </dt_assoc> </data_block> </body> </OPS_envelope>
For data = rsp_whois_info
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">modify</item> <item key="object">domain</item> <item key="domain">acmeinc.biz </item> <item key="attributes"> <dt_assoc> <item key="affect_domains">0</item> <item key="flag">Y</item> <item key="all">1</item> <item key="data">rsp_whois_info</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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command Successfully Completed</item> </dt_assoc> </data_block> </body> </OPS_envelope>
For data = status
Note that the conditions for this succeeding are those for which a get domain status call would return a can_modify result of true (1).
Example 1
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">modify</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="affect_domains">0</item> <item key="lock_state">0</item> <item key="data">status</item> <item key="domain">example.com </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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Lock disabled for example.com </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
Without end-user credentials
Request
<?xml version="1.0 " encoding="UTF-8" standalone='yes'?> <!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">modify</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="lock_state">0</item> <item key="data">status</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">DOMAIN</item> <item key="response_text">Lock disabled for example.com </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
For data = whois_privacy_state
Example 1
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">modify</item> <item key="object">domain</item> <item key="domain">acmeinc.biz </item> <item key="attributes"> <dt_assoc> <item key="affect_domains">0</item> <item key="report_email" /> <item key="state">disable</item> <item key="data">whois_privacy_state</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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Whois Privacy successfully disabled</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
Without end-user credentials
Request
<?xml version="1.0 " encoding="UTF-8" standalone='yes'?> <OPS_envelope> <header> <version>0.9 </version> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">modify</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="state">enable</item> <item key="data">whois_privacy_state</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">DOMAIN</item> <item key="response_text">Whois Privacy successfully disabled</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
For data = whois_publicity_state
Example 1
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">modify</item> <item key="object">domain</item> <item key="domain">acmeinc.biz </item> <item key="attributes"> <dt_assoc> <item key="affect_domains">0</item> <item key="report_email" /> <item key="state">disable</item> <item key="data">whois_publicity_state</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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Whois Publicity successfully disabled</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
Without end-user credentials
Request
<?xml version="1.0 " encoding="UTF-8" standalone='yes'?> <OPS_envelope> <header> <version>0.9 </version> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">modify</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="state">enable</item> <item key="data">whois_publicity_state</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">DOMAIN</item> <item key="response_text">Whois Publicity successfully enabled</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
For tld_data = ced_info (.ASIA)
Example 1
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">modify</item> <item key="object">domain</item> <item key="domain">acmeinc.biz </item> <item key="attributes"> <dt_assoc> <item key="affect_domains">0</item> <item key="data">tld_data</item> <item key="tld_data"> <dt_assoc> <item key="ced_info"> <dt_assoc> <item key="contact_type">tech</item> <item key="legal_entity_type">other</item> <item key="legal_entity_type_info">add some text here</item> <item key="id_type">other</item> <item key="id_type_info">other</item> <item key="id_number">8675309</item> <item key="locality_city">Sydney</item> <item key="locality_state_prov">NSW</item> <item key="locality_country">AU</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="action">REPLY</item> <item key="object">DOMAIN</item> <item key="response_text">Data modification Successful</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
Without end-user credentials
Request
<?xml version="1.0 " encoding="UTF-8" standalone='yes'?> <!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">modify</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.asia </item> <item key="data">tld_data</item> <item key="tld_data"> <dt_assoc> <item key="ced_info"> <dt_assoc> <item key="contact_type">tech</item> <item key="id_number">8675309</item> <item key="id_type">passport</item> <item key="legal_entity_type">corporation</item> <item key="locality_city">Sydney</item> <item key="locality_state_prov">NSW</item> <item key="locality_country">AU</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="action">REPLY</item> <item key="object">DOMAIN</item> <item key="response_text">CED Data modification Successful</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope> </header>
For tld_data = ipr_data (.XXX)
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">modify</item> <item key="object">domain</item> <item key="cookie">364577922:3202133</item> <item key="attributes"> <dt_assoc> <item key='data'>tld_data</item> <item key='tld_data'> <dt_assoc> <item key='ipr_data'> <dt_assoc> <item key="icm_membership_id">123456</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope> <header>
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">DOMAIN</item> <item key="response_text">OK</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
For tld_data = it_registrant_info (.IT)
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">MODIFY</item> <item key="attributes"> <dt_assoc> <item key="domain">example.it </item> <item key="data">tld_data</item> <item key="tld_data"> <dt_assoc> <item key="it_registrant_info"> <dt_assoc> <item key="entity_type">1</item> <item key="reg_code">SGLMRA80A01H501E</item> <item key="nationality_code">it</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="action">REPLY</item> <item key="object">DOMAIN</item> <item key="is_success">1</item> <item key="response_text">Command completed successfully</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="details"> <dt_assoc> <item key="example.it "> <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> </dt_assoc> </data_block> </body> </OPS_envelope>
For tld_data = nexus (.US)
Example 1
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">modify</item> <item key="object">domain</item> <item key="domain">acmeinc.biz </item> <item key="attributes"> <dt_assoc> <item key="affect_domains">0</item> <item key="data">tld_data</item> <item key="tld_data"> <dt_assoc> <item key="nexus"> <dt_assoc> <item key="validator">CA</item> <item key="category">C31</item> <item key="app_purpose">P1</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="action">REPLY</item> <item key="object">DOMAIN</item> <item key="response_text">Nexus Data modification Successful</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
For tld_data =professional_data (.PRO)
Request
<?xml version='1.0 ' encoding='UTF-8'?> <OPS_envelope> <header> <version>0.9 </version> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">modify</item> <item key="object">domain</item> <item key="domain">acmeinc.biz </item> <item key="attributes"> <dt_assoc> <item key="data">tld_data</item> <item key="tld_data"> <dt_assoc> <item key="professional_data"> <dt_assoc> <item key="authority_website">http://www.cda -adc.ca </item> <item key="license_number">987654321</item> <item key="authority">Canadian Dental Association</item> <item key="profession">Dentist</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='action'>REPLY</item> <item key='object'>DOMAIN</item> <item key='response_text'>OK</item> <item key='response_code'>200</item> <item key='is_success'>1</item> </dt_assoc> </data_block> </body> </OPS_envelope
For tld_data = registrant_extra_info (.COOP)
Request
<?xml version='1.0 ' encoding='UTF-8'?> <!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">modify</item> <item key="object">domain</item> <item key="domain">acmeinc.biz </item> <item key="attributes"> <dt_assoc> <item key="data">tld_data</item> <item key="tld_data"> <dt_assoc> <item key="professional_data"> <dt_assoc> <item key="authority_website">http://www.cda -adc.ca </item> <item key="license_number">987654321</item> <item key="authority">Canadian Dental Association</item> <item key="profession">Dentist</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="action">REPLY</item> <item key="object">DOMAIN</item> <item key="response_text">OK</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
For tld_data = registrant_extra_info (.JOBS)
Request
<?xml version='1.0 ' encoding='UTF-8'?> <OPS_envelope> <header> <version>0.9 </version> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">modify</item> <item key="object">domain</item> <item key="domain">acmeinc.biz </item> <item key="attributes"> <dt_assoc> <item key="data">tld_data</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="jobs_admin_type">Yes</item> <item key="jobs_website">http://www.example .com</item> <item key="jobs_association_member">Yes</item> <item key="jobs_title">HR Generalist</item> <item key="jobs_industry_type">Logistics Management</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'?> <!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">modify</item> <item key="object">domain</item> <item key="domain">acmeinc.biz </item> <item key="attributes"> <dt_assoc> <item key="data">tld_data</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="jobs_admin_type">Yes</item> <item key="jobs_website">http://www.example .com</item> <item key="jobs_association_member">Yes</item> <item key="jobs_title">HR Generalist</item> <item key="jobs_industry_type">Logistics Management</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
For tld_data = registrant_extra_info (.RU)
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">modify</item> <item key="object">domain</item> <item key="domain">acmeinc.biz </item> <item key="attributes"> <dt_assoc> <item key="data">tld_data</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="date_of_birth">1976-08-05</item> <item key="id_card_authority">Republic of Khakassia </item> <item key="id_card_issue_date">2001-01-01</item> <item key="id_card_number">987654321</item> <item key="registrant_type">individual</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="action">REPLY</item> <item key="object">DOMAIN</item> <item key="response_text">OK</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated almost 2 years ago
* * *
Table of Contents
Request parameters Request attributes
For data = ca_whois_display_setting
For data = change_ips_tag
For data = contact_info
For data = cira_registrant
For data = domain_auth_info
For data = expire_action
For data = forwarding_email
For data = it_whois_display_setting
For data = parkpage_state
For data = rsp_whois_info
For data = status
For data = whois_privacy_state
Response parameters Response attributes
Examples For data = ca_whois_display_setting
For data = change_ips_tag
For data = cira_registrant
For data = contact_info
For data = domain_auth_info
For data = expire_action
For data = forwarding_email
For data = it_whois_display_setting
For data = parkpage_state
For data = rsp_whois_info
For data = status
For data = whois_privacy_state
For data = whois_publicity_state
For tld_data = ced_info (.ASIA)
For tld_data = ipr_data (.XXX)
For tld_data = it_registrant_info (.IT)
For tld_data = nexus (.US)
For tld_data =professional_data (.PRO)
For tld_data = registrant_extra_info (.COOP)
For tld_data = registrant_extra_info (.JOBS)
For tld_data = registrant_extra_info (.RU)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
modify (nameserver)
Modifies a nameserver.
This command is not supported for .TEL domains.
Suggest Edits
📘Important:
This command will overwrite the existing nameserver entries.
If a nameserver has two IPs, one for IPv4 and one for IPv6, and you specify only one of these in the request, the other one will be removed from the registry.
Request parameters for modify (nameserver)
Standard parameters
action = modify
object = nameserver
registrant_ip = valid IP address of the registrant (optional)
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The relevant domain.
ipaddress Required if ipv6 is not submitted The IPv4 address of the nameserver.
You can specify ipaddress or ipv6, or both.
Note: This parameter is always required for .DE, even if ipv6 is submitted.
ipv6 Required if ipaddress is not submitted The IPv6 address of the nameserver.
You can specify ipaddress or ipv6, or both.
Note: This parameter is not supported for .CN.
name Required Fully qualified domain name of the nameserver.
The name key must always be present, and must be race-encoded.
new_name Optional.
This field is only required if you are changing the name.
The new, fully qualified domain name for The new, fully qualified domain name for the nameserver
Response parameters for modify (nameserver)
Standard parameters
action = reply
object = nameserver
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 modify (nameserver)
Example 1
This example changes the name of an IPv4 nameserver.
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">modify</item> <item key="object">nameserver</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="name">ns1.example .com</item> <item key="new_name">ns.boo .example.com </item> <item key="ipaddress">212.112 .123.11 </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">nameserver</item> <item key="response_text">Command successful</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
This example changes the name of an IPv6 nameserver.
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">modify</item> <item key="object">nameserver</item> <item key="domain">yourdomain.com </item> <item key="attributes"> <dt_assoc> <item key="name">ns1.example .com</item> <item key="new_name">ns.test .example.com </item> <item key="ipv6">2a00:1450:4008:c00:0:0:0:1</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">nameserver</item> <item key="response_text">Command successful</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for modify (nameserver)
Standard parameters
Attributes
Response parameters for modify (nameserver)
Examples for modify (nameserver)
Example 1
Example 2
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
modify subreseller
Modify a subreseller account.
Suggest Edits
Request parameters for modify subreseller
Standard parameters
action = modify
object = subreseller
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
allowed_tld_list Optional List of TLDs that the subeseller is allowed to sell.
ccp_enabled Required Indicates whether credit card payments are allowed for the subreseller.
N—No
Y—Yes
contact_set Required Subreseller’s contact information.
The admin contact for a subreseller is the Emergency Contact, which is not the same as a domain admin contact.
The following values are required for the subreseller admin contact: first_name, last_name, org_name, phone, and email.
For tech contact, you can include any of the fields explained in the contact_set section; however, you must include first_name, last_name, org_name, address1, city, phone, and email.
If country is Canada or U.S , you must also include the state and postal code parameters.
low_balance_email Required The email address to which notices are sent when the subreseller's account balance falls to a predefined level.
nameservers Optional List of default nameservers for the subreseller.
password Required Password for the subreseller account.
payment_email Optional The email address to which payment notices are sent.
pricing_plan Required The pricing plan assigned to the subreseller.
status Required Set the status of the account.
Allowed values are active, onhold, locked,
canceled, and paid_only.
storefront_rwi Optional Determines whether the subreseller sees the Storefront link in the RWI (and hence whether the subreseller can configure a Storefront).
N—Do not display the Storefront link; this is the default.
Y—Display the Store front link
system_status_email system_status_email The email address that will receive system status messages.
url Optional The web address of the account.
username Required Username for the new subreseller.
Response parameters for modify subreseller
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
Examples for modify subreseller
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'>MODIFY</item> <item key='object'>SUBRESELLER</item> <item key='attributes'> <dt_assoc> <item key='url'>testurlupdate.com </item> <item key='nameservers'> <dt_assoc> <item key='fqdn1'>ns1.systemdns .com</item> <item key='fqdn2'>ns2.systemdns .com</item> </dt_assoc> </item> <item key='payment_email'>[email protected]</item> <item key='pricing_plan'>silver</item> <item key='status'>cancelled</item> <item key='username'>sub1240929148892</item> <item key='contact_set'> <dt_assoc> <item key="admin"> <dt_assoc> <item key="email">[email protected]</item> <item key="phone">+1.4165551123x333 </item> <item key="phone2"></item> <item key="first_name">John</item> <item key="last_name">Doe</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="org_name">Sub Reseller Company Inc.</item> <item key="first_name">John</item> <item key="last_name">Doe</item> <item key="title">CEO</item> <item key="phone">+1.4165551122x333 </item> <item key="fax"></item> <item key="email">[email protected]</item> <item key="address1">55 Reseller Ave</item> <item key="address2">Suite 99</item> <item key="address3"></item> <item key="city">New York</item> <item key="state">NY</item> <item key="postal_code">70218</item> <item key="country">US</item> </dt_assoc> </item> </dt_assoc> </item> <item key='storefront_rwi'>Y</item> <item key='ccp_enabled'>Y</item> <item key='low_balance_email'>[email protected]</item> <item key='password'>test123</item> <item key='system_status_email'>[email protected]</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">SUBRESELLER</item> <item key="response_text">Reseller sub1240929148892 successfully modified</item> <item key="action">REPLY</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for modify subreseller
Standard parameters
Attributes
Response parameters for modify subreseller
Standard parameters
Examples for modify subreseller
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
modify (subuser)
Modifies a domain's sub-user data.
Suggest Edits
Request parameters for modify (subuser)
Standard parameters
action = modify
object = subuser
registrant_ip = valid IP address of the registrant (optional)
username = name of the user account
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The relevant domain.
sub_id Required The sub-user's ID.
sub_password Required Password for the sub-user.
sub_permission Required The sub_permission value is a bit-mask that indicates which portions of the domain information are changeable by the sub-user.
The bits are as follows:
1—Owner
2—Admin
4—Billing
8—Tech
16—Nameservers
32—Rsp_whois_info
sub_username Required Username for the sub-user.
Response parameters for modify (subuser)
Standard parameters
action = reply
object = subuser
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 modify (subuser)
Request
XML
<?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">modify</item> <item key="object">subuser</item> <item key="domain">yourdomain.com </item> <item key="username">aaaa</item> <item key="attributes"> <dt_assoc> <item key="sub_password">luda</item> <item key="sub_permission">4</item> <item key="sub_id">2532880</item> <item key="sub_username">subludak</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
XML
<?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">SUBUSER</item> <item key="response_text">Command Successful</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 1 month ago
* * *
Table of Contents
Request parameters for modify (subuser)
Standard parameters
Attributes
Response parameters for modify (subuser)
Standard parameters
Examples for modify (subuser)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
modify_messaging_language
Changes the default messaging language of a domain.
Notification messages sent to resellers will use this default language, unless an alternate language has been specified for a particular message.
Message-specific language preferences can be set in the RCP.
Suggest Edits
Response parameters for modify_messaging_language
Standard parameters
action = modify
object = domain
registrant_ip = valid IP address of the registrant (optional)
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
messaging_language Required The updated default messaging language for a domain.
Possible values are:
af-ZA (Afrikaans)
ar-AE (Arabic)
id-ID (Bahasa Indonesia)
bs-BA (Bosnian)
bg-BG (Bulgarian)
zh-CN (Chinese)
hr-HR (Croatian)
cs-CZ (Czech)
da-DK (Danish)
nl-NL (Dutch)
en-US (English)
fi-FI (Finnish)
fr-FR (French)
de-DE (German)
el-GR (Greek)
hi-IN (Hindi)
it-IT (Italian)
ja-JP (Japanese)
ko-KR (Korean)
lv-LV (Latvian)
lt-LT (Lithuanian)
ms-MY (Malay)
no-NO (Norwegian)
fa-AF (Persian)
pl-PL (Polish)
pt-BR (Portuguese)
ro-RO (Romanian)
ru-RU (Russian)
sr-RS (Serbian)
sk-SK (Slovak)
es-ES (Spanish)
sv-SE (Swedish)
th-TH (Thai)
tr-TR (Turkish)
vi-VN (Vietnamese)
Response parameters modify_messaging_language
Standard parameters
action = reply
object = domain
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
Examples for modify_messaging_language
When modifying the language after domain registration
Request
<?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">MODIFY_MESSAGING_LANGUAGE</item> <item key="object">DOMAIN</item> <item key="domain">supteam2.co .uk</item> <item key="attributes"> <dt_assoc> <item key="messaging_language">de-DE</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 successful</item> <item key="action">REPLY</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 2 years ago
* * *
Table of Contents
Response parameters for modify_messaging_language
Standard parameters
Attributes
Response parameters modify_messaging_language
Standard parameters
Attributes
Examples for modify_messaging_language
When modifying the language after domain registration
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
modify_trade_designated_agent
Grants or revokes permission for TUCOWS to act as the designated agent for the specified domain.
"Enabled" is the default status.
If this feature is disabled, the current registrant will be required to approve, via email, any contact changes that affect the first name, last name, organization name, or email address.
Suggest Edits
Request Parameters modify_trade_designated_agent
Standard parameters:
action = modify_trade_designated_agent
object = domain
protocol = XCP
Attributes
Parameters within the attributes associative array are described below.
ParameterObligationDefinition/Value
domain Required The domain to which the trade pertains.
enable Required Possible values are:
0 - Indicates that the registrant/owner will approve any and all contact owner changes for their domains via email.
TUCOWS will not act as a "designated agent"
1 - Indicates that the registrant agrees to all terms and conditions outlined in TUCOWS' service agreement), including that which states TUCOWS may act on behalf of the registrant as a "designated agent".
ip_address Optional The IP address of the registrant modifying the setting.
Response Parameters modify_trade_designated_agent
Standard parameters
action = reply
object = 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
Examples for modify_trade_designated_agent
<?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">MODIFY_TRADE_DESIGNATED_AGENT</item> <item key="attributes"> <dt_assoc> <item key="enable">1</item> <item key="domain">weruiofh89q34gh78943g4.com </item> <item key="ip_address">0.0 .0.0 </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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 successful: The designated agent setting has been enabled (by reseller (via API); Source domain: weruiofh89q34gh78943g4.com ; Supplied IP address: 0.0 .0.0 )</item> <item key="action">REPLY</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated almost 8 years ago
* * *
Table of Contents
Request Parameters modify_trade_designated_agent
Standard parameters:
Attributes
Response Parameters modify_trade_designated_agent
Standard parameters
Examples for modify_trade_designated_agent
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
modify_trade_lock_setting
A setting to indicate whether the 60-day trade lock will be applied after the next trade.
This setting will revert to “1" after every trade.
It will not prevent another change of registrant.
Please note that this is a setting to indicate whether the lock should be applied after the next trade.
You must successfully complete a trade for this setting to take effect.
Changing this setting will NOT disable the trade lock if the domain is already trade-locked.
Suggest Edits
Request Parameters for modify_trade_lock_setting
Standard parameters:
action = modify_trade_lock_setting
object = domain
protocol = XCP
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The domain for which the trade lock setting is being modified.
enable Required Possible values are:
0 - Indicates that the Current Registrant has explicitly opted out of applying the 60-day inter-registrar transfer lock for this domain name.
1 - Indicates that a 60-day inter-registrar transfer lock will be applied to the domain name after a successful completion of a Change of Registrant process.
This is the default setting as per the ICANN Transfer Policy.
ip_address Required The IP address of the Current Registrant at the time when they gave their explicit consent to opting out of the transfer lock.
Response Parameters for modify_trade_lock_setting
Standard parameters
action = reply
object = domain
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 modify_trade_lock_setting
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">modify_trade_lock_setting</item> <item key="attributes"> <dt_assoc> <item key="enable">1</item> <item key="domain">weruiofh89q34gh78943g4.com </item> <item key="ip_address">0.0 .0.0 </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 successful: The 60-day trade hold has been enabled (by reseller (via API); Supplied IP address: 0.0 .0.0 )</item> <item key="action">REPLY</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request Parameters for modify_trade_lock_setting
Standard parameters:
Attributes
Response Parameters for modify_trade_lock_setting
Standard parameters
Examples for modify_trade_lock_setting
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
name_suggest
Checks whether a specified name, word, or phrase is available for registration in gTLDs and ccTLDs, suggests other similar domain names for .COM, .NET, .ORG, .INFO, .BIZ, .US, and .MOBI domains, and checks whether they are available.
Reseller must be enabled for the specified TLDs.
Can also be used to search for domains owned by external domain suppliers.
Suggest Edits
Request parameters
Standard request parameters
action = name_suggest
object = domain
Request attributes
Parameters within the attributes associative array are described below:
ParameterObligationDefinition/Value
languages Optional Specify the languages in which to return suggestions for other similar names.
en—English
fr —French
de—German
it—Italian
es—Spanish
You can specify the languages in which you want to see name suggestions, for example, you can submit a name, word or phrase in Spanish and specify es to request suggestions in Spanish.
If you do not specify a language code, the system tries to determine the language used in the searchstring and returns suggestions in that language.
max_wait_time Optional Specify the number of seconds that the command can run, and return as many results as can be found in that time period.
You can specify a fraction of a second, as long as the value is at least 0.1 .
If the results cannot be determined for any of the lookup domains within the specified time, the returned status value is in_progress.
If all results cannot be returned for suggestion, premium, or personal names within the specified time period, no results are returned for that service; that is the command returns all results or no results for each of these services.
After the results obtained within the max_wait_time are returned, the command continues to run in the background, and you can resubmit the command with the search_key to see more results.
Note: If you do not include the max_wait_time parameter, the command takes as long as it needs to return complete results.
search_key Required Resumes the previously run name_suggest command if the command did not return complete results during the specified max_wait_time
searchstring Required The name, word, or phrase whose availability you want to check.
Note: The first level domain (for example, .COM) is not required.
service_override Optional Overrides default settings for lookup, suggestion, or premium.
For more information, see the Service_Override table below.
Note: service_override is not available for personal_names.
services Optional Specify the services for which you want to check availability.
lookup—Check availability.
suggestion—Request suggestions.
personal_names—Check the availability of the specified personal name, (firstname lastname).
premium—Include domains owned by external domain suppliers.
premium_brokered_transfer—Include domain names that may be purchased
from external suppliers that use a broker to complete the purchase process.
premium_make_offer—Include domain names that may be purchased from external suppliers where the buyer and seller negotiate the purchase price.
skip_registry_lookup Optional Specifies whether to query the applicable registries to find out if the lookup domain names are available for registration.
0—Query the registries; this is the default.
1—Do not query the registries.
Note: If you set this parameter to 1, the response is returned more quickly; however, the results do not indicate whether or not the lookup names are available.
You still have to check the availability of any names you are interested in, for example, by using the lookup (domain) command.
suggestion Optional Specify the TLDs to check for name suggestions; can also specify the number of suggestions to return.
Suggestions are only available for .COM, .NET, .ORG, .INFO, and .BIZ.
Allowed values may be the tlds array and the maximum parameter.
For more information, see the Lookup and Suggestion table below.
tlds Required The TLDs you want to check for domain name availability and suggestions.
Lookups are available for all gTLDs and ccTLDs.
Note: Some externally managed TLDs may not have a testing environment set up.
Suggestions are available for .COM, .NET, .ORG, .INFO, .BIZ, .US, and .MOBI.
Request parameters within the service_override associative array may include the following:
ParameterObligationDefinition/Value
lookup Optional Specify the TLDs to check for availability.
Lookups are available for all gTLDs and ccTLDs.
personal_names Optional Specify the TLDs to check for available personal names.
premium Optional Specify the TLDs to check for availability.
Premium domain name lookups are available for .COM, .NET, .ORG, .INFO, and .BIZ.
suggestion Optional Specify the TLDs to check for name suggestions;
can also specify the number of suggestions to return.
Suggestions are available for .COM, .NET, .ORG, .INFO, .BIZ, .US, and .MOBI.
Allowed values may be the tlds array and the maximum parameter.
For more information, see the Lookup and Suggestion table below.
Note: This parameter will only work in the live environment.
Request parameters within the lookup and suggestion associative arrays may include the following:
ParameterObligationDefinition/Value
maximum Optional The maximum number of domain name suggestions
to return.
Specify 1 to 100; 100 is the default.
price_max Optional; used only for Premium domains The maximum price of the Premium domains to return.
The value must be an integer, for example, 1150; decimal points are not allowed.
If this parameter is not submitted or if the value is
not acceptable, the default value of 5000 is used.
If this value is less than the price_min value, the default values for both price_min and price_max are used
price_min Optional; used only for Premium domains The minimum price of the Premium domains to return.
The value must be greater than zero, and must be an integer, for example, 250; decimal
points are not allowed.
If this parameter is not submitted or if the value is not acceptable, the default value of 50 is used.
If this value is greater than the price_max value, the default values for both price_min and price_max
are used.
tlds Required The TLDs you want to check for domain name availability and suggestions.
Lookups are available for all gTLDs and ccTLDs.
Suggestions are available for .COM, .NET, .ORG, .INFO, .BIZ, .US, and .MOBI.
Request parameters within the lookup associative arrays may include the following:
ParameterObligationDefinition/Value
no_cache_tlds Optional In order to obtain results quickly, the default for the lookup command is to check the local OpenSRS cache to determine domain name availability.
If you specify no_cache_tlds = 1, instead of checking the cache, the lookup command queries the applicable registries to determine domain name availability.
Note: Setting no_cache_tlds to 1 increases the
amount of time it takes to get results
* * *
Response parameters
Standard response parameters
action = reply
object = domain
is_success = Boolean 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.
Response attributes
If the request is successful, the attributes associative array may include the following:
ParameterObligationDefinition/Value
has_claim Returned for the new TLDs during the claims period
(90 days from the start of GA) Indicates whether the domain name has a matching mark registered at the Trademark Clearinghouse (TMCH).
0—No matching marks exist at the TMCH.
1—A mark is registered at the TMCH that matches the domain name.
is_search_completed Returned if:
is_success = true Indicates whether all results were returned within the specified max_wait_time.
0—Search results are not complete.
Note: The command continues to run in the background, and you can resubmit the command with the search_key to see more results.
1—Search completed.
lookup Optional The results returned for lookup.
Values may be the count parameter and items associative array.
For more information, see the Premium, Personal_Names, Lookup, and Suggestion table below.
personal_names Optional The results returned for personal_names.
Values may be the count parameter and the items associative array.
For more information, see the Premium, Personal_Names, Lookup, and Suggestion table below.
premium Optional The results returned for premium.
Values may be the count parameter and the items associative array.
For more information, see the Premium, Personal_Names, Lookup, and Suggestion table below.
premium_brokered_transfer Optional The results returned for premium_brokered_transfer.
Values may be the count parameter and the items associative array.
For more information, see the Premium, Personal_Names, Lookup, and Suggestion table below.
premium_make_offer Optional The results returned for premium_make_offer.
Values may be the count parameter and the items associative array.
For more information, see the Premium, Personal_Names, Lookup, and Suggestion table below.
reason Returned if the domain queried is a registry premium domain.
Indicates that the domain is registry premium.
Value, if returned:
Premium Name
search_key Returned if is_success = true and is_search_completed = 0 A key that is returned if the name_suggest command did not return complete results during the specified max_wait_time.
The command continues to run in the background, and you can resubmit the command with the search_key to see more results.
suggestion Optional The results returned for suggestion.
Values may be the count parameter and the items associative array.
For more information, see the Premium, Personal_Names, Lookup, and Suggestion table below.
Note: This parameter will only work in the live environment.
Registry Premium Domain
ParameterObligationDefinition/Value
reason Returned if the domain queried is a registry premium domain.
Indicates that the domain is registry premium.
Value, if returned:
Premium Name
Parameters within the premium, lookup, and suggestion associative arrays are described below:
ParameterObligationDefinition/Value
count Always returned The number of results returned for lookup, suggestion, or premium.
items Always returned List of domain names and their statuses.
Allowed values are domain and status.
Parameters within the items associative array are described below:
ParameterObligationDefinition/Value
domain Always returned Returned domain name.
price Optional The purchase price for the premium domain.
status Always returned Indicates whether the returned domain names are available and can be registered.
Allowed values are:
available—Domain name is available and can be registered.
justsold—Domain name has been sold and is not available.
taken—Domain name is not available.
undetermined—Returned if skip_registry_lookup = 1 in the request, or if the registry could not be contacted.
in_progress—The command could not determine the status of the domain name in the allowed time.
The command continues to run in the background, and you can resubmit the command with the search_key to see more results.
third_party_offer_url Returned for:
premium_make_offer domains The URL of the vendor that is facilitating the negotiations between buyer and seller for the Make Offer Premium domain.
* * *
Examples
📘Note:
Due to the length of the responses in these examples, in some cases,
the results have been truncated by using ellipses (...) to represent omitted
results.
Example 1
For lookup, suggestion, premium, and personal names with suggestion limited to .COM, .NET, and .ORG, in English, German, Italian, and Spanish.
Request
XML
<?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'>name_suggest</item> <item key='object'>domain</item> <item key='attributes'> <dt_assoc> <item key='services'> <dt_array> <item key='0'>lookup</item> <item key='1'>suggestion</item> <item key='2'>premium</item> <item key='3'>personal_names</item> </dt_array> </item> <item key='searchstring'>search string</item> <item key='languages'> <dt_array> <item key='0'>en</item> <item key='1'>de</item> <item key='2'>it</item> <item key='3'>es</item> </dt_array> </item> <item key='tlds'> <dt_array> <item key='0'>.com</item> <item key='1'>.net</item> <item key='2'>.org</item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
XML
<?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="response_text">Command completed successfully</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="lookup"> <dt_assoc> <item key="count">6</item> <item key="response_text">Command completed successfully.</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">searchstring.com </item> <item key="status">taken</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">searchstring.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">searchstring.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="3"> <dt_assoc> <item key="domain">search-string.com </item> <item key="status">available</item> </dt_assoc> </item> ...
</dt_array> </item> </dt_assoc> </item> <item key="personal_names"> <dt_assoc> <item key="count">6</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">search.stringham .com</item> <item key="status">available</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">search.stringhini .com</item> <item key="status">available</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">search.stringfield .com</item> <item key="status">available</item> </dt_assoc> </item> <item key="3"> <dt_assoc> <item key="domain">search.stringer .net</item> <item key="status">available</item> </dt_assoc> </item> ...
</dt_array> </item> </dt_assoc> </item> <item key="premium"> <dt_assoc> <item key="count">20</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">badmintonstring.com </item> <item key="status">available</item> <item key="price">1349.00 </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">cheapstring.com </item> <item key="status">available</item> <item key="price">1549.00 </item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">elasticstring.com </item> <item key="status">available</item> <item key="price">1399.00 </item> </dt_assoc> </item> <item key="3"> <dt_assoc> <item key="domain">findcordblood.com </item> <item key="status">available</item> <item key="price">1688.00 </item> </dt_assoc> </item> ...
</dt_array> </item> </dt_assoc> </item> <item key="suggestion"> <dt_assoc> <item key="count">50</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">amazonsearchstring.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">archivesearchstring.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">briefsearchstring.com </item> <item key="status">available</item> </dt_assoc> </item> ...
<item key="49"><dt_assoc><item key="domain">search-string.org </item><item key="status">available</item></dt_assoc></item></dt_array> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
For both lookup and suggestion with lookups limited to .COM and .INFO, querying the registry (not OpenSRS cache) for .COM lookups, suggestions limited to .COM and .ORG, and maximum 25 suggestions returned.
Request
XML
<?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">name_suggest</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="searchstring">[email protected]</item> <item key="service_override"> <dt_assoc> <item key="suggestion"> <dt_assoc> <item key="tlds"> <dt_array> <item key="0">.com</item> <item key="1">.org</item> </dt_array> </item> <item key="maximum">25</item> </dt_assoc> </item> <item key="lookup"> <dt_assoc> <item key="tlds"> <dt_array> <item key="0">.com</item> <item key="1">.info</item> </dt_array> </item> <item key = "no_cache_tlds"> <dt_array> <item key="0">.com</item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </item> <item key="services"> <dt_array> <item key="0">lookup</item> <item key="1">suggestion</item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
XML
<?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="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="lookup"> <dt_assoc> <item key="count">8</item> <item key="response_text" /> <item key="response_code">0</item> <item key="is_success">1</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">example- search.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">example- search.info </item> <item key="status">available</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">example.com </item> <item key="status">taken</item> </dt_assoc> </item> ...
</dt_array> </item> </dt_assoc> </item> <item key="suggestion"> <dt_assoc> <item key="count">25</item> <item key="response_text" /> <item key="response_code">0</item> <item key="is_success">1</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">modelhunt.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">modelfind.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">problemfind.org </item> <item key="status">available</item> </dt_assoc> </item> ...
</dt_array> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 3
For premium domains, limited to .COM and .NET.
Request
XML
<?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'>name_suggest</item> <item key='object'>domain</item> <item key='attributes'> <dt_assoc> <item key='searchstring'>abc&d !</item> <item key='service_override'> <dt_assoc> <item key='premium'> <dt_assoc> <item key='tlds'> <dt_array> <item key='0'>.com</item> <item key='1'>.net</item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </item> <item key='services'> <dt_array> <item key='0'>premium</item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
XML
<?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="is_success">1</item> <item key="response_text">Command completed successfully</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="premium"> <dt_assoc> <item key="count">4</item> <item key="response_text"/> <item key="response_code">0</item> <item key="is_success">1</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">abc-and-d.com </item> <item key="status">available</item> <item key="price">299.98 </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">abcandd.com </item> <item key="status">available</item> <item key="price">499.98 </item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">abcandd.net </item> <item key="status">available</item> <item key="price">99.78 </item> </dt_assoc> </item> <item key="3"> <dt_assoc> <item key="domain">abcd.com </item> <item key="status">available</item> <item key="price">1523.45 </item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 4
For premium, lookup, and suggestion, limited to .COM, maximum 10 suggestions returned.
Request
XML
<?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">name_suggest</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="service_override"> <dt_assoc> <item key="premium"> <dt_assoc> <item key="tlds"> <dt_array> <item key="0">.com</item> </dt_array> </item> </dt_assoc> </item> <item key="suggestion"> <dt_assoc> <item key="tlds"> <dt_array> <item key="0">.com</item> </dt_array> </item> <item key="maximum">10</item> </dt_assoc> </item> <item key="lookup"> <dt_assoc> <item key="tlds"> <dt_array> <item key="0">.com</item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </item> <item key="services"> <dt_array> <item key="0">lookup</item> <item key="1">suggestion</item> <item key="2">premium</item> </dt_array> </item> <item key="searchstring">abc&d</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
XML
<?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="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="lookup"> <dt_assoc> <item key="count">2</item> <item key="response_text"/> <item key="response_code">0</item> <item key="is_success">1</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">abc-d.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">abcd.com </item> <item key="status">taken</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> <item key="premium"> <dt_assoc> <item key="count">3</item> <item key="response_text"/> <item key="response_code">0</item> <item key="is_success">1</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">abc-and-d.com </item> <item key="status">available</item> <item key="price">299.98 </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">abcandd.com </item> <item key="status">available</item> <item key="price">499.98 </item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">abcd.com </item> <item key="status">available</item> <item key="price">1523.45 </item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> <item key="suggestion"> <dt_assoc> <item key="count">10</item> <item key="response_text"/> <item key="response_code">0</item> <item key="is_success">1</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">abcdlive.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">abcdpro.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">abcdslive.com </item> <item key="status">available</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 5
For lookup and suggestion, limited to .COM, not checking the availability of the lookup domain, maximum 10 suggestions returned.
Request
XML
<?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">name_suggest</item> <item key="object">domain</item> <item key="attributes"> <item key="services"> <dt_array> <item key="0">lookup</item> <item key="1">suggestion</item> </dt_array> </item> <dt_assoc> <item key="searchstring">smith</item> <item key="skip_registry_lookup">1</item> <item key="service_override"> <dt_assoc> <item key="suggestion"> <dt_assoc> <item key="tlds"> <dt_array> <item key="0">.com</item> </dt_array> </item> <item key="maximum">10</item> </dt_assoc> </item> <item key="lookup"> <dt_assoc> <item key="tlds"> <dt_array> <item key="0">.com</item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
XML
<?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="response_code">200</item> <item key="is_success">1</item> <item key="request_response_time">0.169 </item> <item key="response_text">Command completed successfully</item> <item key="is_search_completed">1</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="lookup"> <dt_assoc> <item key="count">1</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">smith.com </item> <item key="status">undetermined</item> </dt_assoc> </item> </dt_array> </item> <item key="is_success">1</item> </dt_assoc> </item> <item key="suggestion"> <dt_assoc> <item key="count">10</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">myjosephsmith.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">josephsmithonline.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">mysmithonline.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="3"> <dt_assoc> <item key="domain">mystevesmith.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="4"> <dt_assoc> <item key="domain">thefortsmith.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="5"> <dt_assoc> <item key="domain">my-smith.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="6"> <dt_assoc> <item key="domain">myfortsmithonline.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="7"> <dt_assoc> <item key="domain">mymikesmith.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="8"> <dt_assoc> <item key="domain">thejosephsmith.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="9"> <dt_assoc> <item key="domain">fortsmithgroup.com </item> <item key="status">available</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 6
For lookup, suggestion, premium, and personal names with suggestion limited to .COM, .NET, .ORG, and .IN, in English, German, Italian, and Spanish, with the command run time limited to 0.4 seconds.
Request
XML
<?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">name_suggest</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="searchstring">search string</item> <item key="max_wait_time">0.4 </item> <item key="languages"> <dt_array> <item key="0">en</item> <item key="1">de</item> <item key="2">it</item> <item key="3">es</item> </dt_array> </item> <item key="tlds"> <dt_array> <item key="0">.com</item> <item key="1">.net</item> <item key="2">.org</item> <item key="3">.in</item> </dt_array> </item> <item key="services"> <dt_array> <item key="0">lookup</item> <item key="1">suggestion</item> <item key="2">premium</item> <item key="3">personal_names</item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
The results were in the specified time; however, not all lookup results are complete.
Premium name results were returned but suggestion and personal names could not be returned in the specified time.
The returned unique_key
allows you to resubmit the command.
XML
<?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="search_key">Ko1fN8Fnw1qaCuFE1tc1daCaT1E</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command completed successfully</item> <item key="is_search_completed">0</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="lookup"> <dt_assoc> <item key="count">8</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">searchstring.com </item> <item key="status">taken</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">searchstring.net </item> <item key="status">taken</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">searchstring.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="3"> <dt_assoc> <item key="domain">searchstring.in </item> <item key="status">available</item> </dt_assoc> </item> <item key="4"> <dt_assoc> <item key="domain">search-string.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="5"> <dt_assoc> <item key="domain">search-string.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="6"> <dt_assoc> <item key="domain">search-string.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="7"> <dt_assoc> <item key="domain">search-string.in </item> <item key="status">available</item> </dt_assoc> </item> </dt_array> </item> <item key="is_success">1</item> </dt_assoc> </item> <item key="personal_names"> <dt_assoc> <item key="count">5</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">search.stringham .com</item> <item key="status">available</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">search.stringhini .com</item> <item key="status">available</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">search.stringfield .com</item> <item key="status">available</item> </dt_assoc> </item> <item key="3"> <dt_assoc> <item key="domain">search.stringer .net</item> <item key="status">available</item> </dt_assoc> </item> <item key="4"> <dt_assoc> <item key="domain">search.stringfield .net</item> <item key="status">available</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> <item key="suggestion"> <dt_assoc> <item key="count">48</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">mysearchstring.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">mysearchstring.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">mysearchstring.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="3"> <dt_assoc> <item key="domain">searchstringonline.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="4"> <dt_assoc> <item key="domain">searchstringonline.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="5"> <dt_assoc> <item key="domain">thesearchstring.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="6"> <dt_assoc> <item key="domain">thesearchstring.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="7"> <dt_assoc> <item key="domain">thesearchstring.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="8"> <dt_assoc> <item key="domain">mysearchstringonline.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="9"> <dt_assoc> <item key="domain">mysearchstringonline.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="10"> <dt_assoc> <item key="domain">mysearchstringonline.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="11"> <dt_assoc> <item key="domain">searchstringgroup.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="12"> <dt_assoc> <item key="domain">my-searchstring.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="13"> <dt_assoc> <item key="domain">searchstringgroup.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="14"> <dt_assoc> <item key="domain">my-searchstring.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="15"> <dt_assoc> <item key="domain">searchstringgroup.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="16"> <dt_assoc> <item key="domain">my-searchstring.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="17"> <dt_assoc> <item key="domain">searchstring-online.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="18"> <dt_assoc> <item key="domain">bestsearchstring.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="19"> <dt_assoc> <item key="domain">searchstring-online.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="20"> <dt_assoc> <item key="domain">searchstring-online.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="21"> <dt_assoc> <item key="domain">bestsearchstring.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="22"> <dt_assoc> <item key="domain">bestsearchstring.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="23"> <dt_assoc> <item key="domain">thesearchstringonline.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="24"> <dt_assoc> <item key="domain">thesearchstringonline.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="25"> <dt_assoc> <item key="domain">thesearchstringonline.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="26"> <dt_assoc> <item key="domain">mysearchstringgroup.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="27"> <dt_assoc> <item key="domain">the-searchstring.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="28"> <dt_assoc> <item key="domain">mysearchstringgroup.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="29"> <dt_assoc> <item key="domain">the-searchstring.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="30"> <dt_assoc> <item key="domain">mysearchstringgroup.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="31"> <dt_assoc> <item key="domain">searchstringshop.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="32"> <dt_assoc> <item key="domain">the-searchstring.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="33"> <dt_assoc> <item key="domain">my-searchstring-online.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="34"> <dt_assoc> <item key="domain">topsearchstring.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="35"> <dt_assoc> <item key="domain">searchstringshop.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="36"> <dt_assoc> <item key="domain">my-searchstring-online.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="37"> <dt_assoc> <item key="domain">searchstringshop.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="38"> <dt_assoc> <item key="domain">my-searchstring-online.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="39"> <dt_assoc> <item key="domain">searchstring-group.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="40"> <dt_assoc> <item key="domain">topsearchstring.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="41"> <dt_assoc> <item key="domain">topsearchstring.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="42"> <dt_assoc> <item key="domain">bestsearchstringonline.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="43"> <dt_assoc> <item key="domain">searchstring-group.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="44"> <dt_assoc> <item key="domain">searchstring-group.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="45"> <dt_assoc> <item key="domain">bestsearchstringonline.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="46"> <dt_assoc> <item key="domain">bestsearchstringonline.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="47"> <dt_assoc> <item key="domain">thesearchstringgroup.com </item> <item key="status">available</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 7
Resubmits the previously run name_suggest command which did not return
complete lookup results during the specified max_wait_time.
The command
can run for a maximum of 0.7 seconds.
Request
XML
<?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">name_suggest</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="search_key">vgL2FeBzZ8JuS5lIluIEYhDc7Vg</item> <item key="max_wait_time">0.7 </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
Complete results for lookup are returned as well as results for suggestion, premium, and personal names.
XML
<?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">REPLY</item> <item key="response_text">Command completed successfully</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="is_search_completed">1</item> <item key="attributes"> <dt_assoc> <item key="lookup"> <dt_assoc> <item key="count">84</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">searchstring.com </item> <item key="status">taken</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">searchstring.net </item> <item key="status">available</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">searchstring.org </item> <item key="status">available</item> </dt_assoc> </item> <item key="3"> <dt_assoc> <item key="domain">searchstring.in </item> <item key="status">undetermined</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> <item key="premium"> <dt_assoc> <item key="count">20</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">badmintonstring.com </item> <item key="status">available</item> <item key="price">1349.00 </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">cheapstring.com </item> <item key="status">available</item> <item key="price">1549.00 </item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">elasticstring.com </item> <item key="status">available</item> <item key="price">13998.00 </item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> <item key="personal_names"> <dt_assoc> <item key="count">6</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">search.stringham .com</item> <item key="status">available</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">search.stringhini .com</item> <item key="status">available</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">search.stringfield .com</item> <item key="status">available</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> <item key="suggestion"> <dt_assoc> <item key="count">50</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">amazonsearchstring.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">archivesearchstring.com </item> <item key="status">available</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">briefsearchstring.com </item> <item key="status">available</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 8
For premium domains, limited to .COM and .NET names that cost between $100 and $10000, maximum 10 suggestions returned.
Request
XML
<?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="action">name_suggest</item> <item key="object">domain</item> <item key="protocol">XCP</item> <item key="attributes"> <dt_assoc> <item key="service_override"> <dt_assoc> <item key="premium"> <dt_assoc> <item key="tlds"> <dt_array> <item key="0">.com</item> <item key="1">.net</item> </dt_array> </item> <item key="maximum">10</item> <item key="price_min">100</item> <item key="price_max">10000</item> </dt_assoc> </item> </dt_assoc> </item> <item key="services"> <dt_array> <item key="0">premium</item> </dt_array> </item> <item key="searchstring">computerstore</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
XML
<?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="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command completed successfully</item> <item key="is_search_completed">1</item> <item key="attributes"> <dt_assoc> <item key="premium"> <dt_assoc> <item key="count">2</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">childhoodneglect.com </item> <item key="status">available</item> <item key="price">499.00 </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">child-neglect.com </item> <item key="status">available</item> <item key="price">499.00 </item> </dt_assoc> </item> </dt_array> </item> <item key="is_success">1</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 9
Lookup for one of the new TLDs.
Request
XML
<?xml version='1.0 ' encoding='UTF-8'?> <OPS_envelope> <header> <version>0.9 </version> <msg_type>standard</msg_type> </header> <body> <data_block> <dt_assoc> <item key="action">name_suggest</item> <item key="object">domain</item> <item key="protocol">XCP</item> <item key="attributes"> <dt_assoc> <item key="services"> <dt_array> <item key="0">lookup</item> </dt_array> </item> <item key="searchstring">example</item> <item key="tlds"> <dt_array> <item key="0">guru</item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
XML
<?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="response_code">200</item> <item key="is_success">1</item> <item key="request_response_time">0.065 </item> <item key="response_text">Command completed successfully</item> <item key="is_search_completed">1</item> <item key="attributes"> <dt_assoc> <item key="lookup"> <dt_assoc> <item key="count">1</item> <item key="response_text">Command completed successfully.</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">example.guru </item> <item key="status">available</item> <item key="has_claim">1</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 10
For premium, premium_brokered_transfer, and premium_make_offer domains, limited to .COM, .NET, .ORG, and .DE names.
Request
XML
<?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">NAME_SUGGEST</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="searchstring">testdomain</item> <item key="tlds"> <dt_array> <item key="0">.com</item> <item key="1">.net</item> <item key="2">.org</item> <item key="3">.de</item> </dt_array> </item> <item key="services"> <dt_array> <item key="0">premium</item> <item key="1">premium_make_offer</item> <item key="2">premium_brokered_transfer</item> <item key="3">lookup</item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
XML
<?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="response_code">200</item> <item key="is_success">1</item> <item key="request_response_time">1.791 </item> <item key="response_text">Command completed successfully</item> <item key="is_search_completed">1</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="lookup"> <dt_assoc> <item key="count">3</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">testdomain.net </item> <item key="status">taken</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">testdomain.org </item> <item key="status">taken</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">testdomain.de </item> <item key="status">taken</item> </dt_assoc> </item> </dt_array> </item> <item key="is_success">1</item> </dt_assoc> </item> <item key="premium_brokered_transfer"> <dt_assoc> <item key="count">3</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">testsname.com </item> <item key="status">available</item> <item key="price">343.00 </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">analysisdomains.com </item> <item key="status">available</item> <item key="price">341.00 </item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">testdomain123.com </item> <item key="status">available</item> <item key="price">5612.00 </item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> <item key="premium"> <dt_assoc> <item key="count">17</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">testdomain.com </item> <item key="status">available</item> <item key="price">5899.00 </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="domain">testdomainsearch.com </item> <item key="status">available</item> <item key="price">3045.00 </item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="domain">testdomainname.com </item> <item key="status">available</item> <item key="price">3395.00 </item> </dt_assoc> </item> <item key="3"> <dt_assoc> <item key="domain">testdomain01.com </item> <item key="status">available</item> <item key="price">4619.00 </item> </dt_assoc> </item> <item key="4"> <dt_assoc> <item key="domain">testdomain1.com </item> <item key="status">available</item> <item key="price">2695.00 </item> </dt_assoc> </item> <item key="5"> <dt_assoc> <item key="domain">testdomain020911c.com </item> <item key="status">available</item> <item key="price">299.00 </item> </dt_assoc> </item> <item key="6"> <dt_assoc> <item key="domain">testdomain3.com </item> <item key="status">available</item> <item key="price">2195.00 </item> </dt_assoc> </item> <item key="7"> <dt_assoc> <item key="domain">testmaxdomain.com </item> <item key="status">available</item> <item key="price">1495.00 </item> </dt_assoc> </item> <item key="8"> <dt_assoc> <item key="domain">testdomainsl.com </item> <item key="status">available</item> <item key="price">1077.00 </item> </dt_assoc> </item> <item key="9"> <dt_assoc> <item key="domain">shoemoneytestdomain.com </item> <item key="status">available</item> <item key="price">799.00 </item> </dt_assoc> </item> <item key="10"> <dt_assoc> <item key="domain">demodomains.com </item> <item key="status">available</item> <item key="price">5743.00 </item> </dt_assoc> </item> <item key="11"> <dt_assoc> <item key="domain">analysisdomain.com </item> <item key="status">available</item> <item key="price">2639.00 </item> </dt_assoc> </item> <item key="12"> <dt_assoc> <item key="domain">testdomain1.com </item> <item key="status">available</item> <item key="price">3099.00 </item> </dt_assoc> </item> <item key="13"> <dt_assoc> <item key="domain">testnewdomain.com </item> <item key="status">available</item> <item key="price">2179.00 </item> </dt_assoc> </item> <item key="14"> <dt_assoc> <item key="domain">thetestdomain.com </item> <item key="status">available</item> <item key="price">4736.00 </item> </dt_assoc> </item> <item key="15"> <dt_assoc> <item key="domain">domainfortest.com </item> <item key="status">available</item> <item key="price">2524.00 </item> </dt_assoc> </item> <item key="16"> <dt_assoc> <item key="domain">testyourdomain.com </item> <item key="status">available</item> <item key="price">1949.00 </item> </dt_assoc> </item> </dt_array> </item> <item key="is_success">1</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 10: Registry Premium
📘
Please note: The response generated when querying a registry premium domain with name_suggest (domain) is dependent upon which registry premium domains the reseller has enabled.
An available registry premium domain will appear unavailable or "taken" if the reseller has not enabled the tier of registry premium domains into which the domain falls.
Request
XML
<?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">NAME_SUGGEST</item> <item key="attributes"> <dt_assoc> <item key="services"> <dt_array> <item key="0">lookup</item> </dt_array> </item> <item key="tlds"> <dt_array> <item key="0">.bike</item> </dt_array> </item> <item key="searchstring">ddd.bike </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
Example 1
This example shows the response generated if the reseller has enabled the tier of registry premium domains into which the domain falls.
XML
<?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="response_code">200</item> <item key="is_success">1</item> <item key="request_response_time">0.074 </item> <item key="response_text">Command completed successfully</item> <item key="is_search_completed">1</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="lookup"> <dt_assoc> <item key="count">1</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">sydney.space </item> <item key="status">available</item> <item key="reason">Premium Name</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
This example shows the response generated if the reseller has not enabled the tier of registry premium domains into which the domain falls.
XML
<?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="response_code">200</item> <item key="is_success">1</item> <item key="request_response_time">0.063 </item> <item key="response_text">Command completed successfully</item> <item key="is_search_completed">1</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="lookup"> <dt_assoc> <item key="count">1</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="items"> <dt_array> <item key="0"> <dt_assoc> <item key="domain">sydney.space </item> <item key="status">taken</item> <item key="reason">Premium Name</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated 11 months ago
* * *
Table of Contents
Request parameters
Request attributes
Response parameters Response attributes
Registry Premium Domain
Examples Example 1
Example 2
Example 3
Example 4
Example 5
Example 6
Example 7
Example 8
Example 9
Example 10
Example 10: Registry Premium
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
OpenSRS API Quick Start Guide
Suggest Edits
Follow These Three Easy Steps
Getting started should be simple and straightforward.
With this in mind, we've divided our Quick Start Guide into three easy steps and included code snippets for several of the major languages.
We hope this will assist you in connecting to the OpenSRS system and allow you to begin selling domain and SSL services.
Step 1.
Go to Reseller Control Panel, and click on Account Settings.
Under the gear icon, click on the API settings tab, and copy your API key.
Step 2.
(Required for the Live environment but not the test environment)
On the Account Settings page, scroll down to IP Access Rules and select the edit button.
Here, you can add the IP address from which you will send API calls.
Step 3.
Plugin your API key and reseller username into one of the following code snippets:
PythonPerlJavaPHPRuby
#!/usr/bin/python import requests import hashlib TEST_MODE = 1 connection_options = { 'live' : { # IP whitelisting required 'reseller_username': '<YOUR RESELLER USERNAME>', 'api_key':'<YOUR API KEY>', 'api_host_port': 'https://rr-n1-tor.opensrs .net:55443', }, 'test' : { # IP whitelisting not required 'reseller_username': '<YOUR RESELLER USERNAME>', 'api_key':'<YOUR API KEY>', 'api_host_port': 'https://horizon.opensrs .net:55443', } } if TEST_MODE == 1: connection_details = connection_options['test'] else: connection_details = connection_options['live'] xml = ''' <?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">LOOKUP</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">myfirstopensrsapitest.com </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope> ''' md5_obj = hashlib.md5 () md5_obj.update ((xml + connection_details['api_key']).encode()) signature = md5_obj.hexdigest () md5_obj = hashlib.md5 () md5_obj.update ((signature + connection_details['api_key']).encode()) signature = md5_obj.hexdigest () headers = { 'Content-Type':'text/xml', 'X-Username': connection_details['reseller_username'], 'X-Signature':signature, }; print("Request to {} as reseller {}:".format(connection_details['api_host_port'],connection_details['reseller_username'])) print(xml) r = requests.post (connection_details['api_host_port'], data = xml, headers=headers ) print("Response:") if r.status_code == requests.codes .ok: print(r.text ) else: print (r.status_code ) print (r.text )
#!/usr/bin/perl use strict; use warnings; use IO::Socket::SSL; use Digest::MD5 qw/md5_hex/; use LWP::UserAgent; use Data::Dumper; my $TEST_MODE = 1; # Will connect to OpenSRS's test environment my $connection_options = { 'live' => { # IP whitelisting required api_host_port => 'rr-n1-tor.opensrs .net:55443', api_key => '<YOUR API KEY>', reseller_username => '<YOUR RESELLER USERNAME>', }, 'test' => { # IP whitelisting not required api_host_port => 'horizon.opensrs .net:55443', api_key => '<YOUR API KEY>', reseller_username => '<YOUR RESELLER USERNAME>', }, }; my $connection_details; if ($TEST_MODE) { $connection_details = $connection_options->{'test'}; } else { $connection_details = $connection_options->{'live'}; } my $ua = new LWP::UserAgent; # Simple lookup command my $xml = <<DATA; <?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">LOOKUP</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">myfirstopensrsapitest.com </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope> DATA my $response = $ua->post( "https://$connection_details->{api_host_port}", 'Content-Type' => 'text/xml', 'X-Username' => $connection_details->{reseller_username}, 'X-Signature' => md5_hex( md5_hex( $xml, $connection_details->{api_key} ), $connection_details->{api_key} ), 'Content' => $xml ); print "Request to $connection_details->{api_host_port} as reseller: $connection_details->{reseller_username}\n$xml\n"; print "Response:\n"; if ( $response->is_success ) { print Dumper( $response->content ); } else { print Dumper($response); }
import java.util .HashMap; import java.io .*; import java.security .MessageDigest; import java.math .BigInteger; import java.net .HttpURLConnection; import java.net .URL; public class OpenSRSAPITest { public static void main (String[] args) { final boolean TEST_MODE = true; HashMap <String, String> liveDetails = new HashMap <String,String>(); liveDetails.put ("apiHostPort","https://rr-n1-tor.opensrs .net:55443"); liveDetails.put ("apiKey", "<YOUR_API_KEY>"); liveDetails.put ("resellerUsername", "<YOUR_RESELLER_USERNAME>"); HashMap <String, String> testDetails = new HashMap <String,String>(); testDetails.put ("apiHostPort", "https://horizon.opensrs .net:55443"); testDetails.put ("apiKey", "<YOUR_API_KEY>"); testDetails.put ("resellerUsername", "<YOUR_RESELLER_USERNAME>"); HashMap <String, String> connectionDetails; if (TEST_MODE) connectionDetails = testDetails; else connectionDetails = liveDetails; // Simple lookup command String xml = "<?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'>LOOKUP</item>" + "<item key='object'>DOMAIN</item>" + "<item key='attributes'>" + "<dt_assoc>" + "<item key='domain'>myfirstopensrsapitest.com </item>" + "</dt_assoc>" + "</item>" + "</dt_assoc>" + "</data_block>" + "</body>" + "</OPS_envelope>"; // Create signature String signature = md5_hex( md5_hex(xml + connectionDetails.get ("apiKey")) + connectionDetails.get ("apiKey")); System.out .println("Request as reseller: " + connectionDetails.get ("resellerUsername")); System.out .println(xml); // Make HTTP Post try { URL url = new URL(connectionDetails.get ("apiHostPort")); HttpURLConnection conn = (HttpURLConnection) url.openConnection (); conn.setDoOutput (true); conn.setRequestMethod ("POST"); conn.setRequestProperty ("Content-Type", "text/xml"); conn.setRequestProperty ("X-Username", connectionDetails.get ("resellerUsername")); conn.setRequestProperty ("X-Signature", signature); OutputStreamWriter writer = new OutputStreamWriter(conn.getOutputStream ()); writer.write (xml); writer.flush (); System.out .println("Response Code: " + conn.getResponseCode ()); System.out .println("Response Message: " + conn.getResponseMessage ()); System.out .println("Response XML:"); String line; BufferedReader reader = new BufferedReader(new InputStreamReader(conn.getInputStream ())); while ((line = reader.readLine ()) != null) { System.out .println(line); } writer.close (); reader.close (); } catch (Exception e) { e.printStackTrace (); } } private static String md5_hex(String s) { try { MessageDigest m = MessageDigest.getInstance ("MD5"); m.update (s.getBytes (), 0, s.length ()); BigInteger i = new BigInteger(1,m.digest ()); return String.format ("%1$032x", i); } catch (Exception e) { e.printStackTrace (); } return null; } }
<?php // Note: Requires cURL library $TEST_MODE = true; $connection_options = [ 'live' => [ 'api_host_port' => 'https://rr-n1-tor.opensrs .net:55443', 'api_key' => '<YOUR API KEY>', 'reseller_username' => '<YOUR RESELLER USERNAME>' ], 'test' => [ 'api_host_port' => 'https://horizon.opensrs .net:55443', 'api_key' => '<YOUR API KEY>', 'reseller_username' => '<YOUR RESELLER USERNAME>' ] ]; if ($TEST_MODE) { $connection_details = $connection_options['test']; } else { $connection_details = $connection_options['live']; } $xml = <<<EOD <?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">LOOKUP</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">myfirstopensrsapitest.com </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope> EOD; $data = [ 'Content-Type:text/xml', 'X-Username:' .
$connection_details['reseller_username'], 'X-Signature:' .
md5(md5($xml .
$connection_details['api_key']) .
$connection_details['api_key']), ]; $ch = curl_init($connection_details['api_host_port']); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HTTPHEADER, $data); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $xml); $response = curl_exec($ch); echo 'Request as reseller: ' .
$connection_details['reseller_username'] .
"\n" .
$xml .
"\n"; echo "Response\n"; echo $response .
"\n"; ?>
#!/usr/bin/ruby require 'uri' require 'net/http' require 'net/https' require 'digest' TEST_MODE = 1 connection_options = { 'live' => { # IP whitelisting required 'reseller_username' => '<YOUR RESELLER USERNAME>', 'api_key' => '<YOUR API KEY>', 'api_host_port' => 'https://rr-n1-tor.opensrs .net:55443', }, 'test' => { # IP whitelisting not required 'reseller_username' => '<YOUR RESELLER USERNAME>', 'api_key' => '<YOUR API KEY>', 'api_host_port' => 'https://horizon.opensrs .net:55443', } } if TEST_MODE == 1 connection_details = connection_options['test'] else connection_details = connection_options['live'] end xml = <<-eos <?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">LOOKUP</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">myfirstopensrsapitest.com </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope> eos md5 = Digest::MD5.new md5.update (xml + connection_details['api_key']) signature = md5.hexdigest md5 = Digest::MD5.new md5.update (signature + connection_details['api_key']) signature = md5.hexdigest uri = URI.parse ("#{connection_details['api_host_port']}/") https = Net::HTTP.new (uri.host ,uri.port ) https.use_ssl = true req = Net::HTTP::Post.new (uri.path , initheader = { 'Content-Type' =>'text/xml', 'X-Username' => connection_details['reseller_username'], 'X-Signature' => signature, }) req.body = xml puts "Request to #{connection_details['api_host_port']} as reseller #{connection_details['reseller_username']}:" res = https.request (req) puts xml puts "Response:" if res.code == "200" puts res.body else puts res.code puts res.message end
Updated about 2 years ago
* * *
Table of Contents
Follow These Three Easy Steps
Step 1.
Step 2.
Step 3.
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Order Event: claim_status_change
This event notification will be generated when there is an update on the claim status on an order.
Suggest Edits
Response Parameters for claim_status_change
If the request is successful, the attributes associative array may include the
following:
Parameter nameObligationDefinition/Value
claim_status Always returned.
The current status of the claim.
Possible values include:
* initiateddeclined cancelled accepted
Example Response for claim_status_change
<?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">EVENT</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="transaction_id">2014-06-19 13:35:54 8716 101</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="events"> <dt_array> <item key="0"> <dt_assoc> <item key="object_data"> <dt_assoc> <item key="domain_name">testandvalidate.claimsgathree </item> <item key="claim_status">initiated</item> <item key="order_id">442644</item> </dt_assoc> </item> <item key="object">ORDER</item> <item key="event_id">72a5d2b5ffe3fd892b39fffa292133f4</item> <item key="event">CLAIM_STATUS_CHANGE</item> <item key="event_date">2014-06-19T17:34:51Z</item> </dt_assoc> </item> </dt_array> </item> <item key="total">2</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 2 years ago
* * *
Table of Contents
Response Parameters for claim_status_change
Example Response for claim_status_change
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Order Event: message_status_change
Suggest Edits
Response Parameters for message_status_change (order event)
If the request is successful, the attributes associative array may include the
following:
Parameter nameObligationDefinition/Value
message_status Always returned The updated status of the message.
Possible values are:
Queued
Sent
* Bounced
message_type Always returned The type of message.
reference_id Always returned The unique message ID.
Example Response for message_status_change (order event)
<?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">EVENT</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="transaction_id">2016-12-02 15:24:56 10026 101</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="events"> <dt_array> <item key="0"> <dt_assoc> <item key="object_data"> <dt_assoc> <item key="domain_name">somedomain.com </item> <item key="message_type">enduser.icann .trade.new .registrant.approval </item> <item key="domain_id">310499</item> <item key="message_status">QUEUED</item> <item key="reference_id">7814e71bb27b751a33bd79555c08e7546b70ce9b4156cbdea8284864b01733cd104a36e1</item> <item key="to_address">[email protected]</item> </dt_assoc> </item> <item key="object">DOMAIN</item> <item key="event_id">d417c52e31e3ff537a034e982546b64f</item> <item key="event">MESSAGE_STATUS_CHANGE</item> <item key="event_date">2016-12-02T20:24:27Z</item> </dt_assoc> </item> </dt_array> </item> <item key="total">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 2 years ago
* * *
Table of Contents
Response Parameters for message_status_change (order event)
Example Response for message_status_change (order event)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Order Event: status_change
This event notification when the status of an order is updated.
Suggest Edits
Response Parameters for status_change (order)
If the request is successful, the attributes associative array may include the
following:
Parameter nameObligationDefinition/Value
order_reg_type Always returned.
The updated status of the order.
Possible values include:
* landrush new premium renewal sunrise transfer whois_privacy
order_status Always returned.
The status or the order.
Possible values include:
Processed - Applies to trades and transfers and means we are waiting on an owner or registry to take action.
Completed - All required actions have taken place and the order is successfully completed.
Pending - An order that has been explicitly saved by the reseller, or has failed validation and has been automatically saved.
General Availability pre-orders are also 'saved' in pending before they are automatically processed.
Please note that all domain orders start in a pending state regardless of whether they were saved.
Waiting - Order is asynchronous and is in progress.
A couple of examples where this would happen would be due to a waiting async GDPR consent request, or an asynchronous response received from the registry.
Pending_fax - is no longer in use.
The system will generally not automatically clear out pending orders.
There are a couple of scenarios where it will though:
If an order for a domain is submitted any orders saved in pending for the same domain will be canceled.
In the RWI there is the option to cancel pending/declined orders created more than X days ago.
This is also available via API via cancel_pending_orders call.)
Declined - Order was canceled after being submitted.
Some examples would be a registrant not accepting a claim notice, async GDPR notice, or transfer notice.
Canceled - Order has been canceled by reseller via API or RWI.
Pending/Declined order canceled by the system due to a duplicate order/taken domain.
Example Response for status_change
<?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">EVENT</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="transaction_id">2014-06-19 11:31:49 27660 101</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="events"> <dt_array> <item key="0"> <dt_assoc> <item key="object_data"> <dt_assoc> <item key="domain_name">tucows-13e97b6ef1b1c.com </item> <item key="order_status">pending</item> <item key="order_reg_type">new</item> <item key="order_id">701980</item> </dt_assoc> </item> <item key="object">ORDER</item> <item key="event_id">39232348265486a2ac352d349cd88a3f</item> <item key="event">STATUS_CHANGE</item> <item key="event_date">2014-06-19T15:31:47Z</item> </dt_assoc> </item> </dt_array> </item> <item key="total">6</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated almost 3 years ago
* * *
Table of Contents
Response Parameters for status_change (order)
Example Response for status_change
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Overview
Suggest Edits
The three-character language codes listed in the following table are the allowed values for the 'encoding_type' parameter, which is used to specify the language to use for an IDN.
LanguageLanguage code
Afrikaans AFR
Albanian-ALB ALB
Arabic ARA
Aragonese ARG
Armenian-ARM ARM
ASCII (blank, no language code)
Assamese ASM
Asturian; Bable AST
Avestan AVE
Awadhi AWA
Azerbaijani AZE
Balinese BAN
Baluchi BAL
Basa BAS
Bashkir BAK
Basque-BAQ BAQ
Belarusian BEL
Bengali BEN
Bhojpuri BHO
Bosnian BOS
Bulgarian BUL
Burmese-BUR BUR
Carib CAR
Catalan CAT
Chechen CHE
Chinese-CHI CHI
Chuvash CHV
Coptic COP
Corsican COS
Croatian-SCR SCR
Czech-CZE CZE
Danish DAN
Divehi DIV
Dogri DOI
Dutch-DUT; Flemish DUT
English ENG
Estonian EST
Faroese FAO
Fijian FIJ
Finnish FIN
French-FRE FRE
Frisian FRY
Gaelic; Scottish Gaelic GLA
Georgian-GEO GEO
German-GER GER
Greek-GRE, Modern (1453-) GRE
Gondi GON
Gujarati GUJ
Hebrew HEB
Hindi HIN
Hungarian HUN
Icelandic-ICE ICE
Indic (Other) INC
Indonesian IND
Ingush INH
Irish GLE
Italian ITA
Japanese JPN
Kashmiri KAS
Kazakh KAZ
Khmer KHM
Kirghiz KIR
Korean KOR
Kurdish KUR
Lao LAO
Latvian LAV
Lithuanian LIT
Luxembourgish; Letzeburgesch LTZ
Macedonian-MAC MAC
Malayalam MAL
Malay-MAY MAY
Maltese MLT
Maori-MAO MAO
Mixed (English) * ENG
Moldavian MOL
Mongolian MON
Nepali NEP
None specified NO
Norwegian NOR
Oriya ORI
Ossetian; Ossetic OSS
Panjabi PAN
Persian-PER PER
Polish POL
Portuguese POR
Pushto PUS
Rajasthani RAJ
Romanian-RUM RUM
Russian RUS
Samoan SMO
Sanskrit SAN
Sardinian SRD
Serbian-SCC SCC
Seychelles SCR
Simplified Chinese ZH-CN
Sindhi SND
Sinhalese SIN
Slovak-SLO SLO
Slovenian SLV
Somali SOM
Spanish; Castilian SPA
Swahili SWA
Swedish SWE
Tajik TGK
Tamil TAM
Telugu TEL
Thai THA
Tibetan-TIB TIB
Traditional Chinese ZH-TW
Turkish TUR
Ukrainian UKR
Urdu URD
Uzbek UZB
Vietnamese VIE
Welsh-WEL WEL
Yiddish YID
To view which encoding_types are supported, reference the 'IDNs available' column in our TLD reference chart.
Updated about 2 years ago
* * *
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
parse_csr
Parses the CSR and identifies its data elements.
Suggest Edits
Request parameters for parse_csr
Standard parameters
action = parse_csr
object = trust_service
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
csr Required A Certificate Signing Request for the required SSL Certificate.
Note: All certificates require 2048 bit CSRs; however, Symantec will accept 1024 bit CSRs for certificates with expiry dates prior to December 31,
2013, except for EV certs, which require 2048, regardless of the term.
product_type Required The product type from the SSL Certificate inventory.
Allowed values are:
comodo_ev
comodo_instantssl
comodo_premiumssl
comodo_premiumssl_wildcard
comodo_ssl
comodo_wildcard
essentialssl
essentialssl_wildcard
positivessl
quickssl
quickssl_premium
rapidssl
securesite
securesite_pro
securesite_ev
securesite_pro_ev
sgcsuper_certs
ssl123
sslwebserver
sslwebserver_wildcard
sslwebserver_ev
symantec_ssl_lite
symantec_ssl_lite_wildcard
truebizid
truebizid_wildcard
truebizid_ev
trustwave_dv
trustwave_ev
trustwave_premiumssl
trustwave_premiumssl_wildcard
Response parameters for parse_csr
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 nameObligationDefinition/Value
csr_data Returned if is_success = true A list of the data elements of the CSR.
For more information, see the csr_data table.
dv_auth_details
csr_data
Parameters within the csr_data associative array are described below.
Parameter nameObligationDefinition/Value
country Always returned The country specified in the CSR.
domain Always returned The domain specified in the CSR.
email Always returned The email address specified in the CSR.
has_bad_extensions Always returned Indicates whether the CSR contains any unsupported extensions.
Allowed values are:
0—The CSR can be used.
1— Re-generate the CSR without the unsupported extensions.
locality Always returned The city specified in the CSR.
organization Always returned The organization specified in the CSR
organization_unit Always returned The organization unit specified in the CSR.
state Always returned The state specified in the CSR.
valid_quick_domain Returned for QuickSSL Certificates only Indicates whether the CSR is valid for QuickSSL certificates.
Allowed values are:
0—No
1—Yes
valid_true_domain Returned for True BusinessID Certificates only Indicates whether the CSR is valid for True BusinessID certificates.
Allowed values:
0—No
1—Yes
Examples for parse_csr
Example 1
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">parse_csr</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="product_type">quickssl</item> <item key="csr">-----BEGIN CERTIFICATE REQUEST----- MIIBqTCCARICAQAwaTELMAkGA1UEBhMCQ0ExCzAJBgNVBAgTAm9uMRAwDgYDVQQH Ewd0b3JvbnRvMQ8wDQYDVQQKEwZ0dWNvd3MxCzAJBgNVBAsTAnFhMR0wGwYDVQQD ExR3d3cucWFyZWdyZXNzaW9uLm9yZzCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkC gYEAz+hbqqnE5BSW0THf7txxsJxF8Vtca2uL52iutI1SRTm9J6NNtAjgMbL9upOm SFnObpWKriUIlvxKrecygGWkjiMeyU/F6auAS9/vwDdxYEVT2szK+Q2At1FgU433 Pds53v2J/vyB6SL+k/w54H2gF4ORpU1hjUggo7fM353TeeMCAwEAAaAAMA0GCSqG SIb3DQEBBAUAA4GBAIYvVThVeocN7N7HbsO/au9AXnx6LULQ5LMDWx6FlyBB5g9h 5HYZa6xieYCYDxYIsjLjR3qx1BWl9+0kSL2MW4EdDPzbcrZvHAtrw2/hPrm9EGA3 2w3a26W79N3clCkrahnpcNFLFyzU3CtZASJ+VuixGXTEkdiBAliqtGp+QBhf -----END CERTIFICATE REQUEST-----</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="is_success">1</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="csr_data"> <dt_assoc> <item key="country">US</item> <item key="organization_unit">QA</item> <item key="valid_true_domain">1</item> <item key="state">CA</item> <item key="locality">Santa Clara</item> <item key="email" /> <item key="domain">www.example .com</item> <item key="valid_quick_domain">1</item> <item key="has_bad_extensions">0</item> <item key="organization">Example Inc.</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
For Comodo Domain-Vetted SSL Certificates
<?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">REPLY</item> <item key="object">TRUST_SERVICE</item> <item key="is_success">1</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="csr_data"> <dt_assoc> <item key="country">US</item> <item key="organization_unit">QA</item> <item key="valid_true_domain">1</item> <item key="state">CA</item> <item key="locality">Santa Clara</item> <item key="email" /> <item key="domain">www.example .com</item> <item key="valid_quick_domain">1</item> <item key="has_bad_extensions">0</item> <item key="organization">Example Inc.</item> </dt_assoc> </item> <item key="dv_auth_details"> <dt_assoc> <item key="file_name">CCA14620B14A3A0A2BBBCDAEBB9B4402.txt </item> <item key="file_contents">6009865A908659B5A40E802BBBFB3DD71FE49A15 comodoca.com </item> <item key="dns_entry">CCA14620B14A3A0A2BBBCDAEBB9B4402.qaregression .org CNAME 6009865A908659B5A40E802BBBFB3DD71FE49A15.comodoca .com</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated almost 8 years ago
* * *
Table of Contents
Request parameters for parse_csr
Standard parameters
Attributes
Response parameters for parse_csr
Standard parameters
Attributes
Examples for parse_csr
Example 1
Example 2
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
pay subreseller
Transfers funds from the reseller account into a subreseller account.
Suggest Edits
Request parameters for pay subreseller
Standard parameters
action = pay
object = subreseller
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
amount Required The amount that you want to transfer to the subreseller account; this value must be a positive number.
username Required The username of the subreseller that is receiving the funds.
Response parameters for pay subreseller
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 nameObligationDefinition/Value
id Returned if is_success = true The ID number of the transaction.
Examples for pay subreseller
RequestResponse
<?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">PAY</item> <item key="object">SUBRESELLER</item> <item key="attributes"> <dt_assoc> <item key="amount">1.00 </item> <item key="username">subtest</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">SUBRESELLER</item> <item key="response_text">Funds Transferred</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="id">3627217</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 3 years ago
* * *
Table of Contents
Request parameters for pay subreseller
Standard parameters
Attributes
Response parameters for pay subreseller
Standard parameters
Attributes
Examples for pay subreseller
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
poll_event
Sends a request for a list of the most recent event transactions.
A maximum of 100 events can be queried at a time, and all will be listed in chronological order, starting with the earliest event.
Suggest Edits
Request Parameters for poll_event
Standard Parameters
action = poll
object = event
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
limit Optional A numeric value which determines how many event transactions will be listed in the response.
Events will be listed in chronological order, starting with the earliest event.
Max value: 100
Notes:
If not limit value is indicated, the default value is 1.
Example Request for poll_event
<?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">EVENT</item> <item key="action">POLL</item> <item key="attributes"> <dt_assoc> <item key="limit">100</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example Response for poll_event
<?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">EVENT</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="transaction_id">2014-05-29 11:14:02 23004 101</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="events"> <dt_array> <item key="0"> <dt_assoc> <item key="object_data"> <dt_assoc> <item key="domain_name">abc-fictional.de </item> <item key="domain_id">801743</item> <item key="zone_check_status">invalid</item> </dt_assoc> </item> <item key="object">DOMAIN</item> <item key="event_id">6887c7d3838dcaec7517c531df527bb7</item> <item key="event">ZONE_CHECK_STATUS_CHANGE</item> <item key="event_date">2014-05-27T19:29:25Z</item> </dt_assoc> </item> </dt_array> </item> <item key="total">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated almost 6 years ago
* * *
Table of Contents
Request Parameters for poll_event
Standard Parameters
Attributes
Example Request for poll_event
Example Response for poll_event
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
process_pending
Processes or cancels pending orders; also applicable to any order that is declined.
The order is cancelled and a new order is created.
Can also be used to process cancelled domain orders, provided the cancelled order was a new order or a transfer.
Suggest Edits
Request parameters for process_pending
Standard parameters
action = process_pending
object = domain or trust_service attributes
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
approver_email Required Approver email only needed when dv_auth method is set to email
dv_auth_method Required Preferred authorization method for domain-vetted certificates.
Possible values include:
DNS
File
Note: The default value is Email, if preferred method is not set.
command Optional Only necessary if you want to cancel the pending order.
If you want to process the pending order, do not add this attribute.
Allowed value is cancel.
fax_received Optional Only required for .DE orders that are pending a confirmation fax.
0—No
1—Yes
order_id Required The ID of the order to be processed.
owner_address Optional Owner's email address; only used for .DE transfers.
Response parameters for process_pending
Standard parameters action = reply
object = domain
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
Attributes
If the request is successful, the attributes associative array may include the
following:
Parameter nameObligationDefinition/Value
async_reason Included in domain response for asynchronous requests Indicates the reason that the request was asynchronous.
Allowed values are:
general—Order was submitted to an asynchronous registry.
has_claim—Registrant action required before order can complete.
domain Included in SSL Service response if is_success = true The domain with which the SSL Service order is associated.
dv_auth_details optional Displays the contents of the domain validation entry required for proper validation.
If DNS was set as the preferred method, the DNS entry content will be returned.
If file is the method selected, the file name and file contents will be returned.
Note: If email was set as the preferred method, no value will be returned.
dv_auth_method Included if the dv authorization method is DNS or File
Note: If the authorization method selected is email, no value for dv_auth_method will be returned.
The authorization method selected.
f_auto_renew Included in domain response if is_success = true Flag indicating whether domain is automatically renewed.
Allowed values are Y or N.
id Included in domain response if is_success = true The ID of the domain
order_id Included in SSL Service response if is_success = true The ID of the order.
registration expiration date Included in domain response if is_success = true The new expiration date for the service, in the format YYYY-MM-DD hh:mm:ss
state Included in SSL Service response if is_success = true The state of the order.
Allowed values are:
awaiting-approval—Order processed successfully; waiting for supplier approval.
in-progress—Order is in progress.
supplier_order_id Included in SSL Service response if is_success = true
Note: Required for domain-vetted RapidSSL, GeoTrust and Comodo SSL certificates The ID number for the vendor.
Examples for process_pending domain
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">process_pending</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="owner_address">[email protected]</item> <item key="fax_received">1</item> <item key="order_id">535242</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
If successfulIf unsuccessfulIf domain name matches a trademark at the TMCH
<?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">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="f_auto_renew">Y</item> <item key="id">3343012</item> <item key="registration expiration date">2007-12-05 15:23:15</item> </dt_assoc> </item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text"> Domain registration successfully completed </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">0</item> <item key="response_code">480</item> <item key="response_text">Order 535242 is not a pending or declined order and cannot be processed</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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_code">260</item> <item key="is_success">1</item> <item key="response_text">Registration is pending registrant review before completing due to claim/trademark.</item> <item key="transaction_id" /> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="order_id">654155</item> <item key="async_reason">has_claim</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Examples for process_pending trust_service
Example 1
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">process_pending</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="order_id">6617</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="domain">example.com </item> <item key="order_id">6617</item> <item key="supplier_order_id">219</item> <item key="state">awaiting-approval</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
This example uses dv_auth_method to request DV authorization details for all three methods (File, DNS and Email) on orders for Comodo and Symantec SSL products.
Request
FileDNSEmail
<?xml version='1.0 ' encoding='UTF-8' standalone='no'?> <OPS_envelope> <header> <version>0.9 </version> <msg_id>2.21765911726198 </msg_id> <msg_type>standard</msg_type> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">process_pending</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="order_id">17600</item> <item key="dv_auth_method">file</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?xml version='1.0 ' encoding='UTF-8' standalone='no'?> <OPS_envelope> <header> <version>0.9 </version> <msg_id>2.21765911726198 </msg_id> <msg_type>standard</msg_type> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">process_pending</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="order_id">16685</item> <item key="dv_auth_method">dns</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?xml version='1.0 ' encoding='UTF-8' standalone='no'?> <OPS_envelope> <header> <version>0.9 </version> <msg_id>2.21765911726198 </msg_id> <msg_type>standard</msg_type> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">process_pending</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="order_id">16686</item> <item key="approver_email">[email protected]</item> <item key="dv_auth_method">email</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
FileDNSEmail
<?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="object">TRUST_SERVICE</item> <item key="response_text">Command completed successfully.</item> <item key="action">PROCESS_PENDING:REPLY</item> <item key="attributes"> <dt_assoc> <item key="domain">simpletest1.com </item> <item key="dv_auth_method">file</item> <item key="order_id">17601</item> <item key="dv_auth_details"> <dt_assoc> <item key="file_contents">23D6930CD9F7B47AB1716D732BAA6114E83CAF64 comodoca.com </item> <item key="file_name">7E2537E8CE7B9D0554BD50BBC675A179.txt </item> </dt_assoc> </item> <item key="state">awaiting-approval</item> <item key="supplier_order_id">21843012</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">TRUST_SERVICE</item> <item key="response_text">Command completed successfully.</item> <item key="action">PROCESS_PENDING:REPLY</item> <item key="attributes"> <dt_assoc> <item key="domain">simpletest1.com </item> <item key="dv_auth_method">dns</item> <item key="order_id">17600</item> <item key="dv_auth_details"> <dt_assoc> <item key="dns_entry">7E2537E8CE7B9D0554BD50BBC675A179.simpletest1 .com CNAME 23D6930CD9F7B47AB1716D732BAA6114E83CAF64.comodoca .com</item> </dt_assoc> </item> <item key="state">awaiting-approval</item> <item key="supplier_order_id">21842891</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">TRUST_SERVICE</item> <item key="response_text">Command completed successfully.</item> <item key="action">PROCESS_PENDING:REPLY</item> <item key="attributes"> <dt_assoc> <item key="domain">20160122comodoemailb.com </item> <item key="order_id">16686</item> <item key="state">awaiting-approval</item> <item key="supplier_order_id">20073400</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for process_pending
Standard parameters
Attributes
Response parameters for process_pending
Standard parameters action = reply
Attributes
Examples for process_pending domain
Examples for process_pending trust_service
Example 1
Example 2
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
process_transfer
Creates a new order with the same data as a cancelled order; the existing cancelled order is not modified.
This command is only available for failed transfers with the status of 'cancelled'.
Suggest Edits
Request parameters for process_transfer
Standard parameters
action = process_transfer
object = transfer attributes
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
order_id Required The ID of the order to be resubmitted.
reseller Required Reseller username.
Response parameters for process_transfer
Standard parameters
action = reply
object = transfer
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 nameObligationDefinition/Value
order_id Returned if is_success = true ID of the newly created order.
Examples for process_transfer
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">PROCESS_TRANSFER</item> <item key="object">TRANSFER</item> <item key="attributes"> <dt_assoc> <item key="reseller">test_rsp</item> <item key="order_id">111111</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">TRANSFER</item> <item key="is_success">1</item> <item key="response_text">Transfer request has been successfully sent.
Admin contact email: [email protected]'</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="order_id">1111111</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 2 years ago
* * *
Table of Contents
Request parameters for process_transfer
Standard parameters
Attributes
Response parameters for process_transfer
Standard parameters
Attributes
Examples for process_transfer
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Protocol Message Structure
Suggest Edits
DTD
An OPS protocol message is an XML document, which satisfies the following Document Type Declaration (DTD).
ops.dtd
<!-- (C) Copyright 2016, Tucows Inc.
All Rights Reserved OPS Message Definition --> <!-- Envelope --> <!ELEMENT OPS_envelope (header,body)> <!-- header part --> <!ELEMENT header (version)> <!-- body part --> <!ELEMENT body (data_block)> <!-- data block --> <!ELEMENT data_block (dt_assoc | dt_array | dt_scalar| dt_scalarref)> <!-- data types --> <!ELEMENT dt_assoc (dt_assoc | dt_array| dt_scalar | dt_scalarref| (item)*)> <!ELEMENT dt_array (dt_assoc | dt_array | dt_scalar | dt_scalarref | (item)*)> <!ELEMENT dt_scalar (#PCDATA | dt_assoc | dt_array | dt_scalar | dt_scalarref)*> <!ELEMENT dt_scalarref (#PCDATA | dt_assoc | dt_array | dt_scalar | dt_scalarref)*> <!ELEMENT item (#PCDATA | dt_assoc | dt_array | dt_scalar | dt_scalarref)*> <!ATTLIST item key CDATA #REQUIRED class CDATA #IMPLIED > <!ELEMENT version (#PCDATA)> <!-- document information entities --> <!ENTITY company 'Tucows'> <!ENTITY copyright '2000, Tucows'>
Description
The preamble of an OPS message must contain encoding and DOCTYPE information specifying the correct DTD (ops.dtd ).
<?xml version='1.0 ' encoding='UTF-8' standalone='no' ?> <!DOCTYPE OPS_envelope SYSTEM 'ops.dtd '>
The start and end of an OPS message 'envelope' are delimited by <OPS_envelope> and </OPS_envelope> tags.
<OPS_envelope> ?
?
?
</OPS_envelope>
A message consists of two basic parts: a header and a body.
The header is delimited by
and and contains information that is related to protocol transport.
Currently the OPS protocol version is supported.
It is delimited by and tags.
The body is delimited by and tags.
Currently the body can only contain one component, which is the 'data_block'.
The data block contains an XML representation of a data structure, which in turn contains the information being passed by the process.
The data block is delimited by <data_block> and </data_block> tags.
Example
<OPS_envelope> <header> ?
</header> <body> <data_block> ?
</data_block> </body> </OPS_envelope>
The data structure within the data block is a represented according to data type.
The following data types are supported:
associative array (hash): <dt_assoc></dt_assoc>
array: <dt_array></dt_array>
array or associative array elements: <item key='' [class='']>
Where key is the name of the key used to access the element.
For an array, it is an integer (0...N).
For an associative array, it is a string.
Example for assoc array
<dt_assoc> <item key='firstname'>Tom</item> <item key='lastname'>Jones</item> </dt_assoc>
Example for array
<dt_array> <item key='0'>example1.com </item> <item key='1'>example2.com </item> </dt_array>
The class attribute is optional.
If specified, it refers to a class name that can be used to reconstruct the data into an object when decoded.
The actual details of this are implementation specific.
For example, for a Perl implementation the class name would be used to bless the underlying associative array (hash), back into an object.
Example for class
<dt_array> <item key='0' class='myClass'> <dt_assoc> <item key='firstname'>Tom</item> <item key='lastname'>Jones</item> </dt_assoc> </item> </dt_array>
scalars (for example, strings, integers): <dt_scalar></dt_scalar>
scalar reference: <dt_scalarref></dt_scalarref>
Data types can be arbitrarily nested.
For example, you could have an array of an array of associative arrays.
Any complex data type can be represented, provided the base data type is an array or an associative array.
OPS message examples
This example shows an OPS message that encodes an associative array that contains an array of values:
Example 1
<?xml version='1.0 ' encoding='UTF-8' standalone='no' ?> <!DOCTYPE OPS_envelope SYSTEM 'ops.dtd '> <OPS_envelope> <header> <version>1.0 </version> </header> <body> <data_block> <dt_assoc> <item key='domain_list'> <dt_array> <item key='0'>ns1.example .com</item> <item key='1'>ns2.example .com</item> <item key='2'>ns3.example .com</item> </dt_array> </dt_assoc> </data_block> </body> </OPS_envelope>
This example shows an OPS message that encodes an associative array that contains other associative arrays:
Example 2
<?xml version='1.0 ' encoding='UTF-8' standalone='no'?> <OPS_envelope> <header> <version>1.0 </version> </header> <body> <data_block> <dt_assoc> <dt_assoc> <item key="owner"> <dt_assoc> <item key="first_name">Tom</item> <item key="last_name">Jones</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="first_name">Anne</item> <item key="last_name">Smith</item> </dt_assoc> </item> </dt_assoc> </dt_assoc> </data_block> </body> </OPS_envelope>
This example shows an OPS message that encodes a scalar value:
Example 3
<?xml version='1.0 ' encoding='UTF-8' standalone='no' ?> <!DOCTYPE OPS_envelope SYSTEM 'ops.dtd '> <OPS_envelope> <header> <version>1.0 </version> </header> <body> <data_block> <dt_scalar>Tom Jones</dt_scalar> </data_block> </body> </OPS_envelope>
Updated over 2 years ago
* * *
What’s Next
Response Codes
Table of Contents
DTD
Description
OPS message examples
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
query (surname)
Queries the properties of the domain.
Suggest Edits
Request parameters for query (surname)
Standard parameters
action = query
object = surname
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The Personal Names domain to be queried.
query_dns Optional Requests information about the DNS settings.
0—Do not return DNS information; this is the default.
1—Return all DNS records for the zone.
query_email Optional Requests information about the associated email account.
0—Do not return email account information; this is the default.
1—Return information about the email account.
Response parameters for query (surname)
Standard parameters
action = reply
object = surname
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 nameObligationDefinition/Value
created_on Returned if is_success = true Date the domain was created.
domain Returned if is_success = true The Personal Names domain to which the returned values apply.
mailbox Optional Information about the mailbox.
For more information, see the Mailbox table below.
state Optional Current status of the Personal Names domain.
Available value is active.
zone Optional Information about the DNS records.
For more information, see the Zone table below.
Mailbox
Parameters within the mailbox associative array are described below.
Parameter nameObligationDefinition/Value
forward_email Optional The address to which email is forwarded.
mailbox_type Optional The type of mailbox: MAILBOX or WEBMAIL_ONLY.
Records
Parameters within the records associative array are described below.
Parameter nameObligationDefinition/Value
content Optional The IP address or fully qualified domain name.
name Optional The unqualified domain name or @ symbol.
type Optional The type of DNS record.
Allowed values are A and CNAME.
Zone
Parameters within the zone associative array are described below.
Parameter nameObligationDefinition/Value
records Optional A list of the DNS records associated with the domain, along with their values.
zone_id Optional Internal identifier for the DNS zone.
Examples for query (surname)
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">QUERY</item> <item key="object">SURNAME</item> <item key="attributes"> <dt_assoc> <item key="domain">steven.smith .net</item> <item key="query_email">1</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">SURNAME</item> <item key="response_text">Command completed successfully.</item> <item key="action">QUERY:REPLY</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="domain">steven.smith .net</item> <item key="created_on">2016-05-12T21:39:11.000 -04:00</item> <item key="mailbox"> <dt_assoc> <item key="response_text">OK</item> <item key="is_success">1</item> <item key="mailbox_type">MAILBOX</item> </dt_assoc> </item> <item key="state">active</item> </dt_assoc> </item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 3 years ago
* * *
Table of Contents
Request parameters for query (surname)
Standard parameters
Attributes
Response parameters for query (surname)
Standard parameters
Attributes
Mailbox
Records
Zone
Examples for query (surname)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
query_approver_list
Queries the list of approvers for the SSL service that is associated with a specified domain.
Suggest Edits
📘Note:
This command is currently not supported for Trustwave certificates.
Request parameters for query_approver_list
Standard parameters
action = query_approver_list
object = trust_service attributes
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The domain to which the SSL Service approver list belongs.
product_type Required The product type from the SSL Certificate inventory.
Allowed values are:
comodo_ev
comodo_instantssl
comodo_premiumssl
comodo_premiumssl_wildcard
comodo_ssl
comodo_wildcard
essentialssl
essentialssl_wildcard
positivessl
quickssl
quickssl_premium
securesite
securesite_pro
securesite_ev
securesite_pro_ev
sgcsuper_certs
ssl123
sslwebserver
sslwebserver_wildcard
sslwebserver_ev
symantec_ssl_lite
symantec_ssl_lite_wildcard
truebizid
truebizid_wildcard
truebizid_ev
**As of September 30th 2020, The following products will no longer be available:
quickssl (translate to quickssl_premium)
thawte_csc (Thawte Code Signing)
securesite_ft
securesite_pro_ft
securesite_ev_ft
securesite_pro_ev_ft
truebizid_ev_ft
Response parameters for query_approver_list
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 nameObligationDefinition/Value
approver_list Returned if is_success = true The list of approvers and their properties.
For more information, see the approver_list table.
Approver_list
Parameters within the approver_list associative array are described below.
Parameter nameObligationDefinition/Value
domain Always returned The domain to which the SSL Service applies.
email Always returned SSL Service approver email address.
type Always returned SSL Service approver type.
Allowed values are:
generic—Generated by pre-pending predefined list of prefixes to the domain name.
Prefixes include admin, administrator, hostmaster, root, webmaster, postmaster, and support.
manual—A list of support addresses taken from WHOIS.
Examples for query_approver_list
Request
<?xml version='1.0 ' encoding='UTF-8'?> <!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">query_approver_list</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="product_type">quickssl</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="approver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="email">[email protected]</item> <item key="domain">example.com </item> <item key="type">MANUAL</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="email">[email protected]</item> <item key="domain">example.com </item> <item key="type">MANUAL</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="email">[email protected]</item> <item key="domain">example.com </item> <item key="type">GENERIC</item> </dt_assoc> </item> <item key="3"> <dt_assoc> <item key="email">[email protected]</item> <item key="domain">example.com </item> <item key="type">GENERIC</item> </dt_assoc> </item> <item key="4"> <dt_assoc> <item key="email">[email protected]</item> <item key="domain">example.com </item> <item key="type">GENERIC</item> </dt_assoc> </item> <item key="5"> <dt_assoc> <item key="email">[email protected]</item> <item key="domain">example.com </item> <item key="type">GENERIC</item> </dt_assoc> </item> <item key="6"> <dt_assoc> <item key="email">[email protected]</item> <item key="domain">example.com </item> <item key="type">GENERIC</item> </dt_assoc> </item> <item key="7"> <dt_assoc> <item key="email">[email protected]</item> <item key="domain">example.com </item> <item key="type">GENERIC</item> </dt_assoc> </item> <item key="8"> <dt_assoc> <item key="email">[email protected]</item> <item key="domain">example.com </item> <item key="type">MANUAL</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 4 years ago
* * *
Table of Contents
Request parameters for query_approver_list
Standard parameters
Attributes
Response parameters for query_approver_list
Standard parameters
Attributes
Examples for query_approver_list
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
query_queued_request
Queries the status of a queued request.
Suggest Edits
Request parameters for query_queued_request
Standard parameters
action = query_queued_request
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
request_id Required The ID of the queued request; the queue_request_id is returned when an order is queued.
Response parameters for query_queued_request
Standard parameters action = reply
object = domain
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 nameObligationDefinition/Value
queue_date Returned if is_success = true The date the order was queued, in the format DD-MMM-YYYY hh:mm:ss.
request_data Returned if is_success = true The content of the original queued request.
All data is returned in a single variable.
Examples for query_queued_request
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">query_queued_request</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="request_id">1782</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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command completed successfully</item> <item key="attributes"> <dt_assoc> <item key="queue_date">04-MAR-2004 10:27:01</item> <item key="request_data"> <dt_assoc> <item key="ip">10.0 .11.121 </item> <item key="username">purple</item> <item key="action">SW_REGISTER</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for query_queued_request
Standard parameters
Attributes
Response parameters for query_queued_request
Standard parameters action = reply
Attributes
Examples for query_queued_request
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
redeem (domain)
Redeems a domain that has expired but is within the redemption grace period.
For a listed of supported TLDs, please see: https://help.opensrs .com/hc/en-us/articles/360003940393
Suggest Edits
Request parameters for redeem domain
📘Note:
Domain redemptions may incur addition fees.
Standard parameters
action = redeem
object = domain
registrant_ip = valid IP address of the registrant (optional)
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The name of the domain to be redeemed.
Domain must be within the redemption grace period.
Response parameters for redeem domain
Standard parameters
action = reply
object = domain
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 redeem domain
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">REDEEM</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">example.ca </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="action">REPLY</item> <item key="response_text">Command completed successfully</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
📘Note:
Domain redemptions will not work on the Horizon testing server.
Updated about 2 years ago
* * *
Table of Contents
Request parameters for redeem domain
Standard parameters
Attributes
Response parameters for redeem domain
Standard parameters
Examples for redeem domain
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
registry_add_ns
Adds a nameserver to one or all registries to which a reseller has access.
Suggest Edits
📘Note:
This command does not create a nameserver; a nameserver must already be created (see create (nameserver)).
Request parameters for registry_add_ns
Standard parameters
action = registry_add_ns
object = nameserver
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
all Required Specifies whether to add the nameserver to all registries or to only COM and NET:
0—Add to the registry specified in the tld Parameter
1—Add to all registries enabled for your account
fqdn Required The nameserver to be added, which must be a fully qualified domain name.
tld Required The registry to which you want to add the nameservers.
Allowed values: any tld available through OpenSRS, for example, .com.
Note: If the all value = 1, the tld value is ignored; however, it must be present and the value must be a valid tld; otherwise, the command will fail.
Response parameters for registry_add_ns
Standard parameters
action = reply
object = nameserver
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 nameObligationDefinition/Value
registry_name Returned if is_success = true Registry Names:
NSI
DENIC
NeuLevel
TV
NSI .cc
CIRA
ISOC/PIR
UK
VC
dotName
NeuStar
Afilias
Note: Only the registries to which the reseller is subscribed are returned.
The following success/failure messages may be returned:
'Successfully added.'
'Couldn't add nameserver: Registry doesn't support nameserver as a
separate object.'
'Couldn't add nameserver: Our system is experiencing technical
difficulties; please try again later.
If problem persists, please contact support and state error message: REM server: -702, no RAs to service the domain 'example.cc '.
Examples for registry_add_ns
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">registry_add_ns</item> <item key="object">nameserver</item> <item key="attributes"> <dt_assoc> <item key="fqdn">n99.example .aero</item> <item key="tld">.com</item> <item key="all">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
For "all" = "1"For "all" = "0"
<?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">nameserver</item> <item key="attributes"> <dt_assoc> <item key="DENIC">Successfully added</item> <item key="VC">Couldn't add nameserver: Unexpected response from registry: 705: No RAs to service your domain.
</item> <item key="TV">Couldn't add nameserver: Registry doesn't support nameserver as a separate object.
</item> <item key="Neulevel">Successfully added</item> <item key="CIRA">Couldn't add nameserver: Registry doesn't support nameserver as a separate object.
</item> <item key="ISOC/PIR">Successfully added</item> <item key="GNR">Successfully added</item> <item key="UK">Couldn't add nameserver: Registry doesn't support nameserver as a separate object.
</item> <item key="NSI_CC">Successfully added</item> <item key="Neustar">Successfully added</item> <item key="Afilias">Successfully added</item> </dt_assoc> </item> <item key="response_text">Command verified</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">nameserver</item> <item key="response_text">Command verified</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for registry_add_ns
Standard parameters
Attributes
Response parameters for registry_add_ns
Attributes
Examples for registry_add_ns
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
registry_check_nameserver
Verifies whether a nameserver exists at a particular registry.
Suggest Edits
📘Note:
This command is not required for registries that do not have a nameserver object, that is, .CA, .UK, .DE, .FR, and CH.
Request parameters for registry_check_nameserver
Standard parameters
action = registry_check_nameserver
object = nameserver attributes
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
fqdn Required The Fully Qualified Domain Name of the nameserver that you want to check.
tld Required The Top Level Domain of the nameserver that you want to check.
If no tld is supplied, the tld is extracted from the nameserver.
Response parameters for registry_check_nameserver
Standard parameters
action = reply
object = nameserver
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 nameObligationDefinition/Value
status Returned if is_success = true Indicates whether the nameserver exists at the registry.
Examples for registry_check_nameserver
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">REGISTRY_CHECK_NAMESERVER</item> <item key="object">NAMESERVER</item> <item key="attributes"> <dt_assoc> <item key="tld">.com</item> <item key="fqdn">ns1.livedns .co.uk </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
Nameserver foundNameserver not foundNameserver not found (registered nameserver not required by registry)
<?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_array> <item key="0"> <dt_assoc> <item key="protocol">XCP</item> <item key="action">REPLY</item> <item key="object">NAMESERVER</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command successful</item> </dt_assoc> </item> </dt_array> </data_block> </body> </OPS_envelope>
<?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">NAMESERVER</item> <item key="response_text">Command successful</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="status"> <dt_assoc> <item key="protocol">RAP</item> <item key="_response_text">Authorization error</item> <item key="_response_code">531</item> <item key="attributes"> <dt_assoc> <item key="trans_id"> <dt_assoc> <item key="client_trid">216.40 .33.60 - 1240404268810</item> <item key="server_trid">437077128- 1240404268830</item> </dt_assoc> </item> </dt_assoc> </item> <item key="registry_response_code">2201</item> <item key="is_success">0</item> </dt_assoc> </item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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_array> <item key="0"> <dt_assoc> <item key="protocol">XCP</item> <item key="action">REPLY</item> <item key="object">NAMESERVER</item> <item key="is_success">0</item> <item key="response_code">400</item> <item key="response_text">Registry doesn't support nameserver as a separate entity.</item> </dt_assoc> </item> </dt_array> </data_block> </body> </OPS_envelope>
Updated over 2 years ago
* * *
Table of Contents
Request parameters for registry_check_nameserver
Standard parameters
Attributes
Response parameters for registry_check_nameserver
Standard parameters
Attributes
Examples for registry_check_nameserver
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
renew (domain)
Renews a domain and allows you to set the auto-renewal flag on a domain.
Suggest Edits
Request parameters
Standard request parameters
action = renew
object = domain
registrant_ip = valid IP address of the registrant (optional)
Request attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
affiliate_id Optional ID that allows RSP's to track orders coming through various affiliates.
auto_renew Required A flag indicating whether the domain should be set to auto-renew.
0—Not set to auto-renew
1—Set to auto-renew
currentexpirationyear Required The domain's current expiration year in the format YYYY; must match the data in the registry.
domain Required The name of the domain to be renewed.
Domain must be registered, and must exist in both OpenSRS and the appropriate registry.
f_parkp Optional Enables the Parked Pages Program.
When the Parked Pages Program is enabled, a customized page containing contextual ads is displayed.
The ads generate revenue whenever a visitor clicks on one of the links, and that revenue is shared with you, the reseller.
Important: Enabling Parked Pages changes the nameservers of that domain, and any existing website will not display.
Parked Pages functionality is available for these TLDs: .COM, .NET, .ORG, .INFO, .BIZ, .MOBI, .NAME, .ASIA, .BE, .BZ, .CA, .CC, .CO, .EU, .IN, .ME, .NL, .TV, .UK, .US, .WS and .XXX.
Y—Enable Parked Pages for the domain
N—Do not enable ParkedPages for the domain
If a reseller has opted out of Parked Pages, the default value (N) is used, even if Y is submitted.
handle Required Instructions for the processing of the order.
(Overrides the RSP's 'process immediately' settings.).
save—Pend the order for the RSP's later approval
process—Process the order immediately
period Required The renewal period, from 1 to 10 years.
(May not exceed 10 years.)
* * *
Response parameters
Standard response parameters
object = domain
action= reply
is_success = Boolean 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
Response attributes
If the request is successful, the attributes associative array may include the following:
Parameter nameObligationDefinition/Value
admin_email Returned if is_success = 1 The email address of the administrative contact for the domain.
auto_renew Returned if is_success = 1 A flag indicating whether the domain is set to auto-renew.
0—Not set to auto-renew
1—Set to auto-renew
id Returned if is_success = 1 and order is not queued The domain ID.
If queue_request_id is returned, id is not returned.
order_id Returned if is_success = 1 The order ID of the renewal.
queue_request_id Returned if is_success = 1 and order is queued The ID of the request as it occurs within the queue.
Later, if you want to renew the order from the queue, you'll need this ID.
If queue_request_id is returned, id is not returned.
registration expiration date Returned if is_success = 1 The domain's current expiration year.
Response codes
Response CodeResponse TextExplanation
200 Command completed successfully Success response.
480 Renew capability is not enabled for domain.tv Renewals are not yet supported for this TLD.
465 Domain already renewed Domain has already been successfully renewed, with the current expiration year matching the year provided by the user.
541 Invalid attribute value Domain's current expiration year in registry doesn't match the year provided by user.
400 Fatal Server Error
Domain already renewed; another renewal cannot be applied until the first request completes', at the registry, approximately six to eight weeks after the original expiration date (2003-03-19 12:12:00) System error.
Domain is already in 'renewal applied' state.
📘Note:
When a renew operation fails, the reseller receives a message indicating which domain failed to be renewed.
This message is only sent once in 24 hours, regardless of how many renewals failed within this period.
* * *
Example
RequestResponse
<?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">renew</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="auto_renew">1</item> <item key="handle">process</item> <item key="currentexpirationyear">2022</item> <item key="period">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="id">682717</item> <item key="order_id">23732463</item> <item key="registration expiration date">2023-11-18 22:06:49</item> <item key="auto_renew">1</item> <item key="admin_email">[email protected]</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="response_text">Command completed successfully</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Response attributes
Response codes
Example
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
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.
Suggest Edits
📘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 nameObligationDefinition/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 nameObligationDefinition/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>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for request_on_demand_scan
Standard parameters
Attributes
Response parameters for request_on_demand_scan
Standard parameters
Attributes
Examples for request_on_demand_scan
Example 1
Example 2
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
resend_approve_email
Resends the Approver email
Suggest Edits
📘Note:
This command is not supported for SiteLock products, or for Comodo EV SSL certificates or for Trustwave Premium EV, Premium SSL and Premium SSL Wildcard certificates, or the GeoTrust Web Site Anti-Malware Scan product.
For TRUSTe products, this command resends the fulfillment email after the order is submitted.
Request parameters for resend_approve_email
Standard parameters
action = resend_approve_email
object = trust_service attributes
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
order_id Required The ID number of the SSL Service order.
Response parameters for resend_approve_email
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 nameObligationDefinition/Value
order_id Returned if is_success = true The ID number of the SSL Service order.
Examples for resend_approve_email
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">resend_approve_email</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="order_id">1859</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="is_success">1</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="order_id">1859</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for resend_approve_email
Standard parameters
Attributes
Response parameters for resend_approve_email
Standard parameters action = reply
Attributes
Examples for resend_approve_email
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
resend_cert_email
Resends the certificate email.
In order to request the SSL Certificate email, the order must be completed.
Suggest Edits
📘Note
This command is not supported for SiteLock or Comodo, or the GeoTrust Web Site Anti-Malware Scan product.
For TRUSTe products, this command resends the fulfillment email after the order is completed.
Request parameters for resend_cert_email
Standard parameters
action = resend_cert_email
object = trust_service attributes
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
order_id Required The ID number of the SSL Service order.
Response parameters for resend_cert_email
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 nameObligationDefinition/Value
order_id Returned if is_success = true The ID number of the SSL Service order.
Examples for resend_cert_email
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">resend_cert_email</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="order_id">1799</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="is_success">1</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="order_id">1799</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for resend_cert_email
Standard parameters
Attributes
Response parameters for resend_cert_email
Standard parameters
Attributes
Examples for resend_cert_email
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
resend_trade_approval_notice
Resends the notice of a trade approval.
Suggest Edits
Request Parameters for resend_trade_approval_notice
Standard parameters:
action = resend_trade_approval_notice
object = domain
protocol = XCP
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
registrant_type Required.
The status type of the registrant.
Possible values are:
new
current
send_type Required The preferred method of delivery for the approval notice.
Possible values are:
SMS
Note: send_type = SMS is an option only when registrant_type = current.
sms_phone_number Optional.
Note: If send_type=SMS and no value for sms_phone_number is supplied, the SMS notification will be sent to the current registrant phone number.
If an updated phone number is supplied, the SMS will be directed to the updated number.
The phone number to which the SMS message will be sent.
Response Parameters for resend_trade_approval_notice
Standard parameters
action = reply
object = domain
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
Parameters within the attributes associative array are described below.
Examples for resend_trade_approval_notice
When send_type = SMS
Request
<?xml version="1.0 "?> <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">RESEND_TRADE_APPROVAL_NOTICE</item> <item key="attributes"> <dt_assoc> <item key="registrant_type">current</item> <item key="domain">tucows-d6ad7a0fc501d8.com </item> <item key="send_type">sms</item> <item key="sms_phone_number">+1.2602180057 </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">SMS message successfully sent to +1.2602180057 </item> <item key="action">REPLY</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
When send_type = Email
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">RESEND_TRADE_APPROVAL_NOTICE</item> <item key="attributes"> <dt_assoc> <item key="registrant_type">new</item> <item key="domain">gfe7892gf2933e2f.com </item> <item key="send_type">email</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">Approval notification re-sent via EMAIL for the new registrant</item> <item key="action">REPLY</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request Parameters for resend_trade_approval_notice
Standard parameters:
Attributes
Response Parameters for resend_trade_approval_notice
Standard parameters
Attributes
Examples for resend_trade_approval_notice
When send_type = SMS
When send_type = Email
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
reset_dns_zone
Sets the DNS zone to the values in the specified template.
If a template is not specified in the command, the records are set to what was in the template that was used to enable the DNS service.
Suggest Edits
Request parameters for reset_dns_zone
Standard parameters
action = reset_dns_zone
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
dns_template Optional The name of the DNS template that you want to use
domain Required The domain whose DNS you want to reset.
Response parameters for reset_dns_zone
Standard parameters
action = reply
object = domain
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 nameObligationDefinition/Value
nameservers_ok Returned if is_success = true Indicates whether the domain is set up to use the OpenSRS nameservers.
0—Nameservers are not set to the DNS service nameservers
1—Nameservers are set to the DNS service nameservers
records Returned if is_success = true A list of the record types defined for the domain; each record includes the settings for that record.
Record types may be:
A
AAAA
CNAME
MX
SRV
TXT
Records
Parameters within the records associative array are described below.
Parameter nameObligationDefinition/Value
A Optional Maps the domain name to the IP address.
The A record consists of the following:
ip_address—InternetProtocolAddress.A numeric address that computers recognize, for example, 123.45 .54.123 .
subdomain—The third level of the domain name, such as www or ftp.
AAAA Optional Maps the domain name to the IPv6 address.
The AAAA record consists of the following:
subdomain—The third level of the domain name, such as www or ftp.
ipv6_address—The next generation Internet Protocol designed as the successor to version 4.
It is normally written as eight groups of four hexadecimal digits (i.e .
2003:0db8:
85a3:0000:0000:8a2e: 0370:7334
CNAME Optional Canonical Name.
CNAME records can be used when you want a subdomain to point to another hostname.
Allows you to create an alias for your domain.
The CNAME record consists of the following:
hostname—The FQDN of the domain that you want to access.
subdomain—The third level of the domain name, such as www or ftp.
MX Optional Mail Exchange.
MX records determine how mail is delivered to your domain.
Ensures that email that is sent to you is routed to the correct destination.
The MX record consists of the following:
priority—The priority of the target host,lower
value means more preferred.
subdomain—The third level of the domain name, such as www or ftp.
* hostname—The FQDN of the domain that you want to access.
SRV Optional Service Record.
The SRV record consists of the following:
priority—The priority of the target host,lower
value means more preferred.
weight—Arelative weight for records with the same priority.
subdomain—The third level of the domain name, such as www or ftp.
hostname—The FQDN of the domain that you want to access.
* port—The TCP or UDP port on which the service
is to be found.
TXT Optional Text Record.
Allows you to attach comments to a hostname, for example, SPF data to validate that email is being sent from the IP address of the domain's mail server.
The TXT record consists of the following:
subdomain—The third level of the domain
name, such as www or ftp.
text—The comments that you want to include.
Examples for reset_dns_zone
Request
If template is specifiedIf template is not specified
<?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">reset_dns_zone</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="dns_template">business_domains</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">reset_dns_zone</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
If template is specifiedIf template is not specified
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command Successful</item> <item key="attributes"> <dt_assoc> <item key="records"> <dt_assoc> <item key="A"> <dt_array> <item key="0"> <dt_assoc> <item key="subdomain"></item> <item key="ip_address">17.16 .156.5 </item> </dt_assoc> </item> </dt_array> </item> <item key="MX"> <dt_array> <item key="0"> <dt_assoc> <item key="priority">10</item> <item key="subdomain">www</item> <item key="hostname">example.com </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="priority">1</item> <item key="subdomain"></item> <item key="hostname">mx.cust .aug18dnstest1.com .hostedemail.com </item> </dt_assoc> </item> </dt_array> </item> <item key="SRV"> <dt_array> <item key="0"> <dt_assoc> <item key="priority">1</item> <item key="weight">3</item> <item key="subdomain">w3</item> <item key="hostname">yummynames.com </item> <item key="port">81</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> <item key="nameservers_ok">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Command Successful</item> <item key="attributes"> <dt_assoc> <item key="nameservers_ok">0</item> <item key="records"> <dt_assoc> <item key="A"> <dt_array> <item key="0"> <dt_assoc> <item key="subdomain"></item> <item key="ip_address">17.16 .156.5 </item> </dt_assoc> </item> </dt_array> </item> <item key="MX"> <dt_array> <item key="0"> <dt_assoc> <item key="priority">10</item> <item key="subdomain">www</item> <item key="hostname">example.org </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="priority">1</item> <item key="subdomain"></item> <item key="hostname">mx.cust .aug18dnstest1.com .hostedemail.com </item> </dt_assoc> </item> </dt_array> </item> <item key="SRV"> <dt_array> <item key="0"> <dt_assoc> <item key="priority">1</item> <item key="weight">3</item> <item key="subdomain">w3</item> <item key="hostname">yummynames.com </item> <item key="port">81</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for reset_dns_zone
Standard parameters
Attributes
Response parameters for reset_dns_zone
Standard parameters
Attributes
Examples for reset_dns_zone
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Response Codes
Suggest Edits
CodeResponse text/Explanation
200 Command Successful.
Authentication Successful.
Closing Connection.
Registration Successful.
Modification Successful.
Nameserver Update Successful.
Nameserver Added.
Nameserver Created.
Nameserver deleted.
No nameserver changes necessary.
Query Successful.
Registration successful.
210 Domain available.
211 Domain taken.
221 Domain taken (a waiting registration exists in OpenSRS).
Note: This is used for asynchronous registries only.
250 Action submitted successfully for processing to asynchronous registry.
300 Exceeded max command rate.
Request deferred (for async).
or
Registration is pending contact agreeing to share information per GDPR.
310 Exceeded max simultaneous connections.
350 Number of command per connection exceeded limit.
Client must re-authenticate with server.
A maximum of 100 commands can be sent through one connection/session.
After 100 commands have been submitted, the connection is closed and a new connection must be opened to submit outstanding requests.
400 Internal server error.
Invalid Command: xxx.
Access denied: invalid IP address.
Invalid encryption method; try -des: ...
Unable to change nameserver hostname to $new_fqdn.
Unable to complete registration.
Please retry.
Domain already renewed; another renewal cannot be applied until the first request completes at the registry.
404 Internal Server Error.
405 405 Registry error: domain's nameserver not updated.
Registry error, unable to add nameserver to domain.
Registry error, unable to remove nameserver.
Registry error, nameserver creation failed.
Nameserver deletion failed at registry.
Unable to modify nameserver record.
410 Reseller authentication error.
415 Registrant (end-user) authentication error.
Invalid Password supplied.
420 Failed to create new registrant contact: Parameter value range error\r\nInvalid telephone number format.
430 Invalid command.
435 Permission denied, subuser permissions.
Permission Denied for Modify $type, f_owner=xxx #modify_contact_info.
Cannot remove domain owner.
Permission Denied: not owner.
Request failed validation: Name server 'nameserver.tld ' is not found at the registry.
Please double check the nameserver and re-submit.
436 This error occurs when the RM does not know what to do with the response code returned by the RA after it talked with the registry.
This error usually means that the RM needs to be fixed to understand the new response.
437 Cannot process command because there is already another request waiting on this domain.
(Used for asynchronous registries.)
440 Registration Failed: over quota.
Please check for sufficient funds in the reseller account.
Premium domains might have a high cost that exceeds the available balance in the reseller account.
445 Nameserver quota exceeded.
447 Sub-user limit exceeded.
460 No Domain Supplied.
Modify type not specified.
Required field 'username' not provided.
Required field 'password' not provided.
Missing required field.
Missing required field: fqdn.
Missing required field: ip.
Info type not specified.
Required field 'reg_username' not provided.
Required field 'reg_password' not provided.
465 Registration Failed: Invalid data, error=
Registration Failed, error=
Unknown Modify type: xxx
Invalid data, error=#modify_contact_info.
Subuser cannot be the same as the owner.
Invalid syntax for subuser name.
Password exceeded maximum length: 20 characters.
Invalid domain name syntax.
Invalid syntax for registrant username.
Password length below minimum: 3 characters.
Invalid nameserver syntax (common_rule for nameserver).
Invalid syntax for nameserver (2nd level domain).
Invalid new nameserver hostname.
Invalid domain name syntax.
Duplicate nameserver detected for xxx.
Duplicate sortorder detected for xxx.
Invalid IP address: $ip.
Unknown Info type: $type.
Invalid syntax for username.
Invalid registration type: $reg_type.
Domain does not belong to Registrar.
480 Domain xxx not owned by user.
Renewals not supported for this TLD.
Response text =
'capability is not enabled for domain.ca '.
Subuser not found.
Subuser xxx not found.
Sub-User not found.
User profile for xxx/xxx not found.
Profile based on xxx not found.
Command failed: unable to verify existence of nameserver xxx.
Nameserver doesn't exist.
Unable to locate nameserver in local database.
Unable to find domain in registry.
Nameserver $fqdn not currently mapped to domain.
Nameserver not found.
Non-existent nameserver #(in registry).
470 Invalid format of owner contact.
Contact type is not supported by TLD.
Contact can not be updated together with other contact types.
485 Domain taken.
Nameserver already mapped to domain.
Nameserver $fqdn already exists (as result of request in DB or RRP).
Nameserver in use.
New nameserver hostname already in registry.
486 Entity already exists in a processing state (usually a domain registration) Trying again in a few seconds to a minute should resolve the issue (i.e .
show it truly taken or available).
487 Domain not transferable.
541 Domain's current expiration year in registry doesn't match the year provided by user.
552 Domain is less than 60 days old.
This can occur if:
Domain is not yet 60 days old.
Existing registrar has the name locked for either Nonpayment or at the end users request - requesting Party needs to contact existing registrar to resolve.
Domain name is in dispute.
The name has been deleted.
555 Domain has already been successfully renewed, with the current expiration year matching the year provided by the user.
557 Nameserver locked.
An attempt has been made to modify or delete a name server that is hosting a TLD in the root zone.
Modifications to the root zone can only be made with the approval of the U.S .
Department of Commerce and IANA, so if the registrar absolutely needs to modify or delete such a name server; the action needs to be coordinated through the registry operator using an out-of-band communications channel.
(Extracted from the RRP spec).
599 Failed to create contact for this TLD.
Parameter value range error\r\nInvalid telephone number format.
702 700 series indicates communication error with registry/vendor.
702 is a catch-all for errors related to communication issues.
703 Could not send command.
704 Read empty message on the socket.
705 Timed out, resubmit request.
Client timed out waiting for the RA to respond.
unnumbered Domain: sampledomainname Registration attempt failed: Timeout reading client request.
Client must re-authenticate with server.
A connection with the OpenSRS server remains open for no more than 60 seconds.
If the authentication and sending of a registration request do not complete within 60 seconds, the connection is closed and a new connection must be opened.
Updated over 2 years ago
* * *
What’s Next
Lookup (domain)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
revoke (domain)
Removes the domain at the registry.
Use this command to request a refund for a domain purchase.
This call can refund/revoke only one domain at the time.
Suggest Edits
📘Note:
A refund can be issued for only those domains which fall within the specified grace period as defined by each registry.
Request parameters for revoke (domain)
Standard parameters
action = revoke
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required Domain to be revoked.
notes Optional Information relevant to action.
Notes are saved to domain notes.
Response parameters for revoke (domain)
Standard parameters
action = reply
object = domain
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 nameObligationDefinition/Value
charge Optional Value indicating whether the reseller has been charged:
0—No charge
1—Indicates a Value
price Optional The sum of money of that the reseller is charged.
total_refund Optional The sum of money the reseller was refunded
deletion_id Optional A unique identifier to denote the revoke action
Examples for revoke (domain)
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">REVOKE</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">thegreatesttest.net </item> <item key="notes">this is a test</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
If successfulIf unsuccessful
<?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">Domain thegreatesttest.net revoked successfully</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="charge">0</item> <item key="price">0</item> <item key="total_refund">15.00 </item> <item key="deletion_id">43062543</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">0</item> <item key="response_text">Domain not found.</item> <item key="response_code">461</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for revoke (domain)
Standard parameters
Attributes
Response parameters for revoke (domain)
Standard parameters
Attributes
Examples for revoke (domain)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
send_authcode
Sends the Authcode for an EPP domain to the admin contact.
If the domain for which the request is made does not use the EPP protocol, an error is returned.
Suggest Edits
Request parameters for send_authcode
Standard parameters
action = send_authcode
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain_name Required The EPP domain name for which the Authcode is to be sent.
Response parameters for send_authcode
Standard parameters
action = reply
object = domain
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 send_authcode
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">send_authcode</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain_name">example.info </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">domain</item> <item key="response_text">Message sent</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for send_authcode
Standard parameters
Attributes
Response parameters for send_authcode
Standard parameters
Examples for send_authcode
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
send_password (domain)
Sends an email containing a password reset link to a contact of the domain.
Suggest Edits
Request parameters for send_password (domain)
Standard parameters
action = send_password
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain_name Required The domain name for which the password is sent.
send_to Required An indication of the contact to which the password is to be sent, either owner or admin (default)
sub_user Required An indication of whether the password is to be sent to the sub-user of the domain.
An error is returned if this field is set to 1 but there is no sub-user associated to the domain.
0—Do not send to sub-user
1—Sendtosub-user
Response parameters for send_password (domain)
Standard parameters
action = reply
object = domain
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 send_password (domain)
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">send_password</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="sub_user">0</item> <item key="send_to">owner</item> <item key="domain_name">example.info </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">domain</item> <item key="response_text">Message sent</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for send_password (domain)
Standard parameters
Attributes
Response parameters for send_password (domain)
Standard parameters
Examples for send_password (domain)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
send_password (transfer)
Resends an email message for a transfer that is in 'pending owner approval' state, to the admin contact listed for the domain at the time that the transfer request was submitted.
If a transfer is currently in progress, but in a different state, an error is returned.
Suggest Edits
📘Note:
This does not handle bulk transfers as such – if the password is requested for a domain that is part of a bulk-transfer order, the password returned in the email is only usable for the single domain.
Request parameters for send_password (transfer)
Standard Parameters
action = send_password
object = transfer attributes
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain_name Required The domain name for which the password is to be initiated.
Response parameters for send_password (transfer)
Standard parameters
action = reply
object = transfer
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 send_password (transfer)
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">send_password</item> <item key="object">transfer</item> <item key="attributes"> <dt_assoc> <item key="domain_name">example.com </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">transfer</item> <item key="response_text">Message sent.</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for send_password (transfer)
Standard Parameters
Attributes
Response parameters for send_password (transfer)
Standard parameters
Examples for send_password (transfer)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
send_registrant_verification_email
When a domain is registered or transferred, or when the registrant contact information is changed, the registrant must reply to an email requesting them to confirm that the submitted contact information is correct.
This command sends or resends the verification email to the registrant.
Suggest Edits
Request parameters for send_registrant_verification_email
Standard parameters
action = send_registrant_verification_email
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition / Value
domain Required The relevant domain.
Response parameters for send_registrant_verification_email
Standard parameters
action = reply
object = domain
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 send_registrant_verification_email
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">send_registrant_verification_email</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </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">DOMAIN</item> <item key="response_text">Verification email has been resent successfully.</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for send_registrant_verification_email
Standard parameters
Attributes
Response parameters for send_registrant_verification_email
Standard parameters
Examples for send_registrant_verification_email
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
set_dnssec_info
Adds or removes DS records for a given domain.
To delete a single record, send a set_dnssec_info request with the full record array minus the one you want to remove.
Suggest Edits
Request parameters
Standard request parameters
action = set_dnssec_info
object = domain
Request attributes
ParameterObligationDefinition/Value
domain Required The domain name you wish to apply DNSSEC to.
dnssec Required Contains an array specifying the DNSSEC details to be added.
For more information, please see the dnssec table below.
Note: To remove DNSSEC, submit an empty dnssec array.
Request parameters within the dnssec array includes the following:
ParameterObligationDefinition/Value
algorithm Required The cryptographic algorithm that generates the signature.
Allowed values are:
5—RSA/SHA-1
6—DSA-NSEC3/SHA1
7—RSASHA1-NSEC3/SHA1
8—RSA/SHA-256
10—RSA/SHA-512
253—Private [PRIVATEDNS]
254—Private [PRIVATEOID]
key_tag Required An integer value that identifies the DNSSEC record for this domain name.
Note: This value cannot exceed 65535.
digest_type Required The algorithm type that constructs the digest, allowed values are: Allowed values are:
1—SHA-1
2—SHA-256
3—GOST
4—SHA-384
digest Required The digest is an alpha-numeric string value.
The length depends on the digest type used: SHA-1 is 40 characters, SHA-256 & GOST is 64 characters, SHA-384 is 96 characters.
* * *
Response parameters
Standard response parameters
action = reply
object = domain
is_success = Boolean 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
Set DNSSEC, using DSA/SHA-1
RequestResponse
<?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">SET_DNSSEC_INFO</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="dnssec"> <dt_array> <item key="0"> <dt_assoc> <item key="algorithm">5</item> <item key="key_tag">333</item> <item key="digest_type">1</item> <item key="digest">da39a3ee5e6b4b0d3255bfef95601890afd80709</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="response_text">Command successful</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Remove all DNSSEC entries
RequestResponse
<?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">set_dnssec_info</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="dnssec"> <dt_array></dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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 successful</item> <item key="action">REPLY</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters
Examples Set DNSSEC, using DSA/SHA-1
Remove all DNSSEC entries
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
set_dns_zone
Set the records for a domain's DNS zone.
Suggest Edits
Request parameters for set_dns_zone
Standard parameters
action = set_dns_zone
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The domain whose DNS you want to set.
records Required A list of the record types defined for the domain; each record includes the settings for that record.
Record types may be
A
AAAA
CNAME
MX
SRV
TXT
For more information, see the Records table below.
Records
Parameters within the records associative array are described below.
Parameter nameObligationDefinition/Value
A Optional Maps the domain name to the IP address.
The A record consists of the following:
ip_address—Internet Protocol Address.
A numeric address that computers recognize, for example, 123.45 .54.123 .
subdomain— The third level of the domain name, such as www or ftp.
AAAA Optional Maps the domain name to the IPv6 address.
The AAAA record consists of the following:
ipv6_address—The next generation Internet Protocol designed as the successor to version 4.
It is normally written as eight groups of four hexadecimal digits (i.e .
2003:0db8: 85a3:0000:0000:8a2e: 0370:7334
subdomain—The third level of the domain name, such as www or ftp.
CNAME Optional Canonical Name.
CNAME records can be used when you want a subdomain to point to another hostname.
Allows you to create an alias for your domain.
The CNAME record consists of the following:
hostname—The FQDN of the domain that
you want to access.
subdomain—The third level of the domain name, such as www or ftp.
MX Optional Mail Exchange.
MX records determine how mail is delivered to your domain.
Ensures that email that is sent to you is routed to the correct destination.
The MX record consists of the following:
priority—The priority of the target host, lower value means more preferred.
subdomain—The third level of the domain name, such as www or ftp.
* hostname—The FQDN of the domain that you want to access.
nameservers_ok Required Indicates whether the domain is set up to use the OpenSRS nameservers.
0—Domain is not set up to use the OpenSRS nameservers
1—Domain is set up to use the OpenSRS nameservers
records Required A list of the record types defined for the domain; each record includes the settings for that record.
Record types may be
A
AAAA
CNAME
MX
SRV
TXT
SRV Optional Service Record.
The SRV record consists of the following:
priority—The priority of the target host, lower value means more preferred.
weight—Arelative weight for records with the same priority.
subdomain—The third level of the domain name, such as www or ftp.
hostname—The FQDN of the domain that you want to access.
* port—The TCP or UDP port on which the service is to be found.
TXT Optional Text Record.
Allows you to attach comments to a hostname to validate that email is being sent from the IP address of the domain's mail server.
The TXT record consists of the following:
subdomain—The third level of the domain name, such as www or ftp.
text—The comments that you want to include.
Response parameters for set_dns_zone
Standard parameters
action = reply
object = domain
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 nameObligationDefinition/Value
nameservers_ok Returned if is_success = true Indicates whether the domain is set up to use the OpenSRS nameservers.
0—Domain is not set up to use the OpenSRS nameservers
1—Domain is set up to use the OpenSRS nameservers
records Returned if is_success = true A list of the record types defined for the domain; each record includes the settings for that record.
Record types may be
A
AAAA
CNAME
MX
SRV
TXT
For more information, see the Records table below.
Records
Parameters within the records associative array are described below.
Parameter nameObligationDefinition/Value
A Optional Maps the domain name to the IP address.
The A record consists of the following:
ip_address—InternetProtocolAddress.A numeric address that computers recognize, for example, 123.45 .54.123 .
subdomain—The third level of the domain name, such as www or ftp.
AAAA Optional Maps the domain name to the IPv6 address.
The AAAA record consists of the following:
subdomain—The third level of the domain name, such as www or ftp.
ipv6_address—The next generation Internet Protocol designed as the successor to version 4.
It is normally written as eight groups of four hexadecimal digits (i.e .
2003:0db8: 85a3:0000:0000:8a2e:0370:7334)
CNAME Optional Canonical Name.
CNAME records can be used when you want a subdomain to point to another hostname.
Allows you to create an alias for your domain.
The CNAME record consists of the following:
hostname—The FQDN of the domain that you
want to access.
subdomain—The third level of the domain name, such as www or ftp.
MX Optional Mail Exchange.
MX records determine how mail is delivered to your domain.
Ensures that email that is sent to you is routed to the correct destination.
The MX record consists of the following:
priority—The priority of the target host,lower
value means more preferred.
subdomain—The third level of the domain
name, such as www or ftp.
* hostname—The FQDN of the domain that you want to access.
SRV Optional Service Record.
The SRV record consists of the following:
priority—The priority of the target host,lower
value means more preferred.
weight—A relative weight for records with the same priority.
subdomain—The third level of the domain name, such as www or ftp.
hostname—The FQDN of the domain that you want to access.
* port—The TCP or UDP port on which the service is to be found.
TXT Optional Text Record.
Allows you to attach comments to a hostname to validate that email is being sent from the IP address of the domain's mail server.
The TXT record consists of the following:
subdomain—The third level of the domain
name, such as www or ftp.
text—The comments that you want to include.
Examples for set_dns_zone
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">SET_DNS_ZONE</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="records"> <dt_assoc> <item key="A"> <dt_array> <item key="0"> <dt_assoc> <item key="subdomain"></item> <item key="ip_address">123.123 .123.2 </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="subdomain">*</item> <item key="ip_address">123.123 .123.3 </item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="subdomain">www</item> <item key="ip_address">123.123 .123.4 </item> </dt_assoc> </item> </dt_array> </item> <item key="CNAME"> <dt_array> <item key="0"> <dt_assoc> <item key="subdomain">portal</item> <item key="hostname">www.example .com</item> </dt_assoc> </item> </dt_array> </item> <item key="MX"> <dt_array> <item key="0"> <dt_assoc> <item key="subdomain"></item> <item key="hostname">mx.example .com.cust .test.hostedemail .com</item> <item key="priority">10</item> </dt_assoc> </item> </dt_array> </item> <item key="TXT"> <dt_array> <item key="0"> <dt_assoc> <item key="subdomain">mail</item> <item key="text">v=spf1 exists:example.com -all</item> </dt_assoc> </item> </dt_array> </item> <item key="AAAA"> <dt_array> <item key="0"> <dt_assoc> <item key="subdomain">itportal</item> <item key="ipv6_address">2001:00ab:0000:00a1:0001:000b:00cc:00de</item> </dt_assoc> </item> </dt_array> </item> <item key="SRV"> <dt_array> <item key="0"> <dt_assoc> <item key="subdomain">itcontrol</item> <item key="hostname">control.example .com</item> <item key="port">443</item> <item key="priority">10</item> <item key="weight">1</item> </dt_assoc> </item> </dt_array> </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">DOMAIN</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="records"> <dt_assoc> <item key="A"> <dt_array> <item key="0"> <dt_assoc> <item key="subdomain"></item> <item key="ip_address">123.123 .123.2 </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="subdomain">*</item> <item key="ip_address">123.123 .123.3 </item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="subdomain">www</item> <item key="ip_address">123.123 .123.4 </item> </dt_assoc> </item> </dt_array> </item> <item key="MX"> <dt_array> <item key="0"> <dt_assoc> <item key="priority">10</item> <item key="subdomain"></item> <item key="hostname">mx.example .com.cust .test.hostedemail .com</item> </dt_assoc> </item> </dt_array> </item> <item key="TXT"> <dt_array> <item key="0"> <dt_assoc> <item key="text">v=spf1 exists:example.com -all</item> <item key="subdomain">mail</item> </dt_assoc> </item> </dt_array> </item> <item key="SRV"> <dt_array> <item key="0"> <dt_assoc> <item key="priority">10</item> <item key="weight">1</item> <item key="subdomain">itcontrol</item> <item key="hostname">control.example .com</item> <item key="port">443</item> </dt_assoc> </item> </dt_array> </item> <item key="CNAME"> <dt_array> <item key="0"> <dt_assoc> <item key="subdomain">portal</item> <item key="hostname">www.example .com</item> </dt_assoc> </item> </dt_array> </item> <item key="AAAA"> <dt_array> <item key="0"> <dt_assoc> <item key="subdomain">itportal</item> <item key="ipv6_address">2001:00ab:0000:00a1:0001:000b:00cc:00de</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> <item key="nameservers_ok">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated 9 months ago
* * *
Table of Contents
Request parameters for set_dns_zone
Standard parameters
Attributes
Records
Response parameters for set_dns_zone
Standard parameters
Attributes
Examples for set_dns_zone
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
set_domain_affiliate_id
Assigns an affiliate id to a domain.
Suggest Edits
Request parameters for set_domain_affiliate_id
Standard parameters
action = set_domain_affiliate_id
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition / Value
affiliate_id Required The affiliate id associated with the domain (max 256 char).
domain Required The domain to which you want to assign an affiliate_id.
Response parameters for set_domain_affiliate_id
Standard parameters
action = reply
object = domain
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 set_domain_affiliate_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">set_domain_affiliate_id</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="affiliate_id">UpdatedAffiliate</item> <item key="domain">example.com </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">DOMAIN</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for set_domain_affiliate_id
Standard parameters
Attributes
Response parameters for set_domain_affiliate_id
Examples for set_domain_affiliate_id
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
set_domain_forwarding
Configures the domain forwarding settings for a domain.
Suggest Edits
📘Note:
Domain forwarding must already have been created for the domain.
See create_domain_forwarding.
The way in which the domain forwarding behaves depends on the format of
the domain name to which it applies:
domain.com —Applies to all requests for this domain, unless overridden by a second domain forwarding record.
For example, if a site visitor looks for whatever.domain .com, domain forwarding is applied (unless a specific record has been set up for whatever.domain .com, or *.domain.com ).
In other words, if no other forwarding is set up, domain.com acts as a catch-all.
*.domain.com —Applies domain forwarding to all subdomains.
It will not handle domain.com , but it will handle anything.domain .com.
whatever.domain .com—Domain forwarding is applied to this subdomain only.
Request parameters for set_domain_forwarding
Standard parameters
action = update_domain_forwarding
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The relevant domain.
forwarding Optional A list of the subdomains that you want forwarded and their associated attributes.
For more information, see the Forwarding table below.
Forwarding
Parameters within the forwarding associative array are described below.
Parameter nameObligationDefinition/Value
description Optional A short description of your website.
The maximum number of characters allowed is 255.
Note: This parameter only takes effect if masked = 1.
destination_url Optional The full address of the destination website, for example, http://www.mycompany .com/ mybestpage.html , or the IP address, for example, http://12.34 .56.123
The maximum number of characters allowed is 200.
enabled Optional Determines whether domain forwarding is in effect.
0—Turn off domain forwarding
1—Turn on domain forwarding
keywords Optional Descriptive words that a visitor might use when searching for your website.
Separate each word or phrase with a comma.
The maximum number of characters allowed is 900.
Note: This parameter only takes effect if masked =
1.
masked Optional Determines the destination website address appears
in the browser address field.
0—Display the actual destination address.
1—Mask the destination address and display the original domain address instead.
subdomain Required The third level of the domain name, such as www or ftp.
For example, if you specify www, visitors who type example.com are redirected to www.example .com.
The maximum number of characters allowed is 128.
Note: Although this parameter is required, its value can be null.
title Optional The text that you want to appear in the browser title bar.
The maximum number of characters allowed is 255.
Note: This parameter only takes effect if masked = 1.
Response parameters for set_domain_forwarding
Standard parameters
action = reply
object = domain
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 set_domain_forwarding
Example 1
Request
<?xml version='1.0 ' encoding='UTF-8'?> <OPS_envelope> <header> <version>0.9 </version> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">set_domain_forwarding</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="forwarding"> <dt_array> <item key="0"> <dt_assoc> <item key="masked">1</item> <item key="keywords">Example2.com </item> <item key="destination_url">http://www.example2 .com</item> <item key="enabled">1</item> <item key="description">Example2.com </item> <item key="subdomain">mail</item> <item key="title">Example2.com </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">DOMAIN</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
Without end-user credentials
Request
<?xml version='1.0 ' encoding='UTF-8'?> <OPS_envelope> <header> <version>0.9 </version> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">set_domain_forwarding</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="domain">mydomain.com </item> <item key="forwarding"> <dt_array> <item key="0"> <dt_assoc> <item key="keywords">shopping cart checkout</item> <item key="masked">1</item> <item key="subdomain">cart</item> <item key="destination_url">http://payment.gateway .biz</item> <item key="title">Shopping Cart Checkout Gateway</item> <item key="description">Access to user shopping cart for checkout handling.</item> <item key="enabled">1</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">DOMAIN</item> <item key="response_text">Command Successful</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for set_domain_forwarding
Standard parameters
Attributes
Forwarding
Response parameters for set_domain_forwarding
Standard parameters
Examples for set_domain_forwarding
Example 1
Example 2
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Standard Event Notification Parameters
Suggest Edits
Response Parameters for Event Notifications
Standard parameters
action = reply
object = event
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
Domain attributes
If the request is successful, the attributes associative array may include the
following:
Parameter nameObligationDefinition/Value
event Always returned The type of event.
event_id Always returned Unique identifier of the event.
event_date Always returned The date on which the event occurred.
This is returned in UTC ISO8601 format (Example: 2016-10-14T18:23:40Z).
Updated about 2 years ago
* * *
Table of Contents
Response Parameters for Event Notifications
Standard parameters
Domain attributes
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Standard Parameters for Transfer Event Notifications
Suggest Edits
Response Parameters for Transfer Event Notifications
Parameter nameObligationDefinition/Value
domain_name Always returned.
The domain to which the transfer pertains.
order_id Always returned.
The unique identifier of the order.
transfer_id Always returned.
The unique identifier of the transfer.
Updated about 2 years ago
* * *
Table of Contents
Response Parameters for Transfer Event Notifications
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
submit (bulk_change)
Submits a request to change information associated with a large set of domains.
Can also be used to check the availability of a list of domains, renew multiple domains, or to push multiple domains to another reseller account.
You can submit the following bulk change requests with this API call: check availability, domain lock/unlock, renewals, nameserver modification, contact changes, enable/disable Parked Pages, enable WHOIS Privacy, and push domains to another reseller account.
The following restrictions apply to the submit bulk_change API:
Up to 10,000 domains can be affected in a single request.
When submitting a large number of domains for a bulk change, there may be a delay of several minutes between when the request is submitted and
when the request is visible in the RWI.
If the reseller has not signed the end user access contract, owner and
admin contacts sets are not updated as part of bulk change request.
Up to 13 nameservers can be specified in the assign list when updating
nameservers.
Before you can push domains to another reseller account, you must add
that reseller to your allow list through the RWI.
Duplicate entries are
eliminated from the change_items list.
add_ns adds the nameserver to the current list while assign_ns replaces
the current list with whatever nameservers are listed in the bulk change request.
Suggest Edits
📘Note:
This command must be submitted to batch.opensrs .net; submissions to the live production pool (rr-n1-tor.opensrs .net) will fail.
Request parameters for submit (bulk_change)
Standard parameters
action = submit
object = bulk_change
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
apply_to_all_reseller_items Conditional, can only be used if change_items is not used.
Applies the bulk change to all domains in the reseller's account.
0—Do not apply the change to all domains; instead, apply to the domains specified in the change_items parameter
1—Apply to all domains in the reseller's account.
If this flag is set to 1, do not specify the change_items parameter.
apply_to_locked_domains Optional Applies the bulk change to locked as well as unlocked domains.
Note: this parameter cannot be used for bulk renewals.
0—Do not apply to locked domains; this is the default
1—Apply to locked domains
change_items Conditional, can only be used if applyto_all reseller_items is not used or equals 0.
List of domains to which to apply the bulk change.
Maximum is 10,000 domains
Note: If apply_to_all_reseller_items =1, do not include this parameter.
change_type Required The type of bulk change to perform.
Allowed values are:
availability_check—Check the registry, Premium Domains, and Personal Names for the availability of a list of domains and email a CSV file containing the results to the specified email address.
The file indicates whether each name is available, and for Premium Names, it also specified the price of the domain name.
Note: when this value is specified, contact_email is required.
dns_zone—Add,removeor reset the DNS service for multiple domains.
Changes can be applied to all specified domains, to only domains with DNS service nameservers, or to domains that are not using DNS service nameservers.
You can also change your nameservers to use the DNS service nameservers.
If a DNS template is not specified, a blank zone is applied.
dns_zone_record—Add, modify, or remove DNS records (A, CNAME, etc) from zones for multiple domains.
domain_contacts— Change
contact information for
multiple domains
domain_forwarding—Add or remove the domain forwarding service for multiple domains.
domain_lock—Lock or unlock multiple domains.
domain_nameservers— Add, remove, or assign Nameservers
domain_parked_pages— Enable or disable Parked Pages for multiple domains
domain_profile – merge user profiles by moving domains
domain_renew—Renew multiple domains in one request
push_domains—Move or 'push' domains from one
Note: Before you can push domains to another reseller, you need to add that reseller to your allow list in OpenSRS.
storefront_managed—Move domains from OpenSRS to Storefront or from Storefront to OpenSRS.
Important: When you move domains from Storefront to OpenSRS, any services that were enabled in Storefront (for example, domain forwarding or email forwarding) will be lost.
whois_privacy—Enable or disable WHOIS Privacy
* whois_publicity—Enable or disable WHOIS Publicity
contact_email Optional Email address to which send results.
Note: If change_type = availability_check, this value is required.
For change_type = dns_zone
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
apply_to_domains Required The type of domains to which you want to add, remove or reset the DNS service.
Allowed values are:
using_dns_nameservers
not_using_dns_nameservers
* all_selected_domains
dns_action Required The type of operation to perform.
Allowed values are add, remove, or reset.
dns_template Optional The template name.
Only applies when dns_action = add or reset.
only_if Optional Defines conditions that must be met in order to process the command.
Only applies when the dns_action is reset or remove.
The only allowed value is dns_template.
force_dns_nameservers Optional Determines whether to change the nameservers on the domain to ns1.systemdns .com, ns2.systemdns .com, ns3.systemdns .com
0—Do not change the nameservers
1—Change the nameservers
For change_type = dns_zone_record
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
dns_action Required The type of operation to perform.
Allowed values are add, remove or modify.
dns_record_type Required The type of DNS record that you want to edit.
Allowed values are A, AAAA, CNAME, MX, SRV, and TXT.
dns_record_data Required only if dns_action = add or modify.
The fields that apply to the specified dns_record_type.
MUST ADD CHART
only_if Optional.
Can only be used if dns_action = modify or remove.
Defines conditions that must be met in order to process the command.
For example, you could set the condition to update records only if the ip_address is 222.222 .222.222 .
For change_type = domain_contacts
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
contacts Required List of 1 – 4 contact sets.
Each set must be a hash reference with two keys.
Values include the type and set keys
set Required Array of contact details.
type type Required Type of contact.
Allowed values are billing and tech.
For change_type = domain_forwarding
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
change_items Required The list of domains to which domain forwarding is either added or removed.
op_type Required The type of operation to perform.
Allowed values are add or remove.
For change_type = domain_lock
(Available for .COM, .NET, .ORG, .INFO, .BIZ, .NAME, .ME, .MOBI, .ASIA, .CC, .CO, .TV, and .US.)
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
Definition/Value Required The type of operation to perform.
Allowed values are lock or unlock.
For change_type = domain_nameservers
(Available for .COM, .NET, .ORG, .INFO, .BIZ, .NAME, .MOBI, .ASIA, .AT, .BE, .CA, .CC, .CH, .CN, .CO, .DE, .DK, .ES, .EU, .FR, .IT, .ME, .MX, .NL, .TV, .UK, and .US)
Attributes
Parameters within the attributes associative array are described below.
Parameter nameParameter nameDefinition/Value
add_ns Conditional, can only be used if op_type = add_remove Nameserver(s) to add to the current list of nameservers.
assign_ns Conditional, can only be used if op_type = assign List of new nameservers.
Current nameservers are replaced with nameservers in the assign_ns list.
op_type Required The type of operation to perform.
Allowed values are add_remove or assign.
remove_ns Conditional, can only be used if op_type = add_remove Nameservers to remove from the current list of nameservers.
For change_type = domain_parked_pages
(Available for .COM, .NET, .ORG, .INFO, .BIZ, .MOBI, .NAME, .ASIA, .BE, .BZ, .CA, .CC, .CO, .EU, .IN, .ME, .NL, .TV, .UK, .US, .WS and .XXX)
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
op_type Required The type of operation to perform.
Allowed values are enable or disable.
For change_type = domain_profile
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
attach_to_domain Required for new profile Attaches profile to domain.
change_items Required The list of domains to which domain forwarding is either added or removed.
op_type Required The type of operation to perform.
Allowed values are new or existing.
password Required for existing profile Registrant password.
If specified, this value will be used for the new registration; otherwise the original password will be used.
username Required for existing profile Registrant username.
If specified, this value will be used for the new registration; otherwise the original username will be used.
For change_type = domain_renew
(Available for .COM, .NET, .ORG, .INFO, .BIZ, .NAME, .MOBI, .ASIA, .AT, .BE, .CA, .CC, .DH, .CN, .CO, .DE, .DK, .ES, .EU, .FR, .IT, .ME, .MX, .NL, .TV, .UK, and .US)
📘Note:
You must specify at least one of these parameters: let_expire, auto_renew, or period.
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
affiliate_id Optional The unique identifier of your reseller affiliate
auto_renew Optional Changes the setting of the auto renew flag for the domain.
If not specified, the current setting applies.
0—Disable auto-renew
1—Enable auto-renew
let_expire Optional Changes the status of the let expire flag.
If not specified, the current setting applies.
0—Do not expire the domain silently
1—Expire the domain silently
period Optional The renewal term.
Valid values are 0 to 10, depending on terms allowed for the TLD.
If not specified, domain is not renewed.
For change_type = push_domains
Attributes
Parameters within the attributes associative array are described below.
Parameter nameParameter nameDefinition/Value
change_items Required The list of domains to push to another reseller account.
gaining_reseller_username Required The name of the reseller that will be receiving the pushed domains.
contact_email Optional The email address to send the results of the request.
For change_type = storefront_managed
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
Definition/Value Required The type of operation to perform.
Allowed values are
move_to_storefront—Move all of the specified domains from OpenSRS to Storefront
move_to_opensrs—Move all of the specified domains from Storefront to OpenSRS
For change_type = whois_privacy
(Available for .COM, .NET, .ORG, .INFO, .BIZ, .NAME, .MOBI, .CC, .CO, .ME, and .TV)
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
op_type Required The type of operation to perform.
Allowed values are enable or disable.
Response parameters for submit (bulk_change)
Standard parameters
action = reply
object = bulk_change
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 nameObligationDefinition/Value
bulk_change_req_id Returned if
is_success = true An ID generated by the system.
Examples for submit (bulk_change)
Request
For bulk availability checkFor bulk add dns zoneFor bulk add dns zone recordFor bulk reset dns zoneFor bulk modify dns zone recordFor bulk remove dns zone recordFor bulk domain forwardingFor bulk domain lockingFor bulk nameserver changeFor bulk domain contact changeFor bulk parked pagesFor bulk move domains to new profileFor bulk add domains to existing profile (merge profiles)For bulk domain renewalFor bulk WHOIS PrivacyFor bulk push domain transfers to another ResellerFor bulk move domains
<?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">submit</item> <item key="object">bulk_change</item> <item key="attributes"> <dt_assoc> <item key="change_type">availability_check</item> <item key="change_items"> <dt_array> <item key="0">bulkrenewtest3.com </item> <item key="1">bulkrenewtest4.com </item> </dt_array> </item> <item key="contact_email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">BULK_CHANGE</item> <item key="action">SUBMIT</item> <item key="attributes"> <dt_assoc> <item key="change_type">dns_zone</item> <item key="force_dns_nameservers">1</item> <item key="apply_to_domains">not_using_dns_nameservers</item> <item key="dns_template">template_3</item> <item key="dns_action">add</item> <item key="change_items"> <dt_array> <item key="0">dnstestingthing1.com </item> <item key="1">dnstestingthing2.com </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">BULK_CHANGE</item> <item key="action">SUBMIT</item> <item key="attributes"> <dt_assoc> <item key="dns_record_type">cname</item> <item key="change_type">dns_zone_record</item> <item key="dns_action">add</item> <item key="change_items"> <dt_array> <item key="0">dnstestingthing1.com </item> <item key="1">dnstestingthing2.com </item> </dt_array> </item> <item key="dns_record_data"> <dt_assoc> <item key="subdomain">www</item> <item key="hostname">example.com </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">BULK_CHANGE</item> <item key="action">SUBMIT</item> <item key="attributes"> <dt_assoc> <item key="change_type">dns_zone</item> <item key="force_dns_nameservers">1</item> <item key="apply_to_domains">using_dns_ameservers</item> <item key="dns_template">template_2</item> <item key="dns_action">reset</item> <item key="change_items"> <dt_array> <item key="0">dnstestingthing1.com </item> <item key="1">dnstestingthing2.com </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">BULK_CHANGE</item> <item key="action">SUBMIT</item> <item key="attributes"> <dt_assoc> <item key="dns_record_type">cname</item> <item key="change_type">dns_zone_record</item> <item key="dns_action">modify</item> <item key="change_items"> <dt_array> <item key="0">dnstestingthing1.com </item> <item key="1">dnstestingthing2.com </item> </dt_array> </item> <item key="dns_record_data"> <dt_assoc> <item key="hostname">mydomain.com </item> </dt_assoc> </item> <item key="only_if"> <dt_assoc> <item key="subdomain">www</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">BULK_CHANGE</item> <item key="action">SUBMIT</item> <item key="attributes"> <dt_assoc> <item key="dns_record_type">cname</item> <item key="change_type">dns_zone_record</item> <item key="dns_action">remove</item> <item key="change_items"> <dt_array> <item key="0">dnstestingthing1.com </item> <item key="1">dnstestingthing2.com </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">BULK_CHANGE</item> <item key="action">SUBMIT</item> <item key="attributes"> <dt_assoc> <item key="change_type">domain_forwarding</item> <item key="op_type">add</item> <item key="change_items"> <dt_array> <item key="0">examplething1.com </item> <item key="1">examplething2.com </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">submit</item> <item key="object">bulk_change</item> <item key="attributes"> <dt_assoc> <item key="change_type">domain_lock</item> <item key="change_items"> <dt_array> <item key="0">example.com </item> <item key="1">example.info </item> </dt_array> </item> <item key="op_type">lock</item> <item key="contact_email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">submit</item> <item key="object">bulk_change</item> <item key="attributes"> <dt_assoc> <item key="change_type">domain_nameservers</item> <item key="change_items"> <dt_array> <item key="0">example.com </item> <item key="1">example.info </item> </dt_array> </item> <item key="assign_ns"> <dt_array> <item key="0">ns1.domain .com</item> <item key="1">ns2.domain .com</item> <item key="2">ns3.domain .com</item> </dt_array> </item> <item key="op_type">assign</item> <item key="apply_to_locked_domains">1</item> <item key="contact_email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">submit</item> <item key="object">bulk_change</item> <item key="attributes"> <dt_assoc> <item key="change_type">domain_contacts</item> <item key="apply_to_locked_domains">0</item> <item key="change_items"> <dt_array> <item key="0">example.com </item> <item key="1">example.info </item> </dt_array> </item> <item key="contacts"> <dt_array> <item key="0"> <dt_assoc> <item key="type">billing</item> <item key="set"> <dt_assoc> <item key="first_name">John</item> <item key="last_name">Doe</item> <item key="address3" /> <item key="fax" /> </dt_assoc> </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="type">tech</item> <item key="set"> <dt_assoc> <item key="first_name">Mark</item> <item key="last_name">Doe</item> <item key="address1">123 Main St.</item> </dt_assoc> </item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">submit</item> <item key="object">bulk_change</item> <item key="attributes"> <dt_assoc> <item key="change_items"> <dt_array> <item key="0">example.com </item> <item key="1">example.info </item> </dt_array> </item> <item key="contact_email">[email protected]</item> <item key="change_type">domain_parked_pages</item> <item key="op_type">enable</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">BULK_CHANGE</item> <item key="action">SUBMIT</item> <item key="attributes"> <dt_assoc> <item key="change_type">domain_profile</item> <item key="attach_to_domain">abc.com </item> <item key="op_type">existing</item> <item key="change_items"> <dt_array> <item key="0">abcdefg.com </item> <item key="1">hijklmn.com </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">submit</item> <item key="object">bulk_change</item> <item key="attributes"> <dt_assoc> <item key="change_type">domain_renew</item> <item key="change_items"> <dt_array> <item key="0">example1.com </item> <item key="1">example2.com </item> </dt_array> </item> <item key="affiliate_id">myaffiliate</item> <item key="let_expire">0</item> <item key="period">2</item> <item key="auto_renew">0</item> <item key="contact_email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">submit</item> <item key="object">bulk_change</item> <item key="attributes"> <dt_assoc> <item key="change_items"> <dt_array> <item key="0">example.com </item> <item key="1">example.info </item> </dt_array> </item> <item key="contact_email">[email protected]</item> <item key="change_type">whois_privacy</item> <item key="op_type">enable</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">submit</item> <item key="object">bulk_change</item> <item key="attributes"> <dt_assoc> <item key="change_type">push_domains</item> <item key="change_items"> <dt_array> <item key="0">bulkrenewtest3.com </item> <item key="1">bulkrenewtest4.com </item> </dt_array> </item> <item key="gaining_reseller_username">orange</item> <item key="contact_email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">submit</item> <item key="object">bulk_change</item> <item key="attributes"> <dt_assoc> <item key="change_type">storefront_managed</item> <item key="op_type">move_to_storefront</item> <item key="contact_email">[email protected]</item> <item key="change_items"> <dt_array> <item key="0">comcompliance2.com </item> <item key="1">comcompliance3.com </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
XML
<?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">bulk_change</item> <item key="response_text">Command successfully submitted for processing</item> <item key="is_success">1</item> <item key="bulk_change_req_id">168</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 2 years ago
* * *
Table of Contents
Request parameters for submit (bulk_change)
Standard parameters
Attributes
For change_type = dns_zone
Attributes
For change_type = dns_zone_record
Attributes
For change_type = domain_contacts
Attributes
For change_type = domain_forwarding
Attributes
For change_type = domain_lock
For change_type = domain_nameservers
For change_type = domain_parked_pages
Attributes
For change_type = domain_profile
Attributes
For change_type = domain_renew
For change_type = push_domains
Attributes
For change_type = storefront_managed
Attributes
For change_type = whois_privacy
Attributes
Response parameters for submit (bulk_change)
Standard parameters
Attributes
Examples for submit (bulk_change)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
submit_bulk_change (WHOIS Privacy)
This command allows you to enable or disable WHOIS Privacy for multiple domains.
WHOIS Privacy can be enabled or disabled for .COM, .NET, .ORG, .INFO, .BIZ, .ME, .MOBI, .NAME, .CC, .CO, and .TV TLDs.
Suggest Edits
Request parameters for submit_bulk_change
Standard parameters
action = submit_bulk_change
object = bulk_change attributes
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
apply_to_locked_domains Optional Specifies whether to apply WHOIS Privacy to locked domains.
0—Do not apply WHOIS Privacy to locked domains.
This is the default.
1—Apply WHOIS Privacy to locked domains
change_items Required List of domains for which you want to purchase WHOIS Privacy.
change_type Required Identifies WHOIS Privacy as the type of service to implement in bulk.
Allowed values are:
* whois_privacy
If this value is part of your current integration, it continues to work; however, we recommend that you use
contact_email Optional The email address to which your request results are sent.
If blank, you do not receive a results report or any other notification regarding the bulk WHOIS Privacy purchase.
op_type Required The type of operation to perform.
Allowed values are enable or disable.
Response parameters for submit_bulk_change
Standard parameters
action = reply
object = bulk_change
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 submit_bulk_change
RequestResponse
<?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">submit_bulk_change</item> <item key="object">bulk_change</item> <item key="attributes"> <dt_assoc> <item key="apply_to_locked_domains">1</item> <item key="contact_email">[email protected]</item><item key="change_type">whois_privacy</item><item key="op_type">enable</item><item key="change_items"><dt_array><item key="0">example1.com </item><item key="1">example2.com </item></dt_array></item></dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">BULK_CHANGE</item> <item key="response_text">Command successfully submitted for processing</item> <item key="is_success">1</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 2 years ago
* * *
Table of Contents
Request parameters for submit_bulk_change
Standard parameters
Attributes
Response parameters for submit_bulk_change
Standard parameters
Examples for submit_bulk_change
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
su_register
Submits a new registration order for an available Personal Names domain.
Suggest Edits
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 nameObligationDefinition/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 nameParameter nameDefinition/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 nameObligationDefinition/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_ONLY—THIS 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>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for su_register
Standard parameters
Attributes
DNS Records
Mailbox
Response parameters for su_register
Examples for su_register
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
sw_register (domain)
Initiates domain registration or domain transfer.
Please note your handle parameter: "save"- will keep the order pending for later approval by the RSP, whereas "process" will proceed and complete the order.
Suggest Edits
Request parameters
Standard request parameters
action = sw_register
object = domain
registrant_ip = valid IP address of the registrant (optional)
Request attributes
Parameters within the attributes associative array:
ParameterObligationDefinition/Value
affiliate_id Optional The unique identifier of an RSP's affiliate, which allows the RSP to track orders coming through different affiliates.
Specify a valid affiliate ID (max 256 char).
auto_renew Optional Used to set domain to auto-renew.
0—Do not auto-renew
1—Auto-renew
auth_info Optional The transfer authcode for the domain.
If provided and valid, the transfer will not send an approval email to the owner of the domain.
change_contact Optional Used to change contact information for .ORG, .INFO, .BIZ, .BE, .CN, .EU, .IT, .ME, .MOBI, .UK, and .US domains during a transfer or after transfer completion.
0—Do not change contact set
1—Apply new contact set when transfer completes.
Optional Required Value is always set to 1 for .CC, .TV, .COM, .NET.
comments Optional Adds additional notes to the order, for example, the additional residency information that is required for .FR domain registrations.
contact_set Required A collection of associative arrays containing contact information for each contact type (owner, admin, billing, tech).
See Contact Set.
Notes:
For, .ES, .MX, and .US registrations, state is required.
For .CA, contact state is only required if country is Canada or United States.
For .NL, state is NOT required.
For .ES domains registrations, the postal code must correspond to the province for each of the contacts.
See .ES postal codes for a list of the postal code prefixes that apply to each province.
For .IT domain registrations, if the entity_type is anything other than 1, org_name is required, and you must include the admin associative array.
If entity_type = 1, the admin contact is assumed to be the same as the owner and you do not need to submit it.
custom_nameservers Required for domain registrations An indication of whether to use the RSP's default nameservers, or those provided in the 'sw_register' request.
0—Use reseller's default nameservers.
If set to 0 and default nameservers are not defined, no nameservers are associated with the domain.
Note: .TEL always uses the default nameservers, so this value should be 0 for .TEL registrations.
Any nameservers submitted for .TEL will be ignored.
1—Use nameservers provided in request.
custom_transfer_nameservers Required for .EU transfers - If not submitted, the nameserver list is ignored This flag is only used if reg_type = transfer, and indicates whether to use the nameservers provided in the request.
0—Use the domain's existing nameservers and ignore nameservers provided in request.
1—Use nameservers provided in request.
A minimum of two nameservers must be provided.
If no nameservers are supplied, domain's nameservers are used.
Note: For .EU transfers, this parameter must always be set to 1.
custom_tech_contact Required for domain registrations An indication of whether to use the RSP's tech contact info, or the tech contact info provided n the 'sw_register' request.
0—Use reseller's tech contact info.
1—Use tech contact info provided in request.
dns_template Optional Specify the name of the DNS template that you want to use to enable DNS and assign initial DNS records, or specify blank to enable DNS without defining any records.
Note: You must enter the word blank preceded and followed by asterisks.
The template name can be a maximum of 50 characters.
If this parameter is specified, the nameservers are automatically set to the nameservers for the DNS service:
ns1.systemdns .com
ns2.systemdns .com
ns3.systemdns .com
domain Required for domain registrations.
The domain name to be acted upon in the sw_register request.
encoding_type Optional The encoding type for the domain.
Submit a valid three-character language tag.
For a list of allowed values, see Appendix C: Encoding Types for IDNs.
If you submit the reg_domain parameter to link two profiles, and the previously registered domain contains multilingual characters, the reg_domain value must also be in Punycode format.
For a list of the languages supported for each TLD, see the TLD reference chart on the OpenSRS website.
f_lock_domain Optional Allows you to lock the domain so that it cannot be transferred away.
To allow a transfer on a locked domain, the domain must first be unlocked.
Even if submitted, this setting is not applied to TLDs where locking is not supported such as .DE, .UK, .CH, .NL, .FR, IT, BE, and AT.
0—Do not lock domain
1—Lock domain
f_parkp Optional Enables the Parked Pages Program.
When the Parked Pages Program is enabled, a customized page containing contextual ads is displayed.
The ads generate revenue whenever a visitor clicks on one of the links, and that revenue is shared with you, the reseller.
Important: Enabling Parked Pages changes the nameservers of that domain, and any existing website will not display.
If Parked Pages is enabled, DNS settings entered at registration are saved for future use and the Parked Pages nameservers are used instead.
For transfers, the DNS settings that were entered with the transfer request are used.
If DNS settings were not submitted at the time of transfer, the pre-transfer DNS settings are used.
If the domain was using the Parked Pages DNS at the time of transfer, and DNS settings are not provided, the domain continues to use the Parked Pages DNS.
Y—Enable Parked Pages for the domain.
N—Do not enable Parked Pages for the domain; this is the default.
f_whois_privacy Optional Allows you to enable WHOIS Privacy for new registrations.
0—Disable
1—Enable
handle Optional Indicates how to process the order.
save—Pend the order for later approval by the RSP.
process—Proceed with the order immediate
lf absent, see reseller setting for default options.
Intended_use Optional Intended_use attribute is optional, but it is recommended that you submit an appropriate response for your .scot registration.
If no response is submitted, OpenSRS will send one on your behalf, but we cannot guarantee it will be accepted by the registry.
- It is a free form text field in API and Control Panel.
Max character count is 2048
<dt_assoc>
The domain will support trade and development in Scotland
</dt_assoc>
link_domains Optional Indicates whether to link this domain with others.
This parameter is only used when ordering multiple domains over multiple calls to sw_register.
Also, it is only used if the user does not wish to associate the new registrations with an existing domain/profile in OpenSRS.
The first sw_register call to OpenSRS should have link_domains set to 1.
The return to this call contains an OpenSRS order ID.
This value is used as the master_order_id in the subsequent calls to sw_register for the remainder of the domain list list.
0—Do not link domains
1—Link domains.
If set to 1, the reg_domain field should not be specified.
Note: Only the first call to sw_register should contain the attribute link_domains.
master_order_id Required for domain
registrations if link_domains =1 The order ID returned by the first by the first sw_register call for a group of domains that are to be linked (via the link_domains parameter).
nameserver_list Required for .EU transfers A list of nameserver pairs, each of which contain a mameserver's name and sort order.
(Minimum two required).
For allowed values, see the Nameserver_list table below.
If dns_template is specified, the nameservers are automatically set to the nameservers for the DNS service:
ns1.systemdns .com
ns2.systemdns .com
ns3.systemdns .com
Important: For .EU transfers, if nameservers are not provided, the domain name will be stripped of its existing nameservers and will not have any nameservers.
owner_confirm_address Required for .DE, .BE, .EU, and .IT transfers The email address to which to send messages regarding a .BE, .DE, .EU or .IT transfer.
Note: The email address provided is used for the current transfer only, and not for future messages.
period Required for new domain registrations only The length of the registration period.
Allowed values are 1 – 10, depending on the TLD, that is, not all registries allow for a 1-year registration.
The default is 2, which is valid for all TLDs.
premium_price_to_verify Required only if registering a registry premium domain.
Submits the premium domain price and verifies that it is the same as the list price.
If the submitted price does not match the Tucows list price, the command will fail.
Allowed value is the price for the premium domain, in the format nnn.nn .
reg_domain Optional An existing, active domain name in OpenSRS that is owned by the registrant.
Providing this parameter links the newly registered or transferred domain to the profile of the existing domain.
reg_username Required for domain registrations The username of the registrant.
Usernames must be 3-20 characters in length.You can use any of the following alphanumeric
characters: A-Z, a-z, 0-9.
reg_password Required for domain registrations The registrant's password.
Passwords must be 10-20 characters in length.You can use any of the following alphanumeric characters and symbols: A-Z, a-z, 0-9, !
@$^,.~|=-+_{}#
reg_type Required for domain registrations The type of registration being requested:
landrush—Submit a request for a domain during its landrush period
new—A new registration
transfer—Transfer a domain into OpenSRS
sunrise—Submit a request for a domain during its sunrise period
tld_data Required for .ABOGADO, .AERO, .AR, .ASIA, .AU, .BR, .CL, .COOP, .DE, .DK, .ES, .FI, .FR, .HK, .HU, .IT, .JOBS, .LAW, .LV, .MX, .MY, .NO, .NU, .NYC, .PM, .PRO, .PT, .RE, .RO, .RU, .SE, .SG, .TF, .UK, .U .WF, .YT, .ZA An associative array that contains additional information required by the registry, such as the residency of the registrant.
If you submit a request that contains this array, you must also include data = tld_data.
Allowed values are:
au_registrant_info—Eligibility requirements for.AU registrants.
priority_contact_id—Required for .AU if there is an existing 3rd level domain registered with the same name.
priority_auth_info—Required for .AU if there is an existing 3rd level domain registered with the same name.
ced_info—Charter Eligibility Declaration (CED) information for .ASIA domains.
ipr_data—Sponsored Community information associated with .XXX
domains.
it_registrant_info—Regional
presence requirements for .IT
domains.
nexus—American presence requirements for .US domains.
professional_data—The professional designation information that is associated with the .PRO domain.
registrant_extra_info—Regional presence requirements for various ccTLDs such as .FR and .NYC, or industry requirements for .JOBS domains or .AERO domains.
For information on the allowed values for each of these, see TLD Data.
trademark_smd Required for Sunrise orders of the new gTLDs The Signed Mark Data (SMD) that is issued by the Trademark Clearinghouse (TMCH) when the corresponding trademark is registered with TMCH, and which serves as proof of trademark rights.
When submitting sunrise orders for the new gTLDs, you must also submit the following parameters and values: reg_type = sunrise and handle = save.
messaging_language Optional messaging_language is an optional parameter in the attributes array.
If
not specified, messages sent to the end customer will be in the language
set as the default for the reseller.
messaging_language will now also be returned in the response of get
(userinfo).
Allowed values for messaging_languageaf-ZA (Afrikaans)
ar-AE (Arabic)
id-ID (Bahasa Indonesia)
bs-BA (Bosnian)
bg-BG (Bulgarian)
zh-CN (Chinese)
hr-HR (Croatian)
cs-CZ (Czech)
da-DK (Danish)
nl-NL (Dutch)
en-US (English)
fi-FI (Finnish)
fr-FR (French)
de-DE (German)
el-GR (Greek)
hi-IN (Hindi)
it-IT (Italian)
ja-JP (Japanese)
ko-KR (Korean)
lv-LV (Latvian)
lt-LT (Lithuanian)
ms-MY (Malay)
no-NO (Norwegian)
fa-AF (Persian)
pl-PL (Polish)
pt-BR (Portuguese)
ro-RO (Romanian)
ru-RU (Russian)
sr-RS (Serbian)
sk-SK (Slovak)
es-ES (Spanish)
sv-SE (Swedish)
th-TH (Thai)
tr-TR (Turkish)
vi-VN (Vietnamese)
Request parameters within the nameserver_list associative array may include the following:
Parameter nameObligationDefinition/Value
name Required Fully qualified domain name of the nameserver.
sortorder Required The sort order of the nameserver.
sortorder values must start at 1 and should not contain any gaps in sequence.
Additional request parameters for specific TLDs
.BE request parameters .BE registrations require just two contact types: **owner** and **tech**.
Admin and billing contacts are not required for .BE registrations and are ignored if submitted.
The **owner** and **tech** contact sets require the standard fields and values, plus specific values for the **lang** field.
📘Note:
During a .BE transfer, contact changes are only accepted for owner name and organization.
Changes to contact fields other than owner name and organization must be submitted after the transfer is completed.
Request attributes
Request parameters within the attributes associative array:
Parameter nameObligationDefinition/Value
owner_confirm_address Required if:
reg_type=new or transfer The email address to which to send messages regarding a .BE transfer.
The email address provided is used for the current transfer only, and not for future messages.
Owner and Tech
Request parameters within the owner and tech associative arrays:
Parameter nameObligationDefinition/Value
lang Required if:
reg_type=new or transfer The preferred language for use in the registration agreement and for dispute resolution:
en—English
fr—French
nl—Dutch
.CA request parameters Parameters within the attributes associative array:
Parameter nameObligationDefinition/Value
legal_type Required if:
reg_type=new or transfer Domain name owner's legal classification.
Possible values are as follows
ABO—Aboriginal
ASS—Association
CCO—Canadian Corporation
CCT—Canadian Citizen
EDU—Educational Institution
GOV—Government
HOP—Hospital
INB—Indian Band
LAM—Library, Archive, or Museum
LGR—Legal Representative
MAJ—His Majesty the King
OMK—Protected by Trademarks Act
PLT—Political Party
PRT—Partnership
RES—Permanent Resident
TDM—Trademark Owner
TRD—Trade Union
TRS—Trust
Please note: To change the legal type of a .CA domain during a transfer from another registrar, you must also submit the change_contact parameter..EU request parameters .EU registrations require just two contact types: owner and tech.
The admin and billing contacts are not required for .EU registrations and are ignored if submitted.
The owner and tech contact sets require the standard fields and values, plus specific values for the fields country and lang.
As of December 10, 2009, .EU supports IDNs.
The IDN name must be submitted in ACE (Punycode) encoding, and all characters in the name before it is converted to Punycode must conform to .EU requirements.
For more information on .EU IDNs, see https://www.eurid .eu/en/get-eu/domain-names-special-characters-idns
Tip: Individual .EU domain registrants can keep their name private in the WHOIS record by leaving the owner org_name field blank.
For .EU transfers, you must specify the domain's nameservers.
If no nameservers are provided, the domain name will be stripped of its existing nameservers and not have any nameservers.
Important: If org_name is not applicable, leave the org_name field blank, that is, do not enter na or none; otherwise the trade or transfer will fail.
Additional request parameters within the attributes associative array:
Parameter nameObligation
owner_confirm_address Required if:
reg_type = transfer The email address to which to send messages regarding a .EU transfer.
The email address provided is used for the current transfer only, and not for future messages.
Additional request parameters within the owner and tech associative arrays:
Parameter nameObligationDefinition/Value
country Required if:
reg_type = new To be eligible to register a .EU domain, you must have residency in one of the countries/regions designated by EURid, the .EU registry.
GB—United Kingdom (GB)
AX—Aland Islands Cyprus
DE—Germany
Estonia
Finland
Gibraltar
GP—Guadeloupe Hungary
Italy
Luxembourg
MQ—Martinique
NL—Netherlands Portugal
Sweden
Slovakia
AT—Austria
BE—Belgium
CY—
CZ—Czech Republic
DK—Denmark
EE—
ES—Spain
FI—
FR—France
GI—
GF—French Guyana
GR—Greece
HU—
IE—Ireland
IT—
LT—Lithuania
LU—
LV—Latvia
MT—Malta (including Gozo and Comino)
PL—Poland
PT—
RE—Reunion
SE—
SI—Slovenia
SK—
lang Required if:
reg_type = new The preferred language for use in the registration agreement and for dispute resolution.
cs—Czech
de—German
English
et—Estonian
French
it—Italian
lv—Latvian
nl—Dutch
Portuguese
Slovenian
da—Danish
el—Greek
en—
es—Spanish
fi—Finnish
fr—
hu—Hungarian
lt—Lithuanian
mt—Maltese
pl—Poland
pt—
sk—Slovak
sl—
sv—Swedish
.IT request parameters
Additional request parameters within the attributes associative array:
Parameter nameObligationDefinition/Value
change_contact Optional for
reg_type = transfer Used to change contact information during a transfer or after transfer completion.
0—Do not change contact set
1—Apply new contact set when transfer completes
Important: If change_contact = 1, then you must also include a tld_data associative array.
owner_confirm_address Required if:
reg_type = transfer The email address to which to send messages regarding a .IT transfer.
Note: The email address provided is used for the current transfer only, and not for future messages..MOBI request parameters
Additional request parameters for .MOBI
.MOBI applications use the sw_register command with the standard parameters.
Specific parameters and required values are described below.
Domain names can be registered for one to ten year terms.
Nameservers
You must submit the correct nameservers with your application.
If you are unsure which nameservers to submit with your application, submit the OpenSRS nameservers ns1.systemdns .com and ns2.systemdns .com.
Additional request parameters within the attributes associative array:
Parameter nameObligationDefinition/Value
period Required if:
reg_type = new The registration term (if application results in successful registration); may be 1 to 10 years.
reg_type Required The type of registration.
Allowed value is new..NAME request parameters
Additional request parameters within the attributes associative array:
Parameter nameObligationDefinition/Value
tld_data Optional for .NAME (if email bundle) An associative array containing TLD- specific data.
forwarding-email—For.NAME domains
* * *
Additional request parameters for registry premium names
Parameter nameObligationDefinition/Value
reg_type Required The type of registration.
Allowed value is new or transfer.
premium_price_to_verify Required Submits the premium domain price and verifies that it is the same as the list price.
If the submitted price does not match the Tucows list price, the command will fail.
Allowed value is the price for the premium domain, in the format nnn.nn .
* * *
Response parameters
🚧Asynchronous registry responses
The Reseller Agent (RSA) can respond with a 250 response_code, which indicates that the action was submitted for processing in an asynchronous registry.
When the registry's reply is received by OpenSRS, it is processed.
Performing a get userinfo command indicates if there is an action currently waiting on a domain.
Standard response parameters
ParameterValue
object DOMAIN
action REPLY
is_success Boolean 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.
Response attributes
If the request is successful, the attributes associative array may include the following:
ParameterObligationDefinition/Value
admin_email Optional Returns the admin email contact from the order.
async_reason Returned for asynchronous requests Indicates the reason that the request was asynchronous.
Allowed values are:
general—Order was submitted to an asynchronous registry.
has_claim—Registrant action required before order can complete.
is_gdpr_async—Orders for this TLD are processed asynchronously due to GDPR compliance.
cancelled_orders Optional A list of pending orders for this domain that are cancelled by the successful registration of the domain.
error Returned when an order fails.
A text description of the errors that occurred in a failed transaction.
forced_pending Returned if the order has been forced to pending queue.
Orders that cannot be processed (insufficient funds, domain already taken, and so on) are forced to the pending queue.
id Returned if is_success = 1 The ID of the order, which can be used in RWI queries.
queue_request_id Returned if the order has been queued.
The ID of the request as it appears in the queue.
registration_code Returned if is_success = 1 The registration code returned by the registry.
registration_text Returned if is_success = 1 The registration text returned by the registry.
transfer_id Returned if reg_type=transfer ID number of the transfer.
whois_privacy_state Returned if is_success = 1 Returns the state of WHOIS Privacy.
Allowed values are enabled, disabled, enabling (in process), or disabling (in process).
Domain registration examples
.COM, .NET, .ORG, .INFO, .BIZ, .NAME, .ME, .MOBI
Example 1
About this example:
This is a new domain name registration.
This registration creates a new user profile
No custom tech contact is set.
Custom nameservers are set.
WHOIS Privacy feature enabled at time of registration.
Parked Pages service activated (for qualifying TLDs).
User is requesting the domain to lock once it is registered.
Two pending orders are cancelled by the successful registration of this
RequestResponse
<?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="object">DOMAIN</item> <item key="action">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">0</item> <item key="domain">example.com </item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="f_whois_privacy">1</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="handle">process</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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">3</item> </dt_assoc> </item> </dt_array> </item> <item key="custom_tech_contact">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="domain_id">1532247</item> <item key="id">11820034</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
About this example:
This is a new domain name registration.
This registration is based on another domain (example.com ).
No custom tech contact is set.
DNS template is applied.
RequestResponse
<?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="object">DOMAIN</item> <item key="action">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">0</item> <item key="domain">example.com </item> <item key="reg_type">new</item> <item key="reg_domain">example.net </item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="f_whois_privacy">0</item> <item key="dns_template">example_template</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="handle">process</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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">3</item> </dt_assoc> </item> </dt_array> </item> <item key="custom_tech_contact">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="domain_id">1532248</item> <item key="id">11820036</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 3
About this example:
This is a new domain name registration.
No custom tech contact is set.
DNS is enabled but no records are defined.
RequestResponse
<?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="object">DOMAIN</item> <item key="action">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">0</item> <item key="domain">example.com </item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="f_whois_privacy">0</item> <item key="dns_template">*blank*</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="handle">process</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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="custom_nameservers">1</item> <item key="custom_tech_contact">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="domain_id">1532249</item> <item key="id">11820038</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.AERO
RequestResponse
<?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">sw_register</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="handle">process</item> <item key="reg_username">aaaa</item> <item key="reg_password">aaaa</item> <item key="auto_renew">0</item> <item key="link_domains">0</item> <item key="f_whois_privacy">1</item> <item key="f_lock_domain">1</item> <item key="custom_tech_contact">1</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">[email protected]</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">[email protected]</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">[email protected]</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> <item key="domain">example.aero </item> <item key="affiliate_id" /> <item key="period">1</item> <item key="reg_type">new</item> <item key="bulk_order">0</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> <item key="encoding_type" /> <item key="action">register</item> <item key="custom_nameservers">1</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="aero_ens_password">EnsPa55w0rd</item> <item key="aero_ens_id">EnsId</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_code">250</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully submitted</item> <item key="rr_id">13689</item> <item key="transaction_id">2012-05-16 09:10:36 1250 101</item> <item key="domain_id">707819</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully submitted</item> <item key="admin_email">[email protected]</item> <item key="registration_code">300</item> <item key="waiting_request">sw_register</item> <item key="waiting_requests_no">1</item> <item key="id">477659</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.ASIA
About this example:
This is a new domain name registration
The required ASIA-specific data is contained in the ced_info associative
array.
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">new</item> <item key="reg_username">exampleuser</item> <item key="reg_password">changeit123</item> <item key="domain">example.asia </item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </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">[email protected]</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">[email protected]</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">[email protected]</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> <item key="tld_data"> <dt_assoc> <item key="ced_info"> <dt_assoc> <item key="locality_country">JP</item> <item key="legal_entity_type">naturalPerson</item> <item key="id_type">passport</item> <item key="id_number">12345</item> <item key="contact_type">admin</item> </dt_assoc> </item> </dt_assoc> </item> <item key="period">1</item> <item key="custom_nameservers">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed.
TLD not supported for whois privacy service.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed.
TLD not supported for whois privacy service.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="domain_id">1521435</item> <item key="id">11541235</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.AU
📘Note:
.AU registrations require two contact types: owner and tech.
RequestResponse2nd Level .AU
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="reg_type">new</item> <item key="domain">example.com .au</item> <item key="period">2</item> <item key="link_domains">0</item> <item key="f_lock_domain">1</item> <item key="auto_renew">0</item> <item key="reg_domain" /> <item key="reg_username">user123</item> <item key="reg_password">changeit</item> <item key="tld_data"> <dt_assoc> <item key="au_registrant_info"> <dt_assoc> <item key="registrant_name">Registered Company Name Ltd</item> <item key="registrant_id_type">ABN</item> <item key="policy_reason">1</item> <item key="registrant_id">99 999 999 999</item> <item key="eligibility_type">Registered</item> <item key="eligibility_name">Don Marshall</item> <item key="eligibility_id_type">ACN</item> <item key="eligibility_id">99999999</item> </dt_assoc> </item> </dt_assoc> </item> <item key="custom_tech_contact">1</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">[email protected]</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">[email protected]</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">[email protected]</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> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">OK</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="admin_email">[email protected]</item> <item key="registration_text">Domain registration successfully completed Domain successfully locked.</item> <item key="registration_code">200</item> <item key="id">417011</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="reg_type">new</item> <item key="domain">example.au </item> <item key="period">2</item> <item key="link_domains">0</item> <item key="f_lock_domain">1</item> <item key="auto_renew">0</item> <item key="reg_domain" /> <item key="reg_username">user123</item> <item key="reg_password">changeit</item> <item key="tld_data"> <dt_assoc> <item key="au_registrant_info"> <dt_assoc> <item key="registrant_name">Registered Company Name Ltd</item> <item key="registrant_id_type">ABN</item> <item key="policy_reason">1</item> <item key="registrant_id">99 999 999 999</item> <item key="eligibility_type">Registered</item> <item key="eligibility_name">Don Marshall</item> <item key="eligibility_id_type">ACN</item> <item key="eligibility_id">99999999</item> <item key="priority_contact_id">99999999</item> <item key="priority_auth_info">99999999</item> </dt_assoc> </item> </dt_assoc> </item> <item key="custom_tech_contact">1</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">[email protected]</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">[email protected]</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">[email protected]</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> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.CA
About this example:
This is a new domain name registration.
Neither custom tech nor custom nameservers are supplied.
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="registrant_extra_info"> <dt_assoc> <item key="legal_type">CCT</item> </dt_assoc> </item> <item key="domain">example.ca </item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="first_name">Owen</item> <item key="last_name">Ottway</item> <item key="address1">32 Oak Street</item> <item key="address2">Suite 500</item> <item key="address3">Owner</item> <item key="city">SomeCity</item> <item key="postal_code">M6K3M1</item> <item key="state">ON</item> <item key="country">CA</item> <item key="phone">+1.4165550123x1902 </item> <item key="fax">+1.4165550124 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="admin"> <dt_assoc> <item key="first_name">Owen</item> <item key="last_name">Ottway</item> <item key="address1">32 Oak Street</item> <item key="address2">Suite 500</item> <item key="address3">Owner</item> <item key="city">SomeCity</item> <item key="postal_code">M6K3M1</item> <item key="state">ON</item> <item key="country">CA</item> <item key="phone">+1.4165550123x1902 </item> <item key="fax">+1.4165550124 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> <item key="period">1</item> <item key="reg_domain" /> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="sortorder">3</item> <item key="name">ns3.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed.
Whois Privacy successfully enabled.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed.
Whois Privacy successfully enabled.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="domain_id">1521434</item> <item key="id">11541234</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.COM.BR
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="tld_data"> <dt_assoc> <item key="br_register_number">123.456 .789-00</item> </dt_assoc> </item> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="domain">example.com .br</item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="country">BR</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">SP</item> <item key="email">[email protected]</item> <item key="city">Sao Paulo</item> <item key="postal_code">01037-010</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">BR</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">SP</item> <item key="email">[email protected]</item> <item key="city">Sao Paulo</item> <item key="postal_code">01037-010</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="billing"> <dt_assoc> <item key="country">BR</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">SP</item> <item key="email">[email protected]</item> <item key="city">Sao Paulo</item> <item key="postal_code">01037-010</item> <item key="fax">+1.4165550124 </item> <item key="address1">32 Oak Street</item> <item key="first_name">Owen</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> <item key="period">1</item> <item key="reg_domain" /> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="sortorder">3</item> <item key="name">ns3.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_code">250</item> <item key="is_success">1</item> <item key="rr_id">6466</item> <item key="response_text">Domain registration successfully submitted</item> <item key="transaction_id">2011-04-14 18:12:39 25830 101</item> <item key="domain_id">256808</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully submitted</item> <item key="admin_email">[email protected]</item> <item key="registration_code">300</item> <item key="waiting_requests_no">1</item> <item key="waiting_request">sw_register</item> <item key="id">296660</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.DE
📘Note:
Submit .DE zone contact information as contact type billing.
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="domain">example.de </item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="country">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </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">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </item> <item key="address1">32 Oak Street</item> <item key="first_name">Owen</item> </dt_assoc> </item> <item key="billing"> <dt_assoc> <item key="country">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </item> <item key="address1">32 Oak Street</item> <item key="first_name">Owen</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> <item key="period">1</item> <item key="reg_domain" /> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="sortorder">3</item> <item key="name">ns3.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="id">607737</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.DK
RequestResponse
<?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="object">DOMAIN</item> <item key="action">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">0</item> <item key="domain">example.dk </item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="f_whois_privacy">0</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="handle">process</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="registrant_vat_id">123456789</item> <item key="registrant_type">organization</item> </dt_assoc> </item> </dt_assoc> </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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">3</item> </dt_assoc> </item> </dt_array> </item> <item key="custom_tech_contact">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_code">250</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully submitted</item> <item key="rr_id">74063</item> <item key="transaction_id">2016-07-27 05:52:40 7393 101</item> <item key="domain_id">1521429</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully submitted</item> <item key="registration_code">300</item> <item key="async_reason">general</item> <item key="admin_email">[email protected]</item> <item key="domain_id">1521429</item> <item key="waiting_request">sw_register</item> <item key="waiting_requests_no">1</item> <item key="id">11540663</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.ES
RequestRespnse
<?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="object">DOMAIN</item> <item key="action">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">0</item> <item key="domain">example.es </item> <item key="reg_type">new</item> <item key="reg_username">testuser123</item> <item key="reg_password">changeit123</item> <item key="f_whois_privacy">0</item> <item key="custom_nameservers">1</item> <item key="handle">process</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="es_id_type">nie</item> <item key="es_id_number">X1234567L</item> </dt_assoc> </item> </dt_assoc> </item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="country">ES</item> <item key="org_name">Example Inc.</item> <item key="phone">+34.123456789 </item> <item key="last_name">Smith</item> <item key="state">Madrid</item> <item key="email">[email protected]</item> <item key="city">Madrid</item> <item key="postal_code">123456</item> <item key="address1">123 Main St</item> <item key="first_name">Bob</item> </dt_assoc> </item> <item key="admin"> <dt_assoc> <item key="country">ES</item> <item key="org_name">Example Inc.</item> <item key="phone">+34.123456789 </item> <item key="last_name">Smith</item> <item key="state">Madrid</item> <item key="email">[email protected]</item> <item key="city">Madrid</item> <item key="postal_code">123456</item> <item key="address1">123 Main St</item> <item key="first_name">Bob</item> </dt_assoc> </item> <item key="billing"> <dt_assoc> <item key="country">ES</item> <item key="org_name">Example Inc.</item> <item key="phone">+34.123456789 </item> <item key="last_name">Smith</item> <item key="state">Madrid</item> <item key="email">[email protected]</item> <item key="city">Madrid</item> <item key="postal_code">123456</item> <item key="address1">123 Main St</item> <item key="first_name">Bob</item> </dt_assoc> </item> </dt_assoc> </item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> </dt_array> </item> <item key="custom_tech_contact">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_text">Domain registration successfully completed.
TLD not supported for whois privacy service.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="admin_email">[email protected]</item> <item key="registration_text">Domain registration successfully completed.
TLD not supported for whois privacy service.</item> <item key="cancelled_orders"> <dt_array> <item key="0">1986895</item> </dt_array> </item> <item key="registration_code">200</item> <item key="domain_id">1014179</item> <item key="id">1986896</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
.EU
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="domain">example.eu </item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="country">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </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">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </item> <item key="address1">32 Oak Street</item> <item key="first_name">Owen</item> </dt_assoc> </item> <item key="billing"> <dt_assoc> <item key="country">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </item> <item key="address1">32 Oak Street</item> <item key="first_name">Owen</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> <item key="period">1</item> <item key="reg_domain" /> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="sortorder">3</item> <item key="name">ns3.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed.
TLD not supported for whois privacy service.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed.
TLD not supported for whois privacy service.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="domain_id">1521438</item> <item key="id">11541241</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.FR
RequestResponse
<?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="object">DOMAIN</item> <item key="action">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">0</item> <item key="domain">testdomain.fr </item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="f_whois_privacy">0</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="handle">process</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="registrant_type">organization</item> </dt_assoc> </item> </dt_assoc> </item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="country">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </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">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </item> <item key="address1">32 Oak Street</item> <item key="first_name">Owen</item> </dt_assoc> </item> <item key="billing"> <dt_assoc> <item key="country">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </item> <item key="address1">32 Oak Street</item> <item key="first_name">Owen</item> </dt_assoc> </item> </dt_assoc> </item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">3</item> </dt_assoc> </item> </dt_array> </item> <item key="custom_tech_contact">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Domain registration successfully completed</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="id">457700</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.HU
Request
RequestResponse
<?xml version='1.0 ' encoding='UTF-8' standalone='no'?> <!DOCTYPE OPS_envelope SYSTEM 'ops.dtd '><OPS_envelope> <OPS_envelope> <header> <version>0.9 </version> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="f_lock_domain">1</item> <item key="custom_tech_contact">1</item> <item key="auto_renew">1</item> <item key="reg_type">new</item> <item key="reg_username">zoltan</item> <item key="domain">example.hu </item> <item key="contact_set"> <dt_assoc> <item key="admin"> <dt_assoc> <item key="first_name">Daniel</item> <item key="last_name">Nagy</item> <item key="address1">Bem rakpart 49</item> <item key="address2" /> <item key="address3" /> <item key="city">Budapest</item> <item key="state" /> <item key="postal_code">H-1037</item> <item key="country">HU</item> <item key="org_name">Varga Szoftver</item> <item key="phone">+1.3615550123 </item> <item key="fax">+1.3615553653 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="owner"> <dt_assoc> <item key="first_name">Zoltan</item> <item key="last_name">Varga</item> <item key="org_name">Varga Szoftver</item> <item key="address1">Bem rakpart 49</item> <item key="address2" /> <item key="address3" /> <item key="city">Budapest</item> <item key="state" /> <item key="postal_code">H-1037</item> <item key="country">HU</item> <item key="fax">+1.3615553651 </item> <item key="phone">+1.3615550124 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="first_name">Paul</item> <item key="last_name">Farkas</item> <item key="org_name">Varga Szoftver</item> <item key="address1">Bem rakpart 49</item> <item key="address2" /> <item key="address3" /> <item key="city">Budapest</item> <item key="state" /> <item key="postal_code">H-1037</item> <item key="country">HU</item> <item key="fax">+1.3615553652 </item> <item key="phone">+1.3615550125 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="f_whois_privacy">0</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="sortorder">3</item> <item key="name">ns3.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> <item key="link_domains">0</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="registrant_vat_id">12345678</item> <item key="registrant_type">organization</item> </dt_assoc> </item> </dt_assoc> </item> <item key="period">1</item> <item key="reg_password">changeit</item> <item key="bulk_order">0</item> <item key="reg_domain" /> <item key="custom_nameservers">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="object">DOMAIN</item> <item key="response_code">250</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully submitted</item> <item key="domain_id">709245</item> <item key="transaction_id">2012-06-19 13:49:57 1277 101</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully submitted</item> <item key="admin_email">[email protected]</item> <item key="registration_code">300</item> <item key="waiting_request">sw_register</item> <item key="waiting_requests_no">1</item> <item key="id">480990</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.INFO
About this example:
This is a new domain name registration.
It is based on another domain (example-nsi.com ).
There is a custom tech contact.
There are no custom nameservers (notice the presence of the empty
nameserver_list array, which is permitted).
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew" /> <item key="link_domains">0</item> <item key="reg_type">new</item> <item key="reg_username">testuser123</item> <item key="reg_password">changeit123</item> <item key="domain">example.info </item> <item key="reg_domain">example-nsi.com </item> <item key="f_lock_domain">0</item> <item key="custom_nameservers">0</item> <item key="affiliate_id" /> <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">[email protected]</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">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">[email protected]</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="billing"> <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">[email protected]</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> </dt_assoc> </item> </dt_assoc> </item> <item key="period">2</item> <item key="nameserver_list"> <dt_array /> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="domain_id">1528551</item> <item key="id">11705848</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.IT
Example 1
This example registers a domain to a person (entity_code=1).
In this case, the admin contact does not need to be defined as it must be the same as the owner; if the admin contact is specified, it is ignored.
Similarly, org_name is not required in this instance, and if specified, is ignored.
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="reg_username">testuser123</item> <item key="tld_data"> <dt_assoc> <item key="it_registrant_info"> <dt_assoc> <item key="nationality_code">IT</item> <item key="reg_code">SGLMRA80A01H501E</item> <item key="entity_type">1</item> </dt_assoc> </item> </dt_assoc> </item> <item key="custom_tech_contact">1</item> <item key="reg_password">changeit123</item> <item key="period">1</item> <item key="f_whois_privacy">0</item> <item key="link_domains">0</item> <item key="custom_nameservers">1</item> <item key="f_lock_domain">0</item> <item key="domain">example031.it </item> <item key="reg_type">new</item> <item key="reg_domain"></item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="first_name">Mario</item> <item key="last_name">Segale</item> <item key="org_name">Mario Segale</item> <item key="address1">Via del Campidoglio, 1</item> <item key="city">Rome</item> <item key="state">RM</item> <item key="country">IT</item> <item key="postal_code">00123</item> <item key="phone">+39.0612345678 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="first_name">Frank</item> <item key="last_name">Mosser</item> <item key="org_name">Tech Orgname</item> <item key="address1">Piazza dei Giudici 1</item> <item key="city">Firenze</item> <item key="state">FI</item> <item key="country">IT</item> <item key="postal_code">50123</item> <item key="phone">+39.0551234567 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">3</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="id">214946</item> </dt_assoc> </item> </dt_assoc> </data_block> </body>` </OPS_envelope>
Example 2
This example registers a domain to an Italian company (entity_type = 2).
In this case, the admin contact is required.
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="reg_username">testuser123</item> <item key="tld_data"> <dt_assoc> <item key="it_registrant_info"> <dt_assoc> <item key="nationality_code">IT</item> <item key="reg_code">06612345675</item> <item key="entity_type">2</item> </dt_assoc> </item> </dt_assoc> </item> <item key="reg_password">changeit123</item> <item key="period">1</item> <item key="f_whois_privacy">0</item> <item key="link_domains">0</item> <item key="custom_nameservers">1</item> <item key="f_lock_domain">0</item> <item key="domain">example032.it </item> <item key="reg_type">new</item> <item key="reg_domain"></item> <item key="custom_tech_contact">1</item> <item key="contact_set"> <dt_assoc> <item key="admin"> <dt_assoc> <item key="first_name">Mario</item> <item key="last_name">Segale</item> <item key="org_name">Mario Segale</item> <item key="address1">Via del Campidoglio, 1</item> <item key="city">Rome</item> <item key="state">RM</item> <item key="country">IT</item> <item key="postal_code">00123</item> <item key="phone">+39.0612345678 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="owner"> <dt_assoc> <item key="first_name">Franco</item> <item key="last_name">Pendenza</item> <item key="org_name">Aumento Inc</item> <item key="address1">Via del Inclinazione, 1</item> <item key="city">Pisa</item> <item key="state">PI</item> <item key="country">IT</item> <item key="postal_code">52123</item> <item key="phone">+39.0501234567 </item> <item key="email">[email protected]</item> <item key="fax">+39.0501234568 </item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="first_name">Frank</item> <item key="last_name">Mosser</item> <item key="org_name">Tech Orgname</item> <item key="address1">Piazza dei Giudici 1</item> <item key="city">Firenze</item> <item key="state">FI</item> <item key="country">IT</item> <item key="postal_code">50123</item> <item key="phone">+39.0551234567 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">3</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_text">Domain registration successfully completed</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="id">214947</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.LAW .ABOGADO
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">sw_register</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="handle">process</item> <item key="auto_renew"/> <item key="link_domains">0</item> <item key="reg_domain"/> <item key="f_lock_domain">1</item> <item key="f_whois_privacy">1</item> <item key="f_parkp">Y</item> <item key="domain">example.law </item> <item key="affiliate_id"/> <item key="period">1</item> <item key="reg_type">new</item> <item key="comments">Sample comment</item> <item key="reg_username">aaaa</item> <item key="custom_tech_contact">0</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">[email protected]</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">[email protected]</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">[email protected]</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> </item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="qli_accreditation_id">exampleid</item> <item key="qli_accreditation_body">examplebody</item> <item key="qli_jurisdiction_country">CA</item> <item key="qli_jurisdiction_state">examplestate</item> <item key="qli_accreditation_year">1999</item> </dt_assoc> </item> </dt_assoc> </item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> <item key="reg_password">examplepassword</item> <item key="encoding_type"/> <item key="custom_nameservers">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.JOBS
RequestResponse
<?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="object">DOMAIN</item> <item key="action">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">0</item> <item key="domain">example.jobs </item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="f_whois_privacy">0</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="handle">process</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="jobs_admin_type">Yes</item> <item key="jobs_industry_type">Supply Chain</item> <item key="jobs_title">HR Generalist</item> <item key="jobs_association_member">Yes</item> <item key="jobs_website">http://www.example .com</item> </dt_assoc> </item> </dt_assoc> </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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">3</item> </dt_assoc> </item> </dt_array> </item> <item key="custom_tech_contact">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed.
Domain successfully locked.
Whois Privacy successfully enabled.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed.
Domain successfully locked.
Whois Privacy successfully enabled.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="domain_id">822732</item> <item key="id">730050</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.NAME
The registrant is requesting a forwarding email address with their domain.
RequestResponse
<?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="object">DOMAIN</item> <item key="action">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">0</item> <item key="domain">my.example .name</item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="f_whois_privacy">0</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="handle">process</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="forwarding_email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">3</item> </dt_assoc> </item> </dt_array> </item> <item key="custom_tech_contact">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Domain registration successfully completed</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed</item> <item key="registration_code">200</item> <item key="id">23995</item> <item key="admin_email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.PM, .RE, .TF, .WF, .YT
RequestResponse
<?xml version='1.0 ' encoding="UTF-8" standalone="no"?> <!DOCTYPE OPS_envelope SYSTEM "ops.dtd "><OPS_envelope> <OPS_envelope> <header> <version>0.9 </version> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="f_lock_domain">1</item> <item key="custom_tech_contact">1</item> <item key="auto_renew">1</item> <item key="reg_type">new</item> <item key="reg_username">lafleur</item> <item key="domain">example.pm </item> <item key="contact_set"> <dt_assoc> <item key="admin"> <dt_assoc> <item key="first_name">Marie</item> <item key="last_name">LaFleur</item> <item key="org_name">French Impressions</item> <item key="address1">13 Rue Daze</item> <item key="address2" /> <item key="address3" /> <item key="city">Paris</item> <item key="state" /> <item key="postal_code">75002</item> <item key="country">FR</item> <item key="fax">+1.3365550125 </item> <item key="phone">+1.3365551213 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="owner"> <dt_assoc> <item key="first_name">Henri</item> <item key="last_name">LaFleur</item> <item key="org_name">French Impressions</item> <item key="address1">13 Rue Daze</item> <item key="address2" /> <item key="address3" /> <item key="city">Paris</item> <item key="state" /> <item key="postal_code">75002</item> <item key="country">FR</item> <item key="phone">+1.3365551212 </item> <item key="fax">+1.3365550124 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="first_name">Pierre</item> <item key="last_name">LaFleur</item> <item key="org_name">French Impressions</item> <item key="address1">13 Rue Daze</item> <item key="address2" /> <item key="address3" /> <item key="city">Paris</item> <item key="state" /> <item key="postal_code">75002</item> <item key="country">FR</item> <item key="phone">+1.3365551214 </item> <item key="fax">+1.3365550125 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="f_whois_privacy">0</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="sortorder">3</item> <item key="name">ns3.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> <item key="link_domains">0</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="registration_number" /> <item key="registrant_vat_id">1X345678901</item> <item key="registrant_type">organization</item> </dt_assoc> </item> </dt_assoc> </item> <item key="period">1</item> <item key="reg_password">changeit</item> <item key="bulk_order">0</item> <item key="reg_domain" /> <item key="custom_nameservers">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="id">481007</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.PRO
RequestResponse
<?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="object">DOMAIN</item> <item key="action">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">0</item> <item key="domain">example.pro </item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="f_whois_privacy">0</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="handle">process</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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">3</item> </dt_assoc> </item> </dt_array> </item> <item key="custom_tech_contact">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="id">454197</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Request parameters
Standard request parameters
action = sw_register
object = domain
registrant_ip = valid IP address of the registrant (optional)
Request attributes
Parameters within the attributes associative array:
ParameterObligationDefinition/Value
affiliate_id Optional The unique identifier of an RSP's affiliate, which allows the RSP to track orders coming through different affiliates.
Specify a valid affiliate ID (max 256 char).
auto_renew Optional Used to set domain to auto-renew.
0—Do not auto-renew
1—Auto-renew
auth_info Optional The transfer authcode for the domain.
If provided and valid, the transfer will not send an approval email to the owner of the domain.
change_contact Optional Used to change contact information for .ORG, .INFO, .BIZ, .BE, .CN, .EU, .IT, .ME, .MOBI, .UK, and .US domains during a transfer or after transfer completion.
0—Do not change contact set
1—Apply new contact set when transfer completes.
Optional Required Value is always set to 1 for .CC, .TV, .COM, .NET.
comments Optional Adds additional notes to the order, for example, the additional residency information that is required for .FR domain registrations.
contact_set Required A collection of associative arrays containing contact information for each contact type (owner, admin, billing, tech).
See Contact Set.
Notes:
For, .ES, .MX, and .US registrations, state is required.
For .CA, contact state is only required if country is Canada or United States.
For .NL, state is NOT required.
For .ES domains registrations, the postal code must correspond to the province for each of the contacts.
See .ES postal codes for a list of the postal code prefixes that apply to each province.
For .IT domain registrations, if the entity_type is anything other than 1, org_name is required, and you must include the admin associative array.
If entity_type = 1, the admin contact is assumed to be the same as the owner and you do not need to submit it.
custom_nameservers Required for domain registrations An indication of whether to use the RSP's default nameservers, or those provided in the 'sw_register' request.
0—Use reseller's default nameservers.
If set to 0 and default nameservers are not defined, no nameservers are associated with the domain.
Note: .TEL always uses the default nameservers, so this value should be 0 for .TEL registrations.
Any nameservers submitted for .TEL will be ignored.
1—Use nameservers provided in request.
custom_transfer_nameservers Required for .EU transfers - If not submitted, the nameserver list is ignored This flag is only used if reg_type = transfer, and indicates whether to use the nameservers provided in the request.
0—Use the domain's existing nameservers and ignore nameservers provided in request.
1—Use nameservers provided in request.
A minimum of two nameservers must be provided.
If no nameservers are supplied, domain's nameservers are used.
Note: For .EU transfers, this parameter must always be set to 1.
custom_tech_contact Required for domain registrations An indication of whether to use the RSP's tech contact info, or the tech contact info provided n the 'sw_register' request.
0—Use reseller's tech contact info.
1—Use tech contact info provided in request.
dns_template Optional Specify the name of the DNS template that you want to use to enable DNS and assign initial DNS records, or specify blank to enable DNS without defining any records.
Note: You must enter the word blank preceded and followed by asterisks.
The template name can be a maximum of 50 characters.
If this parameter is specified, the nameservers are automatically set to the nameservers for the DNS service:
ns1.systemdns .com
ns2.systemdns .com
ns3.systemdns .com
domain Required for domain registrations.
The domain name to be acted upon in the sw_register request.
encoding_type Optional The encoding type for the domain.
Submit a valid three-character language tag.
For a list of allowed values, see Appendix C: Encoding Types for IDNs.
If you submit the reg_domain parameter to link two profiles, and the previously registered domain contains multilingual characters, the reg_domain value must also be in Punycode format.
For a list of the languages supported for each TLD, see the TLD reference chart on the OpenSRS website.
f_lock_domain Optional Allows you to lock the domain so that it cannot be transferred away.
To allow a transfer on a locked domain, the domain must first be unlocked.
Even if submitted, this setting is not applied to TLDs where locking is not supported such as .DE, .UK, .CH, .NL, .FR, IT, BE, and AT.
0—Do not lock domain
1—Lock domain
f_parkp Optional Enables the Parked Pages Program.
When the Parked Pages Program is enabled, a customized page containing contextual ads is displayed.
The ads generate revenue whenever a visitor clicks on one of the links, and that revenue is shared with you, the reseller.
Important: Enabling Parked Pages changes the nameservers of that domain, and any existing website will not display.
If Parked Pages is enabled, DNS settings entered at registration are saved for future use and the Parked Pages nameservers are used instead.
For transfers, the DNS settings that were entered with the transfer request are used.
If DNS settings were not submitted at the time of transfer, the pre-transfer DNS settings are used.
If the domain was using the Parked Pages DNS at the time of transfer, and DNS settings are not provided, the domain continues to use the Parked Pages DNS.
Y—Enable Parked Pages for the domain.
N—Do not enable Parked Pages for the domain; this is the default.
f_whois_privacy Optional Allows you to enable WHOIS Privacy for new registrations.
0—Disable
1—Enable
handle Optional Indicates how to process the order.
save—Pend the order for later approval by the RSP.
process—Proceed with the order immediate
lf absent, see reseller setting for default options.
Intended_use Optional Intended_use attribute is optional, but it is recommended that you submit an appropriate response for your .scot registration.
If no response is submitted, OpenSRS will send one on your behalf, but we cannot guarantee it will be accepted by the registry.
- It is a free form text field in API and Control Panel.
Max character count is 2048
<dt_assoc>
The domain will support trade and development in Scotland
</dt_assoc>
link_domains Optional Indicates whether to link this domain with others.
This parameter is only used when ordering multiple domains over multiple calls to sw_register.
Also, it is only used if the user does not wish to associate the new registrations with an existing domain/profile in OpenSRS.
The first sw_register call to OpenSRS should have link_domains set to 1.
The return to this call contains an OpenSRS order ID.
This value is used as the master_order_id in the subsequent calls to sw_register for the remainder of the domain list list.
0—Do not link domains
1—Link domains.
If set to 1, the reg_domain field should not be specified.
Note: Only the first call to sw_register should contain the attribute link_domains.
master_order_id Required for domain
registrations if link_domains =1 The order ID returned by the first by the first sw_register call for a group of domains that are to be linked (via the link_domains parameter).
nameserver_list Required for .EU transfers A list of nameserver pairs, each of which contain a mameserver's name and sort order.
(Minimum two required).
For allowed values, see the Nameserver_list table below.
If dns_template is specified, the nameservers are automatically set to the nameservers for the DNS service:
ns1.systemdns .com
ns2.systemdns .com
ns3.systemdns .com
Important: For .EU transfers, if nameservers are not provided, the domain name will be stripped of its existing nameservers and will not have any nameservers.
owner_confirm_address Required for .DE, .BE, .EU, and .IT transfers The email address to which to send messages regarding a .BE, .DE, .EU or .IT transfer.
Note: The email address provided is used for the current transfer only, and not for future messages.
period Required for new domain registrations only The length of the registration period.
Allowed values are 1 – 10, depending on the TLD, that is, not all registries allow for a 1-year registration.
The default is 2, which is valid for all TLDs.
premium_price_to_verify Required only if registering a registry premium domain.
Submits the premium domain price and verifies that it is the same as the list price.
If the submitted price does not match the Tucows list price, the command will fail.
Allowed value is the price for the premium domain, in the format nnn.nn .
reg_domain Optional An existing, active domain name in OpenSRS that is owned by the registrant.
Providing this parameter links the newly registered or transferred domain to the profile of the existing domain.
reg_username Required for domain registrations The username of the registrant.
Usernames must be 3-20 characters in length.You can use any of the following alphanumeric
characters: A-Z, a-z, 0-9.
reg_password Required for domain registrations The registrant's password.
Passwords must be 10-20 characters in length.You can use any of the following alphanumeric characters and symbols: A-Z, a-z, 0-9, !
@$^,.~|=-+_{}#
reg_type Required for domain registrations The type of registration being requested:
landrush—Submit a request for a domain during its landrush period
new—A new registration
transfer—Transfer a domain into OpenSRS
sunrise—Submit a request for a domain during its sunrise period
tld_data Required for .ABOGADO, .AERO, .AR, .ASIA, .AU, .BR, .CL, .COOP, .DE, .DK, .ES, .FI, .FR, .HK, .HU, .IT, .JOBS, .LAW, .LV, .MX, .MY, .NO, .NU, .NYC, .PM, .PRO, .PT, .RE, .RO, .RU, .SE, .SG, .TF, .UK, .U .WF, .YT, .ZA An associative array that contains additional information required by the registry, such as the residency of the registrant.
If you submit a request that contains this array, you must also include data = tld_data.
Allowed values are:
au_registrant_info—Eligibility requirements for.AU registrants.
priority_contact_id—Required for .AU if there is an existing 3rd level domain registered with the same name.
priority_auth_info—Required for .AU if there is an existing 3rd level domain registered with the same name.
ced_info—Charter Eligibility Declaration (CED) information for .ASIA domains.
ipr_data—Sponsored Community information associated with .XXX
domains.
it_registrant_info—Regional
presence requirements for .IT
domains.
nexus—American presence requirements for .US domains.
professional_data—The professional designation information that is associated with the .PRO domain.
registrant_extra_info—Regional presence requirements for various ccTLDs such as .FR and .NYC, or industry requirements for .JOBS domains or .AERO domains.
For information on the allowed values for each of these, see TLD Data.
trademark_smd Required for Sunrise orders of the new gTLDs The Signed Mark Data (SMD) that is issued by the Trademark Clearinghouse (TMCH) when the corresponding trademark is registered with TMCH, and which serves as proof of trademark rights.
When submitting sunrise orders for the new gTLDs, you must also submit the following parameters and values: reg_type = sunrise and handle = save.
messaging_language Optional messaging_language is an optional parameter in the attributes array.
If
not specified, messages sent to the end customer will be in the language
set as the default for the reseller.
messaging_language will now also be returned in the response of get
(userinfo).
Allowed values for messaging_languageaf-ZA (Afrikaans)
ar-AE (Arabic)
id-ID (Bahasa Indonesia)
bs-BA (Bosnian)
bg-BG (Bulgarian)
zh-CN (Chinese)
hr-HR (Croatian)
cs-CZ (Czech)
da-DK (Danish)
nl-NL (Dutch)
en-US (English)
fi-FI (Finnish)
fr-FR (French)
de-DE (German)
el-GR (Greek)
hi-IN (Hindi)
it-IT (Italian)
ja-JP (Japanese)
ko-KR (Korean)
lv-LV (Latvian)
lt-LT (Lithuanian)
ms-MY (Malay)
no-NO (Norwegian)
fa-AF (Persian)
pl-PL (Polish)
pt-BR (Portuguese)
ro-RO (Romanian)
ru-RU (Russian)
sr-RS (Serbian)
sk-SK (Slovak)
es-ES (Spanish)
sv-SE (Swedish)
th-TH (Thai)
tr-TR (Turkish)
vi-VN (Vietnamese)
Request parameters within the nameserver_list associative array may include the following:
Parameter nameObligationDefinition/Value
name Required Fully qualified domain name of the nameserver.
sortorder Required The sort order of the nameserver.
sortorder values must start at 1 and should not contain any gaps in sequence.
Additional request parameters for specific TLDs
.BE request parameters .BE registrations require just two contact types: **owner** and **tech**.
Admin and billing contacts are not required for .BE registrations and are ignored if submitted.
The **owner** and **tech** contact sets require the standard fields and values, plus specific values for the **lang** field.
📘Note:
During a .BE transfer, contact changes are only accepted for owner name and organization.
Changes to contact fields other than owner name and organization must be submitted after the transfer is completed.
Request attributes
Request parameters within the attributes associative array:
Parameter nameObligationDefinition/Value
owner_confirm_address Required if:
reg_type=new or transfer The email address to which to send messages regarding a .BE transfer.
The email address provided is used for the current transfer only, and not for future messages.
Owner and Tech
Request parameters within the owner and tech associative arrays:
Parameter nameObligationDefinition/Value
lang Required if:
reg_type=new or transfer The preferred language for use in the registration agreement and for dispute resolution:
en—English
fr—French
nl—Dutch
.CA request parameters Parameters within the attributes associative array:
Parameter nameObligationDefinition/Value
legal_type Required if:
reg_type=new or transfer Domain name owner's legal classification.
Possible values are as follows
ABO—Aboriginal
ASS—Association
CCO—Canadian Corporation
CCT—Canadian Citizen
EDU—Educational Institution
GOV—Government
HOP—Hospital
INB—Indian Band
LAM—Library, Archive, or Museum
LGR—Legal Representative
MAJ—His Majesty the King
OMK—Protected by Trademarks Act
PLT—Political Party
PRT—Partnership
RES—Permanent Resident
TDM—Trademark Owner
TRD—Trade Union
TRS—Trust
Please note: To change the legal type of a .CA domain during a transfer from another registrar, you must also submit the change_contact parameter..EU request parameters .EU registrations require just two contact types: owner and tech.
The admin and billing contacts are not required for .EU registrations and are ignored if submitted.
The owner and tech contact sets require the standard fields and values, plus specific values for the fields country and lang.
As of December 10, 2009, .EU supports IDNs.
The IDN name must be submitted in ACE (Punycode) encoding, and all characters in the name before it is converted to Punycode must conform to .EU requirements.
For more information on .EU IDNs, see https://www.eurid .eu/en/get-eu/domain-names-special-characters-idns
Tip: Individual .EU domain registrants can keep their name private in the WHOIS record by leaving the owner org_name field blank.
For .EU transfers, you must specify the domain's nameservers.
If no nameservers are provided, the domain name will be stripped of its existing nameservers and not have any nameservers.
Important: If org_name is not applicable, leave the org_name field blank, that is, do not enter na or none; otherwise the trade or transfer will fail.
Additional request parameters within the attributes associative array:
Parameter nameObligation
owner_confirm_address Required if:
reg_type = transfer The email address to which to send messages regarding a .EU transfer.
The email address provided is used for the current transfer only, and not for future messages.
Additional request parameters within the owner and tech associative arrays:
Parameter nameObligationDefinition/Value
country Required if:
reg_type = new To be eligible to register a .EU domain, you must have residency in one of the countries/regions designated by EURid, the .EU registry.
GB—United Kingdom (GB)
AX—Aland Islands Cyprus
DE—Germany
Estonia
Finland
Gibraltar
GP—Guadeloupe Hungary
Italy
Luxembourg
MQ—Martinique
NL—Netherlands Portugal
Sweden
Slovakia
AT—Austria
BE—Belgium
CY—
CZ—Czech Republic
DK—Denmark
EE—
ES—Spain
FI—
FR—France
GI—
GF—French Guyana
GR—Greece
HU—
IE—Ireland
IT—
LT—Lithuania
LU—
LV—Latvia
MT—Malta (including Gozo and Comino)
PL—Poland
PT—
RE—Reunion
SE—
SI—Slovenia
SK—
lang Required if:
reg_type = new The preferred language for use in the registration agreement and for dispute resolution.
cs—Czech
de—German
English
et—Estonian
French
it—Italian
lv—Latvian
nl—Dutch
Portuguese
Slovenian
da—Danish
el—Greek
en—
es—Spanish
fi—Finnish
fr—
hu—Hungarian
lt—Lithuanian
mt—Maltese
pl—Poland
pt—
sk—Slovak
sl—
sv—Swedish
.IT request parameters
Additional request parameters within the attributes associative array:
Parameter nameObligationDefinition/Value
change_contact Optional for
reg_type = transfer Used to change contact information during a transfer or after transfer completion.
0—Do not change contact set
1—Apply new contact set when transfer completes
Important: If change_contact = 1, then you must also include a tld_data associative array.
owner_confirm_address Required if:
reg_type = transfer The email address to which to send messages regarding a .IT transfer.
Note: The email address provided is used for the current transfer only, and not for future messages..MOBI request parameters
Additional request parameters for .MOBI
.MOBI applications use the sw_register command with the standard parameters.
Specific parameters and required values are described below.
Domain names can be registered for one to ten year terms.
Nameservers
You must submit the correct nameservers with your application.
If you are unsure which nameservers to submit with your application, submit the OpenSRS nameservers ns1.systemdns .com and ns2.systemdns .com.
Additional request parameters within the attributes associative array:
Parameter nameObligationDefinition/Value
period Required if:
reg_type = new The registration term (if application results in successful registration); may be 1 to 10 years.
reg_type Required The type of registration.
Allowed value is new..NAME request parameters
Additional request parameters within the attributes associative array:
Parameter nameObligationDefinition/Value
tld_data Optional for .NAME (if email bundle) An associative array containing TLD- specific data.
forwarding-email—For.NAME domains
* * *
Additional request parameters for registry premium names
Parameter nameObligationDefinition/Value
reg_type Required The type of registration.
Allowed value is new or transfer.
premium_price_to_verify Required Submits the premium domain price and verifies that it is the same as the list price.
If the submitted price does not match the Tucows list price, the command will fail.
Allowed value is the price for the premium domain, in the format nnn.nn .
* * *
Response parameters
🚧Asynchronous registry responses
The Reseller Agent (RSA) can respond with a 250 response_code, which indicates that the action was submitted for processing in an asynchronous registry.
When the registry's reply is received by OpenSRS, it is processed.
Performing a get userinfo command indicates if there is an action currently waiting on a domain.
Standard response parameters
ParameterValue
object DOMAIN
action REPLY
is_success Boolean 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.
Response attributes
If the request is successful, the attributes associative array may include the following:
ParameterObligationDefinition/Value
admin_email Optional Returns the admin email contact from the order.
async_reason Returned for asynchronous requests Indicates the reason that the request was asynchronous.
Allowed values are:
general—Order was submitted to an asynchronous registry.
has_claim—Registrant action required before order can complete.
is_gdpr_async—Orders for this TLD are processed asynchronously due to GDPR compliance.
cancelled_orders Optional A list of pending orders for this domain that are cancelled by the successful registration of the domain.
error Returned when an order fails.
A text description of the errors that occurred in a failed transaction.
forced_pending Returned if the order has been forced to pending queue.
Orders that cannot be processed (insufficient funds, domain already taken, and so on) are forced to the pending queue.
id Returned if is_success = 1 The ID of the order, which can be used in RWI queries.
queue_request_id Returned if the order has been queued.
The ID of the request as it appears in the queue.
registration_code Returned if is_success = 1 The registration code returned by the registry.
registration_text Returned if is_success = 1 The registration text returned by the registry.
transfer_id Returned if reg_type=transfer ID number of the transfer.
whois_privacy_state Returned if is_success = 1 Returns the state of WHOIS Privacy.
Allowed values are enabled, disabled, enabling (in process), or disabling (in process).
Domain registration examples
.COM, .NET, .ORG, .INFO, .BIZ, .NAME, .ME, .MOBI
Example 1
About this example:
This is a new domain name registration.
This registration creates a new user profile
No custom tech contact is set.
Custom nameservers are set.
WHOIS Privacy feature enabled at time of registration.
Parked Pages service activated (for qualifying TLDs).
User is requesting the domain to lock once it is registered.
Two pending orders are cancelled by the successful registration of this
RequestResponse
<?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="object">DOMAIN</item> <item key="action">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">0</item> <item key="domain">example.com </item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="f_whois_privacy">1</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="handle">process</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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">3</item> </dt_assoc> </item> </dt_array> </item> <item key="custom_tech_contact">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="domain_id">1532247</item> <item key="id">11820034</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
About this example:
This is a new domain name registration.
This registration is based on another domain (example.com ).
No custom tech contact is set.
DNS template is applied.
RequestResponse
<?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="object">DOMAIN</item> <item key="action">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">0</item> <item key="domain">example.com </item> <item key="reg_type">new</item> <item key="reg_domain">example.net </item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="f_whois_privacy">0</item> <item key="dns_template">example_template</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="handle">process</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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">3</item> </dt_assoc> </item> </dt_array> </item> <item key="custom_tech_contact">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="domain_id">1532248</item> <item key="id">11820036</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 3
About this example:
This is a new domain name registration.
No custom tech contact is set.
DNS is enabled but no records are defined.
RequestResponse
<?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="object">DOMAIN</item> <item key="action">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">0</item> <item key="domain">example.com </item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="f_whois_privacy">0</item> <item key="dns_template">*blank*</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="handle">process</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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="custom_nameservers">1</item> <item key="custom_tech_contact">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="domain_id">1532249</item> <item key="id">11820038</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.AERO
RequestResponse
<?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">sw_register</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="handle">process</item> <item key="reg_username">aaaa</item> <item key="reg_password">aaaa</item> <item key="auto_renew">0</item> <item key="link_domains">0</item> <item key="f_whois_privacy">1</item> <item key="f_lock_domain">1</item> <item key="custom_tech_contact">1</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">[email protected]</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">[email protected]</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">[email protected]</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> <item key="domain">example.aero </item> <item key="affiliate_id" /> <item key="period">1</item> <item key="reg_type">new</item> <item key="bulk_order">0</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> <item key="encoding_type" /> <item key="action">register</item> <item key="custom_nameservers">1</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="aero_ens_password">EnsPa55w0rd</item> <item key="aero_ens_id">EnsId</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_code">250</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully submitted</item> <item key="rr_id">13689</item> <item key="transaction_id">2012-05-16 09:10:36 1250 101</item> <item key="domain_id">707819</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully submitted</item> <item key="admin_email">[email protected]</item> <item key="registration_code">300</item> <item key="waiting_request">sw_register</item> <item key="waiting_requests_no">1</item> <item key="id">477659</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.ASIA
About this example:
This is a new domain name registration
The required ASIA-specific data is contained in the ced_info associative
array.
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">new</item> <item key="reg_username">exampleuser</item> <item key="reg_password">changeit123</item> <item key="domain">example.asia </item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </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">[email protected]</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">[email protected]</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">[email protected]</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> <item key="tld_data"> <dt_assoc> <item key="ced_info"> <dt_assoc> <item key="locality_country">JP</item> <item key="legal_entity_type">naturalPerson</item> <item key="id_type">passport</item> <item key="id_number">12345</item> <item key="contact_type">admin</item> </dt_assoc> </item> </dt_assoc> </item> <item key="period">1</item> <item key="custom_nameservers">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed.
TLD not supported for whois privacy service.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed.
TLD not supported for whois privacy service.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="domain_id">1521435</item> <item key="id">11541235</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.AU
📘Note:
.AU registrations require two contact types: owner and tech.
RequestResponse2nd Level .AU
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="reg_type">new</item> <item key="domain">example.com .au</item> <item key="period">2</item> <item key="link_domains">0</item> <item key="f_lock_domain">1</item> <item key="auto_renew">0</item> <item key="reg_domain" /> <item key="reg_username">user123</item> <item key="reg_password">changeit</item> <item key="tld_data"> <dt_assoc> <item key="au_registrant_info"> <dt_assoc> <item key="registrant_name">Registered Company Name Ltd</item> <item key="registrant_id_type">ABN</item> <item key="policy_reason">1</item> <item key="registrant_id">99 999 999 999</item> <item key="eligibility_type">Registered</item> <item key="eligibility_name">Don Marshall</item> <item key="eligibility_id_type">ACN</item> <item key="eligibility_id">99999999</item> </dt_assoc> </item> </dt_assoc> </item> <item key="custom_tech_contact">1</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">[email protected]</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">[email protected]</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">[email protected]</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> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">OK</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="admin_email">[email protected]</item> <item key="registration_text">Domain registration successfully completed Domain successfully locked.</item> <item key="registration_code">200</item> <item key="id">417011</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="reg_type">new</item> <item key="domain">example.au </item> <item key="period">2</item> <item key="link_domains">0</item> <item key="f_lock_domain">1</item> <item key="auto_renew">0</item> <item key="reg_domain" /> <item key="reg_username">user123</item> <item key="reg_password">changeit</item> <item key="tld_data"> <dt_assoc> <item key="au_registrant_info"> <dt_assoc> <item key="registrant_name">Registered Company Name Ltd</item> <item key="registrant_id_type">ABN</item> <item key="policy_reason">1</item> <item key="registrant_id">99 999 999 999</item> <item key="eligibility_type">Registered</item> <item key="eligibility_name">Don Marshall</item> <item key="eligibility_id_type">ACN</item> <item key="eligibility_id">99999999</item> <item key="priority_contact_id">99999999</item> <item key="priority_auth_info">99999999</item> </dt_assoc> </item> </dt_assoc> </item> <item key="custom_tech_contact">1</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">[email protected]</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">[email protected]</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">[email protected]</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> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.CA
About this example:
This is a new domain name registration.
Neither custom tech nor custom nameservers are supplied.
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="registrant_extra_info"> <dt_assoc> <item key="legal_type">CCT</item> </dt_assoc> </item> <item key="domain">example.ca </item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="first_name">Owen</item> <item key="last_name">Ottway</item> <item key="address1">32 Oak Street</item> <item key="address2">Suite 500</item> <item key="address3">Owner</item> <item key="city">SomeCity</item> <item key="postal_code">M6K3M1</item> <item key="state">ON</item> <item key="country">CA</item> <item key="phone">+1.4165550123x1902 </item> <item key="fax">+1.4165550124 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="admin"> <dt_assoc> <item key="first_name">Owen</item> <item key="last_name">Ottway</item> <item key="address1">32 Oak Street</item> <item key="address2">Suite 500</item> <item key="address3">Owner</item> <item key="city">SomeCity</item> <item key="postal_code">M6K3M1</item> <item key="state">ON</item> <item key="country">CA</item> <item key="phone">+1.4165550123x1902 </item> <item key="fax">+1.4165550124 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> <item key="period">1</item> <item key="reg_domain" /> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="sortorder">3</item> <item key="name">ns3.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed.
Whois Privacy successfully enabled.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed.
Whois Privacy successfully enabled.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="domain_id">1521434</item> <item key="id">11541234</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.COM.BR
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="tld_data"> <dt_assoc> <item key="br_register_number">123.456 .789-00</item> </dt_assoc> </item> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="domain">example.com .br</item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="country">BR</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">SP</item> <item key="email">[email protected]</item> <item key="city">Sao Paulo</item> <item key="postal_code">01037-010</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">BR</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">SP</item> <item key="email">[email protected]</item> <item key="city">Sao Paulo</item> <item key="postal_code">01037-010</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="billing"> <dt_assoc> <item key="country">BR</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">SP</item> <item key="email">[email protected]</item> <item key="city">Sao Paulo</item> <item key="postal_code">01037-010</item> <item key="fax">+1.4165550124 </item> <item key="address1">32 Oak Street</item> <item key="first_name">Owen</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> <item key="period">1</item> <item key="reg_domain" /> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="sortorder">3</item> <item key="name">ns3.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_code">250</item> <item key="is_success">1</item> <item key="rr_id">6466</item> <item key="response_text">Domain registration successfully submitted</item> <item key="transaction_id">2011-04-14 18:12:39 25830 101</item> <item key="domain_id">256808</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully submitted</item> <item key="admin_email">[email protected]</item> <item key="registration_code">300</item> <item key="waiting_requests_no">1</item> <item key="waiting_request">sw_register</item> <item key="id">296660</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.DE
📘Note:
Submit .DE zone contact information as contact type billing.
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="domain">example.de </item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="country">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </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">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </item> <item key="address1">32 Oak Street</item> <item key="first_name">Owen</item> </dt_assoc> </item> <item key="billing"> <dt_assoc> <item key="country">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </item> <item key="address1">32 Oak Street</item> <item key="first_name">Owen</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> <item key="period">1</item> <item key="reg_domain" /> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="sortorder">3</item> <item key="name">ns3.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="id">607737</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.DK
RequestResponse
<?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="object">DOMAIN</item> <item key="action">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">0</item> <item key="domain">example.dk </item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="f_whois_privacy">0</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="handle">process</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="registrant_vat_id">123456789</item> <item key="registrant_type">organization</item> </dt_assoc> </item> </dt_assoc> </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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">3</item> </dt_assoc> </item> </dt_array> </item> <item key="custom_tech_contact">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_code">250</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully submitted</item> <item key="rr_id">74063</item> <item key="transaction_id">2016-07-27 05:52:40 7393 101</item> <item key="domain_id">1521429</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully submitted</item> <item key="registration_code">300</item> <item key="async_reason">general</item> <item key="admin_email">[email protected]</item> <item key="domain_id">1521429</item> <item key="waiting_request">sw_register</item> <item key="waiting_requests_no">1</item> <item key="id">11540663</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.ES
RequestRespnse
<?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="object">DOMAIN</item> <item key="action">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">0</item> <item key="domain">example.es </item> <item key="reg_type">new</item> <item key="reg_username">testuser123</item> <item key="reg_password">changeit123</item> <item key="f_whois_privacy">0</item> <item key="custom_nameservers">1</item> <item key="handle">process</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="es_id_type">nie</item> <item key="es_id_number">X1234567L</item> </dt_assoc> </item> </dt_assoc> </item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="country">ES</item> <item key="org_name">Example Inc.</item> <item key="phone">+34.123456789 </item> <item key="last_name">Smith</item> <item key="state">Madrid</item> <item key="email">[email protected]</item> <item key="city">Madrid</item> <item key="postal_code">123456</item> <item key="address1">123 Main St</item> <item key="first_name">Bob</item> </dt_assoc> </item> <item key="admin"> <dt_assoc> <item key="country">ES</item> <item key="org_name">Example Inc.</item> <item key="phone">+34.123456789 </item> <item key="last_name">Smith</item> <item key="state">Madrid</item> <item key="email">[email protected]</item> <item key="city">Madrid</item> <item key="postal_code">123456</item> <item key="address1">123 Main St</item> <item key="first_name">Bob</item> </dt_assoc> </item> <item key="billing"> <dt_assoc> <item key="country">ES</item> <item key="org_name">Example Inc.</item> <item key="phone">+34.123456789 </item> <item key="last_name">Smith</item> <item key="state">Madrid</item> <item key="email">[email protected]</item> <item key="city">Madrid</item> <item key="postal_code">123456</item> <item key="address1">123 Main St</item> <item key="first_name">Bob</item> </dt_assoc> </item> </dt_assoc> </item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> </dt_array> </item> <item key="custom_tech_contact">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_text">Domain registration successfully completed.
TLD not supported for whois privacy service.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="admin_email">[email protected]</item> <item key="registration_text">Domain registration successfully completed.
TLD not supported for whois privacy service.</item> <item key="cancelled_orders"> <dt_array> <item key="0">1986895</item> </dt_array> </item> <item key="registration_code">200</item> <item key="domain_id">1014179</item> <item key="id">1986896</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
.EU
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="domain">example.eu </item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="country">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </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">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </item> <item key="address1">32 Oak Street</item> <item key="first_name">Owen</item> </dt_assoc> </item> <item key="billing"> <dt_assoc> <item key="country">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </item> <item key="address1">32 Oak Street</item> <item key="first_name">Owen</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> <item key="period">1</item> <item key="reg_domain" /> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="sortorder">3</item> <item key="name">ns3.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed.
TLD not supported for whois privacy service.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed.
TLD not supported for whois privacy service.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="domain_id">1521438</item> <item key="id">11541241</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.FR
RequestResponse
<?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="object">DOMAIN</item> <item key="action">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">0</item> <item key="domain">testdomain.fr </item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="f_whois_privacy">0</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="handle">process</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="registrant_type">organization</item> </dt_assoc> </item> </dt_assoc> </item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="country">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </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">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </item> <item key="address1">32 Oak Street</item> <item key="first_name">Owen</item> </dt_assoc> </item> <item key="billing"> <dt_assoc> <item key="country">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </item> <item key="address1">32 Oak Street</item> <item key="first_name">Owen</item> </dt_assoc> </item> </dt_assoc> </item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">3</item> </dt_assoc> </item> </dt_array> </item> <item key="custom_tech_contact">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Domain registration successfully completed</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="id">457700</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.HU
Request
RequestResponse
<?xml version='1.0 ' encoding='UTF-8' standalone='no'?> <!DOCTYPE OPS_envelope SYSTEM 'ops.dtd '><OPS_envelope> <OPS_envelope> <header> <version>0.9 </version> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="f_lock_domain">1</item> <item key="custom_tech_contact">1</item> <item key="auto_renew">1</item> <item key="reg_type">new</item> <item key="reg_username">zoltan</item> <item key="domain">example.hu </item> <item key="contact_set"> <dt_assoc> <item key="admin"> <dt_assoc> <item key="first_name">Daniel</item> <item key="last_name">Nagy</item> <item key="address1">Bem rakpart 49</item> <item key="address2" /> <item key="address3" /> <item key="city">Budapest</item> <item key="state" /> <item key="postal_code">H-1037</item> <item key="country">HU</item> <item key="org_name">Varga Szoftver</item> <item key="phone">+1.3615550123 </item> <item key="fax">+1.3615553653 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="owner"> <dt_assoc> <item key="first_name">Zoltan</item> <item key="last_name">Varga</item> <item key="org_name">Varga Szoftver</item> <item key="address1">Bem rakpart 49</item> <item key="address2" /> <item key="address3" /> <item key="city">Budapest</item> <item key="state" /> <item key="postal_code">H-1037</item> <item key="country">HU</item> <item key="fax">+1.3615553651 </item> <item key="phone">+1.3615550124 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="first_name">Paul</item> <item key="last_name">Farkas</item> <item key="org_name">Varga Szoftver</item> <item key="address1">Bem rakpart 49</item> <item key="address2" /> <item key="address3" /> <item key="city">Budapest</item> <item key="state" /> <item key="postal_code">H-1037</item> <item key="country">HU</item> <item key="fax">+1.3615553652 </item> <item key="phone">+1.3615550125 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="f_whois_privacy">0</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="sortorder">3</item> <item key="name">ns3.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> <item key="link_domains">0</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="registrant_vat_id">12345678</item> <item key="registrant_type">organization</item> </dt_assoc> </item> </dt_assoc> </item> <item key="period">1</item> <item key="reg_password">changeit</item> <item key="bulk_order">0</item> <item key="reg_domain" /> <item key="custom_nameservers">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="object">DOMAIN</item> <item key="response_code">250</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully submitted</item> <item key="domain_id">709245</item> <item key="transaction_id">2012-06-19 13:49:57 1277 101</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully submitted</item> <item key="admin_email">[email protected]</item> <item key="registration_code">300</item> <item key="waiting_request">sw_register</item> <item key="waiting_requests_no">1</item> <item key="id">480990</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.INFO
About this example:
This is a new domain name registration.
It is based on another domain (example-nsi.com ).
There is a custom tech contact.
There are no custom nameservers (notice the presence of the empty
nameserver_list array, which is permitted).
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew" /> <item key="link_domains">0</item> <item key="reg_type">new</item> <item key="reg_username">testuser123</item> <item key="reg_password">changeit123</item> <item key="domain">example.info </item> <item key="reg_domain">example-nsi.com </item> <item key="f_lock_domain">0</item> <item key="custom_nameservers">0</item> <item key="affiliate_id" /> <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">[email protected]</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">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">[email protected]</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="billing"> <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">[email protected]</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> </dt_assoc> </item> </dt_assoc> </item> <item key="period">2</item> <item key="nameserver_list"> <dt_array /> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="domain_id">1528551</item> <item key="id">11705848</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.IT
Example 1
This example registers a domain to a person (entity_code=1).
In this case, the admin contact does not need to be defined as it must be the same as the owner; if the admin contact is specified, it is ignored.
Similarly, org_name is not required in this instance, and if specified, is ignored.
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="reg_username">testuser123</item> <item key="tld_data"> <dt_assoc> <item key="it_registrant_info"> <dt_assoc> <item key="nationality_code">IT</item> <item key="reg_code">SGLMRA80A01H501E</item> <item key="entity_type">1</item> </dt_assoc> </item> </dt_assoc> </item> <item key="custom_tech_contact">1</item> <item key="reg_password">changeit123</item> <item key="period">1</item> <item key="f_whois_privacy">0</item> <item key="link_domains">0</item> <item key="custom_nameservers">1</item> <item key="f_lock_domain">0</item> <item key="domain">example031.it </item> <item key="reg_type">new</item> <item key="reg_domain"></item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="first_name">Mario</item> <item key="last_name">Segale</item> <item key="org_name">Mario Segale</item> <item key="address1">Via del Campidoglio, 1</item> <item key="city">Rome</item> <item key="state">RM</item> <item key="country">IT</item> <item key="postal_code">00123</item> <item key="phone">+39.0612345678 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="first_name">Frank</item> <item key="last_name">Mosser</item> <item key="org_name">Tech Orgname</item> <item key="address1">Piazza dei Giudici 1</item> <item key="city">Firenze</item> <item key="state">FI</item> <item key="country">IT</item> <item key="postal_code">50123</item> <item key="phone">+39.0551234567 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">3</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="id">214946</item> </dt_assoc> </item> </dt_assoc> </data_block> </body>` </OPS_envelope>
Example 2
This example registers a domain to an Italian company (entity_type = 2).
In this case, the admin contact is required.
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="reg_username">testuser123</item> <item key="tld_data"> <dt_assoc> <item key="it_registrant_info"> <dt_assoc> <item key="nationality_code">IT</item> <item key="reg_code">06612345675</item> <item key="entity_type">2</item> </dt_assoc> </item> </dt_assoc> </item> <item key="reg_password">changeit123</item> <item key="period">1</item> <item key="f_whois_privacy">0</item> <item key="link_domains">0</item> <item key="custom_nameservers">1</item> <item key="f_lock_domain">0</item> <item key="domain">example032.it </item> <item key="reg_type">new</item> <item key="reg_domain"></item> <item key="custom_tech_contact">1</item> <item key="contact_set"> <dt_assoc> <item key="admin"> <dt_assoc> <item key="first_name">Mario</item> <item key="last_name">Segale</item> <item key="org_name">Mario Segale</item> <item key="address1">Via del Campidoglio, 1</item> <item key="city">Rome</item> <item key="state">RM</item> <item key="country">IT</item> <item key="postal_code">00123</item> <item key="phone">+39.0612345678 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="owner"> <dt_assoc> <item key="first_name">Franco</item> <item key="last_name">Pendenza</item> <item key="org_name">Aumento Inc</item> <item key="address1">Via del Inclinazione, 1</item> <item key="city">Pisa</item> <item key="state">PI</item> <item key="country">IT</item> <item key="postal_code">52123</item> <item key="phone">+39.0501234567 </item> <item key="email">[email protected]</item> <item key="fax">+39.0501234568 </item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="first_name">Frank</item> <item key="last_name">Mosser</item> <item key="org_name">Tech Orgname</item> <item key="address1">Piazza dei Giudici 1</item> <item key="city">Firenze</item> <item key="state">FI</item> <item key="country">IT</item> <item key="postal_code">50123</item> <item key="phone">+39.0551234567 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">3</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_text">Domain registration successfully completed</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="id">214947</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.LAW .ABOGADO
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">sw_register</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="handle">process</item> <item key="auto_renew"/> <item key="link_domains">0</item> <item key="reg_domain"/> <item key="f_lock_domain">1</item> <item key="f_whois_privacy">1</item> <item key="f_parkp">Y</item> <item key="domain">example.law </item> <item key="affiliate_id"/> <item key="period">1</item> <item key="reg_type">new</item> <item key="comments">Sample comment</item> <item key="reg_username">aaaa</item> <item key="custom_tech_contact">0</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">[email protected]</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">[email protected]</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">[email protected]</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> </item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="qli_accreditation_id">exampleid</item> <item key="qli_accreditation_body">examplebody</item> <item key="qli_jurisdiction_country">CA</item> <item key="qli_jurisdiction_state">examplestate</item> <item key="qli_accreditation_year">1999</item> </dt_assoc> </item> </dt_assoc> </item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> <item key="reg_password">examplepassword</item> <item key="encoding_type"/> <item key="custom_nameservers">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.JOBS
RequestResponse
<?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="object">DOMAIN</item> <item key="action">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">0</item> <item key="domain">example.jobs </item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="f_whois_privacy">0</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="handle">process</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="jobs_admin_type">Yes</item> <item key="jobs_industry_type">Supply Chain</item> <item key="jobs_title">HR Generalist</item> <item key="jobs_association_member">Yes</item> <item key="jobs_website">http://www.example .com</item> </dt_assoc> </item> </dt_assoc> </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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">3</item> </dt_assoc> </item> </dt_array> </item> <item key="custom_tech_contact">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed.
Domain successfully locked.
Whois Privacy successfully enabled.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed.
Domain successfully locked.
Whois Privacy successfully enabled.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="domain_id">822732</item> <item key="id">730050</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.NAME
The registrant is requesting a forwarding email address with their domain.
RequestResponse
<?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="object">DOMAIN</item> <item key="action">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">0</item> <item key="domain">my.example .name</item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="f_whois_privacy">0</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="handle">process</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="forwarding_email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">3</item> </dt_assoc> </item> </dt_array> </item> <item key="custom_tech_contact">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Domain registration successfully completed</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed</item> <item key="registration_code">200</item> <item key="id">23995</item> <item key="admin_email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.PM, .RE, .TF, .WF, .YT
RequestResponse
<?xml version='1.0 ' encoding="UTF-8" standalone="no"?> <!DOCTYPE OPS_envelope SYSTEM "ops.dtd "><OPS_envelope> <OPS_envelope> <header> <version>0.9 </version> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="f_lock_domain">1</item> <item key="custom_tech_contact">1</item> <item key="auto_renew">1</item> <item key="reg_type">new</item> <item key="reg_username">lafleur</item> <item key="domain">example.pm </item> <item key="contact_set"> <dt_assoc> <item key="admin"> <dt_assoc> <item key="first_name">Marie</item> <item key="last_name">LaFleur</item> <item key="org_name">French Impressions</item> <item key="address1">13 Rue Daze</item> <item key="address2" /> <item key="address3" /> <item key="city">Paris</item> <item key="state" /> <item key="postal_code">75002</item> <item key="country">FR</item> <item key="fax">+1.3365550125 </item> <item key="phone">+1.3365551213 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="owner"> <dt_assoc> <item key="first_name">Henri</item> <item key="last_name">LaFleur</item> <item key="org_name">French Impressions</item> <item key="address1">13 Rue Daze</item> <item key="address2" /> <item key="address3" /> <item key="city">Paris</item> <item key="state" /> <item key="postal_code">75002</item> <item key="country">FR</item> <item key="phone">+1.3365551212 </item> <item key="fax">+1.3365550124 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="first_name">Pierre</item> <item key="last_name">LaFleur</item> <item key="org_name">French Impressions</item> <item key="address1">13 Rue Daze</item> <item key="address2" /> <item key="address3" /> <item key="city">Paris</item> <item key="state" /> <item key="postal_code">75002</item> <item key="country">FR</item> <item key="phone">+1.3365551214 </item> <item key="fax">+1.3365550125 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="f_whois_privacy">0</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="sortorder">3</item> <item key="name">ns3.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> <item key="link_domains">0</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="registration_number" /> <item key="registrant_vat_id">1X345678901</item> <item key="registrant_type">organization</item> </dt_assoc> </item> </dt_assoc> </item> <item key="period">1</item> <item key="reg_password">changeit</item> <item key="bulk_order">0</item> <item key="reg_domain" /> <item key="custom_nameservers">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="id">481007</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.PRO
RequestResponse
<?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="object">DOMAIN</item> <item key="action">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="auto_renew">0</item> <item key="domain">example.pro </item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="f_whois_privacy">0</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="handle">process</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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="name">ns1.systemdns .com</item> <item key="sortorder">1</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="name">ns2.systemdns .com</item> <item key="sortorder">2</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="name">ns3.systemdns .com</item> <item key="sortorder">3</item> </dt_assoc> </item> </dt_array> </item> <item key="custom_tech_contact">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="id">454197</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.RU
Request
<?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">sw_register</item> <item key="object">domain</item> <item key="attributes"> <dt_assoc> <item key="handle">process</item> <item key="reg_username">fldjfisjfsa</item> <item key="reg_password">fsdfdkj123sfsa</item> <item key="auto_renew">0</item> <item key="link_domains">0</item> <item key="f_whois_privacy">1</item> <item key="f_lock_domain">1</item> <item key="custom_tech_contact">1</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">[email protected]</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> </dt_assoc> </item> <item key="domain">aug8test.ru </item> <item key="affiliate_id" /> <item key="period">1</item> <item key="reg_type">new</item> <item key="bulk_order">0</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> <item key="encoding_type" /> <item key="action">register</item> <item key="custom_nameservers">1</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="registrant_type">Individual</item> <item key="date_of_birth">2001-05-15</item> <item key="id_card_authority">Govt</item> <item key="id_card_issue_date">2001-05-15</item> <item key="id_card_number">1234567890</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.SCOT
RequestResponse
<?xml version="1.0 " encoding="UTF-8"?> <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">sw_register</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">1</item> <item key="reg_type">new</item> <item key="reg_username">testing</item> <item key="reg_password">testing</item> <item key="reg_domain" /> <item key="bulk_order">0</item> <item key="domain">tucows-d3c0e5a456304.scot </item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="country">CA</item> <item key="address3">Mailbox 1</item> <item key="org_name">Tucows</item> <item key="phone">+1.4165350124 </item> <item key="state">ON</item> <item key="last_name">ksjlIqWq</item> <item key="address2">Unit 1</item> <item key="email">[email protected]</item> <item key="city">Toronto</item> <item key="postal_code">M6H2E9</item> <item key="fax">+1.4165350124 </item> <item key="title">QA Tester</item> <item key="address1">96 Mowat Ave</item> <item key="first_name">SUJTybEN</item> </dt_assoc> </item> <item key="admin"> <dt_assoc> <item key="country">CA</item> <item key="address3">Mailbox 1</item> <item key="org_name">Tucows</item> <item key="phone">+1.4165350124 </item> <item key="state">ON</item> <item key="last_name">defaultlastname</item> <item key="address2">Unit 1</item> <item key="email">[email protected]</item> <item key="city">Toronto</item> <item key="postal_code">M6H2E9</item> <item key="fax">+1.4165350124 </item> <item key="title">QA Tester</item> <item key="address1">96 Mowat Ave</item> <item key="first_name">defaultfirstname</item> </dt_assoc> </item> <item key="billing"> <dt_assoc> <item key="country">CA</item> <item key="address3">Mailbox 1</item> <item key="org_name">Tucows</item> <item key="phone">+1.4165350124 </item> <item key="state">ON</item> <item key="last_name">defaultlastname</item> <item key="address2">Unit 1</item> <item key="email">[email protected]</item> <item key="city">Toronto</item> <item key="postal_code">M6H2E9</item> <item key="fax">+1.4165350124 </item> <item key="title">QA Tester</item> <item key="address1">96 Mowat Ave</item> <item key="first_name">defaultfirstname</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="country">CA</item> <item key="address3">Mailbox 1</item> <item key="org_name">Tucows</item> <item key="phone">+1.4165350124 </item> <item key="state">ON</item> <item key="last_name">defaultlastname</item> <item key="address2">Unit 1</item> <item key="email">[email protected]</item> <item key="city">Toronto</item> <item key="postal_code">M6H2E9</item> <item key="fax">+1.4165350124 </item> <item key="title">QA Tester</item> <item key="address1">96 Mowat Ave</item> <item key="first_name">defaultfirstname</item> </dt_assoc> </item> </dt_assoc> </item> <item key="period">1</item> <item key="link_domains">0</item> <item key="handle">process</item> <item key="auto_renew">0</item> <item key="f_lock_domain">1</item> <item key="f_whois_privacy">1</item> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.qa .systemdns.com </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.qa .systemdns.com </item> </dt_assoc> </item> </dt_array> </item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="intended_use">the domain will support trade and development in Scotland </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed.
Domain successfully locked.
Whois Privacy successfully enabled.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed.
Domain successfully locked.
Whois Privacy successfully enabled.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="domain_id">822732</item> <item key="id">730050</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.UK
Request
<?xml version=“1.0 " encoding=“UTF-8” standalone=‘yes’?> <!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’>SW_REGISTER</item> <item key=‘object’>DOMAIN</item> <item key=‘attributes’> <dt_assoc> <item key=‘reg_type’>new</item> <item key=‘domain’>mydomain.co .uk</item> <item key=‘period’>1</item> <item key=‘handle’>process</item> <item key=‘auto_renew’>0</item> <item key=‘reg_username’>user123</item> <item key=‘reg_password’>changeme123</item> <item key=“tld_data”> <dt_assoc> <item key=“registrant_extra_info”> <dt_assoc> <item key=“registrant_type”>LTD</item> <item key=“registration_number”>85214792</item> <item key=“trading_name”>OpenSRS UK</item> </dt_assoc> </item> </dt_assoc> </item> <item key=‘contact_set’> <dt_assoc> <item key=‘owner’> <dt_assoc> <item key=‘first_name’>Joe</item> <item key=‘last_name’>Tester</item> <item key=‘phone’>+1.5555111212 </item> <item key=‘fax’></item> <item key=‘email’>[email protected]</item> <item key=‘org_name’>Myorg Inc.</item> <item key=‘address1’>99 Myplace Ave</item> <item key=‘address2’></item> <item key=‘address3’></item> <item key=‘city’>Toronto</item> <item key=‘state’>ON</item> <item key=‘country’>CA</item> <item key=‘postal_code’>M6L6G1</item> </dt_assoc> </item> <item key=“admin”> <dt_assoc> <item key=‘first_name’>Joe</item> <item key=‘last_name’>Tester</item> <item key=‘phone’>+1.5555111212 </item> <item key=‘fax’></item> <item key=‘email’>[email protected]</item> <item key=‘org_name’>Myorg Inc.</item> <item key=‘address1’>99 Myplace Ave</item> <item key=‘address2’></item> <item key=‘address3’></item> <item key=‘city’>Toronto</item> <item key=‘state’>ON</item> <item key=‘country’>CA</item> <item key=‘postal_code’>M6L6G1</item> </dt_assoc> </item> </dt_assoc> </item> <item key=‘custom_nameservers’>1</item> <item key=‘nameserver_list’> <dt_array> <item key=‘0’> <dt_assoc> <item key=‘sortorder’>1</item> <item key=‘name’>ns1.systemdns .com</item> </dt_assoc> </item> <item key=‘1’> <dt_assoc> <item key=‘sortorder’>2</item> <item key=‘name’>ns2.systemdns .com</item> </dt_assoc> </item> <item key=‘2’> <dt_assoc> <item key=‘sortorder’>3</item> <item key=‘name’>ns3.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.US
About this example:
This is a new domain name registration
This creates a new user profile
There is no custom tech contact
Custom nameservers are set
The additional US-specific data is contained in the 'tld_data' sub- associative array.
'nexus' itself is also an associative array with three items.
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="domain">example.us </item> <item key="tld_data"> <dt_assoc> <item key="nexus"> <dt_assoc> <item key="category">C11</item> <item key="app_purpose">P3</item> </dt_assoc> </item> </dt_assoc> </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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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"> <item key="country">US</item> <item key="address3">Billing</item> <item key="org_name">Example Inc.</item> <item key="phone">+1.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="link_domains">0</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Domain registration successfully completed.
TLD not supported for whois privacy service.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Domain registration successfully completed.
TLD not supported for whois privacy service.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="domain_id">1531599</item> <item key="id">11791175</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.XXX
Example 1
This example registers a domain for a registrant who is already a verified member of the XXX Sponsored Community.
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="domain">example.xxx </item> <item key="tld_data"> <dt_assoc> <item key="ipr_data"> <dt_assoc> <item key="icm_membership_id">IXTEST0000000001</item> </dt_assoc> </item> </dt_assoc> </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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="link_domains">0</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">0</item> <item key="response_text">Domain registration successfully completed.
Domain successfully locked.</item> <item key="attributes"> <dt_assoc> <item key="admin_email">[email protected]</item> <item key="id">457626</item> <item key="registration_code">200</item> <item key="registration_text">Domain registration successfully completed.
Domain successfully locked.</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
This example registers a domain to a registrant who wants to register the domain name, but does not want it to resolve.
This registrant is not currently a member of the Sponsored Community.
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="domain">example.xxx </item> <item key="tld_data"> <dt_assoc> <item key="ipr_data"> <dt_assoc> <item key="ipr_non_resolver">1</item> </dt_assoc> </item> </dt_assoc> </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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="link_domains">0</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">0</item> <item key="response_text">Domain registration successfully completed.
Domain successfully locked.</item> <item key="attributes"> <dt_assoc> <item key="admin_email">[email protected]</item> <item key="id">256841</item> <item key="registration_code">200</item> <item key="registration_text">Domain registration successfully completed.
Domain successfully locked.</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
New gTLD during Sunrise period
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="domain">example.shop </item> <item key="tld_data"> <dt_assoc> <item key="trademark_smd"> Trademark SMD:Marks: smdID: 00000096381377086406165-1 U-labels: sunrise-test notBefore: 2013-08-21 14:00:06 notAfter: 2015-07-01 00:00:00 - ----BEGIN ENCODED SMD- ---- <?xml version="1.0" encoding="UTF-8"?>
<smd:signedMark xmlns:smd="urn:ietf:params:xml:ns:signedMark-1.0" id="_4b98c338-7f01-42ac-b421-4149aed7bab2">
  <smd:id>000000963c338-7f01-42ac-b421-4149aed7bab2">
  <smd:id>81377086406165-1</smd:id>
  <smd:issuerInfo issuerID="1">
    <smd:org>Deloitte</smd:org>
    <smd:email>betmchsmd  <smd:org>Deloitte</smd:org>
    <smd:email>@deloitte.be</smd:email>
  </smd:issuerInfo>
  <smd:notBeloitte.be</smd:email>fore>2013-08-21T12:00:06.165Z</smd:notBefore>
  <smd:notAe>2013-08-21T12:00:06.165Z</smd:notBefore>fter>2015-06-30T22:00:00.000Z</smd:notAfter>
  <mark:mark xmlns:mark="urn:ietf:params:xml:ns:mark-1.0">
    <mark:trademark>
      <mark:id>00052513764049681376404968-1</mark:id>
      <mark:markName>TUCOWS</mark:markName>
     :id>
      <mark:markName>TUCOWS</mark:markName> <mark:holder entitlement="owner">
        <mark:org>TUCOWS (DELAWARE) INC.</mark:org>
        <mark:addr>
          <mark:street>1209 ORANGE STREET CORPORATION TRUST CENTER</mark:street>
          <mark:city>WILMINGTON</mark:city>
          <mark:sp>DELAWARE</mark:sp>
          <mark:pc>19801</mark:pc>
          <mark:cc>US</mark:cc>
     >19801</mark:pc>
          <mark:cc>US</mark:cc>   </mark:addr>
      </mark:holder>
      <mark:contact </mark:addr>
      </mark:holder>type="agent">
        <mark:name>Alexander Schwertner</mae="agent">
        <mark:name>rk:name>
        <mark:org>EPAG Domainservices GmbH</markname>
        <mark:org>:org>
        <mark:addr>
          <mark:street>Rheinallee 3</mark:street>
          <mark:city>Bonn</mark:city>
3</mark:street>          <mark:sp>NRW</mark:sp>
          <mark:pc>53173</mark:pc>
          <mark:cc>DE</mark:cc>
        </markark:pc>
          <mark:cc>DE</mark:cc>:addr>
        <mark:voice>+49.2283296840</mark:voice>
  dr>
        <mark:voice>+49.2283296840</mark:voice>      <mark:email>registry-relations@epag.de</mark:email>
      </mark:contact>
      <mark:jurisdiction>US</mark:    </mark:contact>
      <mark:jurisdiction>jurisdiction>
      <mark:class>42</mark:class>
      <mark:label>tucows</mark:label>
      <mark:goodsAndServiceslabel>>IC 042. US 100 101. G &amp; S: computer software information services, namely, information regarding computer software related to a global computer network, offered via a global computer network. FIRST USE: 19940800. FIRST USE IN COMMERCE: 19940800</mark:goodsAndServices>
      <markCOMMERCE: 19940800</mark:goodsAndServices>:regNum>2247196</mark:regNum>
      <mark:regDate>1999-05-24T22:00:00.000Z</mark:regDate>
    </mark:trademark>
  T22:00:00.000Z</mark:regDate>
    </mark:trademark></mark:mark>
<ds:Signature xmlns:ds="http://www.w3.org/20ark:mark>00/09/xmldsig#" Id="_a405d790-32fa-4b2b-8690-e92bc367b004"><ds:SignedInfo><ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/><ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/><ds:Reference URI="#_4b98c338-7f01-42ac-b421-414256"/>9aed7bab2"><ds:Transforms><ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/><ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/></ds:Transforms><ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/><ds:DigestValue>BNDoB2KEB.org/2001/04/xmlenc#sha256"/><ds:DigestValue>P/CPfGazFe6EfJm6ieIAuVxX3cL10fuXA8=</ds:DigestValue></ds:Reference><ds:Reference URI="#_1d9d023e-3fb5-4012-bb11-7bbcef01e7cd"><ds:Transforms><ds:Transform Algorithm="http:f01e7cd"><ds:Transforms>//www.w3.org/2001/10/xml-exc-c14n#"/></ds:Transforms><ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/><ds:DigestValue>lvCgBtPdRP2uDYGNeCHj1xZJbaRUp9m8256"/>znJKhM9KJjA=</ds:DigestValue></ds:Reference></ds:SignedInfo><ds:SignatureValue Id="_62f708ce-2c9a-4f30-9858-074935fa5ba9">iL3iRgBiTMQ1fj3YOawTVICtifbDLOm/Lu61zPOb9NGa6QOsHI1YvpzH5XDBz7WQqVfd2yWEOuaQ
PNR6cAHGOxtsC6C+UG/xRah3bgQL4Nl/qr6IPNwwPvcmTYXa0HR5z2DW5RTlvTcgHB09CVxzx9JC
0TgV8iTOvnjAxVz91zvRyuA4PXov/0h0Jr86kQyYxpjvIMzxcZIoVaqWYeckpjTd96fxgLhACFaP
9bEP2FJL9xBrwJu827lwWdFRFZba/fJIQQ9P27I8ieTGoES0851fIcMPtfr8fBFoDsNWnPBGYJF6
yNP/44J3MpfSzJp0oQsDns4/iSce5KllGG+w3Q==</ds:SignatureValue><ds:KeyInfo Id="_1d9d023e-3fb5-4012-bb11-7bbcef01e7cd"><ds:X509Data><ds:X509Cert3fb5-4012-bb11-7bbcef01e7cd"><ds:X509Data>ificate>MIIFNTCCBB2gAwIBAgIhAJNCMqhNjz3cXVJPj7yvcZvro1FKQR+dTC6tXazem5g/MA0GCSqGSIb3
DQEBCwUAMHYxCzAJBgNVBAYTAlVTMTwwOgYDVQQKEzNJbnRlcm5ldCBDb3Jwb3JhdGlvbiBmb3Ig
QXNzaWduZWQgTmFtZXMgYW5kIE51bWJlcnMxKTAnBgNVBAMTIElDQU5OIFRyYWRlbWFyayBDbGVh
cmluZ2hvdXNlIENBMB4XDTEzMDcyNDAwMDAwMFoXDTE5MDcyMzIzNTk1OVowgaAxCzAJBgNVBAYT
AkJFMREwDwYDVQQIEwhCcnVzc2VsczERMA8GA1UEBxMITWFjaGVsZW4xETAPBgNVBAoTCERlbG9p
dHRlMTIwMAYDVQQDEylJQ0FOTiBUTUNIIEF1dGhvcml6ZWQgVHJhZGVtYXJrIFZhbGlkYXRvcjEk
MCIGCSqGSIb3DQEJARYVYmV0bWNoc21kQGRlbG9pdHRlLmJlMIIBIjANBgkqhkiG9w0BAQEFAAOC
AQ8AMIIBCgKCAQEAyU+4kwqhyDAMwbXH6xrgrJ+CsO5O7bLdkD2MoNaJj1KRW1cfSQUMQC4dzIwT
3GgfK03YOJOpM1TJ4/3lY1aSraLJtmG/KbUkd1noDMZickqjAkHH8mLibbQuf9vtZVWFNQnmwHxW
2YaqFUsQAFAScF3TFa4tmkd1YmMYob3aGThVT2IfjKm9zT6HMORj4+XwH/jdd8lJxr0JbBsGBK9h
PZoz55woUbMLXKqeoTYNLNUGEMFZXZKJJYHC7EpYxwxJh3m7cV+ltQVsXnM2VguVVjNDR5X4F64+
pnxdjvK1OPEqX0QYRa36+aoPNT9pgm3tITNOID8fqHxXyLdlm4gO6wIDAQABo4IBgTCCAX0wDAYD
VR0TAQH/BAIwADAdBgNVHQ4EFgQUsmkB9tH29qDQ7m8MGrX8quwITZwwgcAGA1UdIwSBuDCBtYAU
XMDxlizKTFsp8UB00xs2PkfUbgSheqR4MHYxCzAJBgNVBAYTAlVTMTwwOgYDVQQKEzNJbnRlcm5l
dCBDb3Jwb3JhdGlvbiBmb3IgQXNzaWduZWQgTmFtZXMgYW5kIE51bWJlcnMxKTAnBgNVBAMTIElD
QU5OIFRyYWRlbWFyayBDbGVhcmluZ2hvdXNlIENBgiEAk0IyqE2PPdxdUk+PvK9xm+ujUUpBH51M
Lq1drN6bmD4wDgYDVR0PAQH/BAQDAgeAMC4GA1UdHwQnMCUwI6AhoB+GHWh0dHA6Ly9jcmwuaWNh
bm4ub3JnL3RtY2guY3JsMEsGA1UdIAREMEIwEAYOKwYBBAGCyRsBBYM7CAowLgYIKwYBBQUHAgEw
IjAgBggrBgEFBQcCARYUaHR0cHM6Ly9jYS5pY2Fubi5vcmcwDQYJKoZIhvcNAQELBQADggEBAA7J
hWdviuKdysY3jeOzbsX2DTm7TqvctcEtjmaO/4UmN09CsMTIE3pjm5Kqw49rlhGEK3enDaTKXVEu
0nbbDqeBD606Z+alYM63ww4Qn4TaSbNceh6nlhCc7+XB9TdKPrpHUpRhlH7N3WWYK/Pd20EfQTyo
8Q+H1ZimuwTgSSgs7boUICIaZtRXLnIavh/fMif2JJOl6iQxl4Jzwa+Pt0vGvCR+aLuESgZFn04v
jFUaTlqwaXoaEd9K6JlPkcFLqHrcx2ZJK19xpcY0RGqkyyhsp5KDlKB9Dfkila+yFpdPGbc7Nk58
RLFHv/iIje6beLpcQYq/fBs3HdZOgSApbVA=</ds:X509Certificate></ds:X509Data></ds:KeyInfo></ds:Signature></stificate></ds:X509Data></ds:KeyInfo></ds:Signature>md:signedMark> - ----END ENCODED SMD- ---- </item> </dt_assoc> </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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="link_domains">0</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_text">Order created</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="admin_email">[email protected]</item> <item key="id">422013</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
New gTLD during Claims period
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">new</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="domain">example.guru </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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="link_domains">0</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_code">260</item> <item key="is_success">1</item> <item key="response_text">Registration is pending registrant review before completing due to claim/trademark.</item> <item key="transaction_id">2014-03-06 16:30:17 1701 101</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Registration is pending registrant review before completing due to claim/trademark.</item> <item key="admin_email">[email protected]</item> <item key="registration_code">300</item> <item key="id">654276</item> <item key="async_reason">has_claim</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Registry premium domain
RequestResponse
<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">sw_register</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">1</item> <item key="reg_type">new</item> <item key="reg_username">testing1234</item> <item key="reg_password">testing1234testing</item> <item key="reg_domain" /> <item key="bulk_order">0</item> <item key="domain">example.bike </item> <item key="premium_price_to_verify">36.30 </item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="state">Ciudad Real</item> <item key="email">[email protected]</item> <item key="address1">Calle de la Azucena</item> <item key="phone">+1.4165350124 </item> <item key="address3" /> <item key="city">Ciudad Real</item> <item key="postal_code">13002</item> <item key="address2" /> <item key="first_name">mnhRJTHy</item> <item key="country">ES</item> <item key="title">QA Tester</item> <item key="last_name">TTzfwelA</item> <item key="org_name">Tucows</item> <item key="fax">+1.4165350124 </item> </dt_assoc> </item> <item key="admin"> <dt_assoc> <item key="address2" /> <item key="title">QA Tester</item> <item key="country">ES</item> <item key="first_name">Rob</item> <item key="org_name">Tucows</item> <item key="fax">+1.4165350124 </item> <item key="last_name">McAuley</item> <item key="email">[email protected]</item> <item key="address1">Calle de la Azucena</item> <item key="state">Ciudad Real</item> <item key="address3" /> <item key="phone">+1.4165350124 </item> <item key="city">Ciudad Real</item> <item key="postal_code">13002</item> </dt_assoc> </item> <item key="billing"> <dt_assoc> <item key="city">Ciudad Real</item> <item key="postal_code">13002</item> <item key="address1">Calle de la Azucena</item> <item key="state">Ciudad Real</item> <item key="email">[email protected]</item> <item key="address3" /> <item key="phone">+1.4165350124 </item> <item key="last_name">McAuley</item> <item key="org_name">Tucows</item> <item key="fax">+1.4165350124 </item> <item key="address2" /> <item key="title">QA Tester</item> <item key="country">ES</item> <item key="first_name">Rob</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="address1">Calle de la Azucena</item> <item key="email">[email protected]</item> <item key="state">Ciudad Real</item> <item key="phone">+1.4165350124 </item> <item key="address3" /> <item key="city">Ciudad Real</item> <item key="postal_code">13002</item> <item key="address2" /> <item key="first_name">Rob</item> <item key="title">QA Tester</item> <item key="country">ES</item> <item key="fax">+1.4165350124 </item> <item key="last_name">McAuley</item> <item key="org_name">Tucows</item> </dt_assoc> </item> </dt_assoc> </item> <item key="period">1</item> <item key="link_domains">0</item> <item key="handle">process</item> <item key="auto_renew">0</item> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.qa .systemdns.com </item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.qa .systemdns.com </item> </dt_assoc> </item> </dt_array> </item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc /> </item> </dt_assoc> </item> <item key="dns_template">testingtemplate</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_text">Domain registration successfully completed.
Domain successfully locked.
Whois Privacy successfully enabled.</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="admin_email">[email protected]</item> <item key="registration_text">Domain registration successfully completed.
Domain successfully locked.
Whois Privacy successfully enabled.</item> <item key="cancelled_orders"> <dt_array> <item key="0">1995014</item> <item key="1">1995015</item> </dt_array> </item> <item key="registration_code">200</item> <item key="domain_id">1015054</item> <item key="id">1995016</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Domain transfer examples
The period, if present, must be 1 year.
This response shows the result of a successful response to a transfer order.
The transfer is not complete at this point – rather, it has only been started.
If the domain's current whois information is accurate, then the current domain owner receives an email from OpenSRS requesting that they approve or reject the transfer request.
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">transfer</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="domain">example.com </item> <item key="auth_info">FKm8$%jk(!</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.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="link_domains">0</item> <item key="period">1</item> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_code">200</item> <item key="response_text">Transfer request has been successfully sent</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Transfer request has been successfully sent</item> <item key="registration_code">200</item> <item key="id">3735288</item> <item key="transfer_id">1234</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.AU Transfer
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="reg_type">transfer</item> <item key="domain">example.com .au</item> <item key="period">0</item> <item key="link_domains">0</item> <item key="f_lock_domain">1</item> <item key="auto_renew">0</item> <item key="reg_domain" /> <item key="reg_username">user123</item> <item key="reg_password">changeit</item> <item key="tld_data"> <dt_assoc> <item key="au_registrant_info"> <dt_assoc> <item key="registrant_name">Registered Company Name Ltd</item> <item key="registrant_id_type">ABN</item> <item key="policy_reason">1</item> <item key="registrant_id">99 999 999 999</item> <item key="eligibility_type">Registered</item> <item key="eligibility_name">Don Marshall</item> <item key="eligibility_id_type">ACN</item> <item key="eligibility_id">99999999</item> </dt_assoc> </item> </dt_assoc> </item> <item key="custom_tech_contact">1</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">[email protected]</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">[email protected]</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">[email protected]</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> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Transfer request initiated</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Transfer request initiated</item> <item key="transfer_id">0</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="id">11791463</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.CA Transfer
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">transfer</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="legal_type">CCT</item> <item key="domain">hamburgers.ca </item> <item key="auth_info">FKm8$%jk(!</item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="first_name">Owen</item> <item key="last_name">Ottway</item> <item key="address1">32 Oak Street</item> <item key="address2">Suite 500</item> <item key="address3">Owner</item> <item key="city">SomeCity</item> <item key="postal_code">M6K3M1</item> <item key="state">ON</item> <item key="country">CA</item> <item key="phone">+1.4165550123x1902 </item> <item key="fax">+1.4165550124 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="admin"> <dt_assoc> <item key="first_name">Owen</item> <item key="last_name">Ottway</item> <item key="address1">32 Oak Street</item> <item key="address2">Suite 500</item> <item key="address3">Owner</item> <item key="city">SomeCity</item> <item key="postal_code">M6K3M1</item> <item key="state">ON</item> <item key="country">CA</item> <item key="phone">+1.4165550123x1902 </item> <item key="fax">+1.4165550124 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> <item key="period">1</item> <item key="reg_domain" /> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="sortorder">3</item> <item key="name">ns3.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text">Transfer successful</item> <item key="attributes"> <dt_assoc> <item key="admin_email"[email protected]</item> <item key="id">85550904</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.DE Transfer
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">transfer</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="domain">example.de </item> <item key="handle">process</item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="country">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </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">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </item> <item key="address1">32 Oak Street</item> <item key="first_name">Owen</item> </dt_assoc> </item> <item key="billing"> <dt_assoc> <item key="country">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </item> <item key="address1">32 Oak Street</item> <item key="first_name">Owen</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="sortorder">3</item> <item key="name">ns3.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Transfer request has been successfully sent.
Admin contact email: [email protected]</item> <item key="attributes"> <dt_assoc> <item key="registration_text">Transfer request has been successfully sent.
Admin contact email: [email protected]</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="id">101550</item> <item key="transfer_id">1234</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.EU .BE Transfer
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="custom_tech_contact">0</item> <item key="auto_renew">0</item> <item key="reg_type">transfer</item> <item key="reg_username">user123</item> <item key="reg_password">changeit123</item> <item key="domain">example.eu </item> <item key="handle">process</item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="country">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </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">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </item> <item key="address1">32 Oak Street</item> <item key="first_name">Owen</item> </dt_assoc> </item> <item key="billing"> <dt_assoc> <item key="country">DE</item> <item key="address3">Owner</item> <item key="org_name">Example Inc.</item> <item key="phone">+49.1234567 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">Brandenburg</item> <item key="email">[email protected]</item> <item key="city">Berlin</item> <item key="postal_code">10115</item> <item key="fax">+49.78654321 </item> <item key="address1">32 Oak Street</item> <item key="first_name">Owen</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> <item key="custom_nameservers">1</item> <item key="nameserver_list"> <dt_array> <item key="0"> <dt_assoc> <item key="sortorder">1</item> <item key="name">ns1.systemdns .com</item> </dt_assoc> </item> <item key="1"> <dt_assoc> <item key="sortorder">2</item> <item key="name">ns2.systemdns .com</item> </dt_assoc> </item> <item key="2"> <dt_assoc> <item key="sortorder">3</item> <item key="name">ns3.systemdns .com</item> </dt_assoc> </item> </dt_array> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="object">DOMAIN</item> <item key="is_success">1</item> <item key="response_code">200</item> <item key="response_text"> Transfer request has been successfully sent.
Admin contact email: [email protected] </item> <item key="attributes"> <dt_assoc> <item key="registration_text"> Transfer request has been successfully sent.
Admin contact email: [email protected] </item> <item key="registration_code">200</item> <item key="id">3751913</item> <item key="transfer_id">1234</item> <item key="admin_email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.IT Transfer
RequestResponse
<?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">SW_REGISTER</item> <item key="attributes"> <dt_assoc> <item key="reg_username">aaaa</item> <item key="reg_domain"></item> <item key="reg_type">transfer</item> <item key="change_contact">1</item> <item key="tld_data"> <dt_assoc> <item key="it_registrant_info"> <dt_assoc> <item key="nationality_code">IT</item> <item key="reg_code">SGLMRA80A01H501E</item> <item key="entity_type">1</item> </dt_assoc> </item> </dt_assoc> </item> <item key="reg_password">aaaa</item> <item key="domain">example037.it </item> <item key="owner_confirm_address">[email protected]</item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="first_name">Mario</item> <item key="last_name">Segale</item> <item key="org_name">Mario Segale</item> <item key="address1">Via del Campidoglio, 20</item> <item key="city">Rome</item> <item key="state">RM</item> <item key="country">IT</item> <item key="postal_code">00123</item> <item key="phone">+39.0612345678 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="first_name">Frank</item> <item key="last_name">Mosser</item> <item key="org_name">Tech Orgname</item> <item key="address1">Piazza dei Giudici 20</item> <item key="city">Firenze</item> <item key="state">FI</item> <item key="country">IT</item> <item key="postal_code">50123</item> <item key="phone">+39.0551234567 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">DOMAIN</item> <item key="is_success">1</item> <item key="response_text">Transfer request has been successfully sent.
Admin contact email: [email protected]</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="transfer_id">41334</item> <item key="registration_text">Transfer request has been successfully sent.
Admin contact email: [email protected]</item> <item key="admin_email">[email protected]</item> <item key="registration_code">200</item> <item key="id">214998</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
.UK Transfer
Request
<?xml version="1.0 " encoding="UTF-8" standalone='yes'?> <!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'>SW_REGISTER</item> <item key='object'>DOMAIN</item> <item key='attributes'> <dt_assoc> <item key='reg_type'>transfer</item> <item key='domain'>opensrs.co .uk</item> <item key='handle'>process</item> <item key='auto_renew'>0</item> <item key='reg_username'>user123</item> <item key='reg_password'>changeme123</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="registrant_type">LTD</item> <item key="registration_number">85214792</item> <item key="trading_name">OpenSRS</item> </dt_assoc> </item> </dt_assoc> </item> <item key='contact_set'> <dt_assoc> <item key='owner'> <dt_assoc> <item key='first_name'>OpenSRS</item> <item key='last_name'>Tester</item> <item key='phone'>+1.416555122 </item> <item key='fax'></item> <item key='email'>[email protected]</item> <item key='org_name'>OpenSRS UK Company Ltd</item> <item key='address1'>96 Major Cr</item> <item key='address2'></item> <item key='address3'></item> <item key='city'>London</item> <item key='state'></item> <item key='country'>UK</item> <item key='postal_code'>SW31AA</item> </dt_assoc> </item> <item key="admin"> <dt_assoc> <item key='first_name'>OpenSRS</item> <item key='last_name'>Tester</item> <item key='phone'>+1.4165551212 </item> <item key='fax'></item> <item key='email'>[email protected]</item> <item key='org_name'>OpenSRS UK Company Ltd</item> <item key='address1'>99 Major Cr</item> <item key='address2'></item> <item key='address3'></item> <item key='city'>London</item> <item key='state'>ON</item> <item key='country'>UK</item> <item key='postal_code'>SW31AA</item> </dt_assoc> </item> </dt_assoc> </item> <item key="custom_transfer_nameservers">0</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
WHOIS Privacy
RequestResponse
<?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">SW_REGISTER</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="reg_type">whois_privacy</item> <item key="reg_password">aaaa</item> <item key="domain">example.com </item> <item key="reg_username">aaaa</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="is_success">1</item> <item key="protocol">XCP</item> <item key="action">REPLY</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="id">7235</item> <item key="admin_email">[email protected]</item> </dt_assoc> </item> <item key="response_text">WHOIS Privacy order [#7298] is in progress</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated 3 months ago
* * *
Table of Contents
Request parameters Request attributes
Additional request parameters for specific TLDs
Response parameters Response attributes
Domain registration examples .COM, .NET, .ORG, .INFO, .BIZ, .NAME, .ME, .MOBI
.AERO
.ASIA
.AU
.CA
.COM.BR
.DE
.DK
.ES
.EU
.FR
.HU
.INFO
.IT
.LAW .ABOGADO
.JOBS
.NAME
.PM, .RE, .TF, .WF, .YT
.PRO
Request parameters Request attributes
Additional request parameters for specific TLDs
Response parameters Response attributes
Domain registration examples .COM, .NET, .ORG, .INFO, .BIZ, .NAME, .ME, .MOBI
.AERO
.ASIA
.AU
.CA
.COM.BR
.DE
.DK
.ES
.EU
.FR
.HU
.INFO
.IT
.LAW .ABOGADO
.JOBS
.NAME
.PM, .RE, .TF, .WF, .YT
.PRO
.RU
.SCOT
.UK
.US
.XXX
New gTLD during Sunrise period
New gTLD during Claims period
Registry premium domain
Domain transfer examples .AU Transfer
.CA Transfer
.DE Transfer
.EU .BE Transfer
.IT Transfer
.UK Transfer
WHOIS Privacy
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
sw_register (trust_service)
Initiates a SSL certificate order.
Please note your handle parameter: "save"- will keep the order pending for later approval by the RSP, whereas "process" will proceed and complete the order.
Suggest Edits
Request parameters
Standard request parameters
action = sw_register
object = trust_service
registrant_ip = valid IP address of the registrant (optional)
Request attributes
Parameters within the attributes associative array are described below:
ParameterObligationDefinition
additional_domains Required for SAN certificate orders Some SSL Service products (referred to as SAN certificates) allow you to specify a list of additional domains or other entities (other than the primary domain) that will be secured by a single SSL certificate.
This means that, depending on the product, you may be able to specify multiple top-level domains, subdomains, IP addresses, internal server names, and more.
The total number that you can protect with a single certificate varies by product.
Please see pricing and maximum number of additional domains at opensrs.com /ssl/pricing/.
Note: The additional domains are priced as packages, so if the certificate can secure four additional domains, but you specify only two, you will still be charged the full package price.
In most cases, you can add more domains to a package for an additional charge.
affiliate_id Optional The unique identifier of an RSP's affiliate, which allows the RSP to track orders coming through different affiliates.
approver_email Required for Domain Vetted certificates The email of one of the individuals who can approve the SSL Service order.
If not specified, the admin contact email address will be used.
base_order_id Optional Create a new order based on the specified previous order.
When base_order_id is submitted, reg_type must equal new.
All other fields are optional, unless you want to apply new values to those fields.
Note: The original order must have the same product_type as the new order.
comments Optional Adds additional notes to the order.
contact_set Required A collection of associative arrays containing contact information for each contact type (signer, organization, or admin).
For more details, please refer to: product_types.
csr Required The certificate signing request for the required certificate.
The SSL Service provider uses this information to generate the certificate.
Note: All certificates require 2048 bit CSRs.
domain Required The domain or hostname for which the SSL Service is ordered.
If not specified, the domain within the CSR will be used.
If the domain specified does not match the the CSR domain value, the order will fail.
dv_auth_method Optional Allows you to specify how you want to validate the certificate.
Allowed values are:
DNS
Email—default
end_user_auth_info Optional
(Used only for SiteLock) An associative array containing: email_address, username, and password used only for SiteLock products to specify the end user credentials which will be used to log in to the Domain Admin interface to manage their account.
The login credentials will be sent to the specified email_address.
If you resend the Domain Admin login information (through the Control Panel), this is the address to which the Domain Admin login credentials are sent.
Note: If you specify username and password and the user already exists, the command will fail.
If you specify username but not password, and the user does not already exist, the user credentials cannot be created and the command will fail.
If you want to associate the SSL Service product with an existing account, you only need to include the username value.
handle Required Instructions for the processing of the order.
save—Pend the order for the RSP's later approval.
process—Process the order immediately.
inventory_item_id Optional for renewals; may be used for certificates that were migrated from TPP.
The certificate product ID number that was used in the TPP system.
This value may be used in place of order_id or product_id.
Note: Do not include this parameter for new orders.
order_id Required for renewals and for SiteLock upgrades if product_id is not submitted.
The order ID number of the SSL Service product to be renewed or upgraded.
Note: Do not include this parameter for new orders.
product_id Required for renewals and for SiteLock upgrades if order_id is not submitted.
The product ID number of the SSL Service product to be renewed or upgraded.
Note: Do not include this parameter for new orders.
period Required The length of the registration period.
The value is 1 for all products.
product_type Required DigiCert Products: digicert_csc, digicert_sslplus, digicert_sslplus_ev, digicert_sslplus_wildcard, securesite, securesite_ev, securesite_pro, securesite_pro_ev, symantec_ssl_lite, symantec_ssl_lite_wildcard
GeoTrust Products: quickssl_premium, rapidssl, rapidssl_wildcard, truebizid, truebizid_ev, truebizid_wildcard
Sectigo Products: comodo_ev, comodo_instantssl, comodo_premiumssl, comodo_premiumssl_wildcard, comodo_ssl, comodo_wildcard, essentialssl, essentialssl_wildcard, positivessl, positivessl_wildcard
SiteLock Products: sitelock_911, sitelock_find, sitelock_fix, sitelock_prevent
Thawte Products: ssl123, sslwebserver, sslwebserver_ev, sslwebserver_wildcard
TrustWave Products: trustwave_dv, trustwave_ev, trustwave_ev_san5, trustwave_premiumssl, trustwave_premiumssl_san5, trustwave_premiumssl_wildcard
Actalis Products: actalis_ssl_dv, actalis_ssl_ov, actalis_ssl_ev, actalis_ssl_dv_san, actalis_ssl_ov_san, actalis_ssl_ev_san, actalis_ssl_dv_wildcard, actalis_ssl_ov_wildcard
For more details, please refer to: product_types or our pricing page.
vat_number Required for Actalis OV/EV Orders The numeric identifier used in many countries, including the countries of the European Union, for value-added tax purposes.
Note: Can be submitted individually if CRN not provided.
If both CRN or VAT provided, company_registration_number will take priority and be sent to vendor .
Either vat_number or company_registraion_number must match the org_name which must contains full official name.
company_registration_number Required for Actalis OV/EV Orders The company registration number associated with your company.
Note: Can be submitted individually if VAT not provided.
If both CRN or VAT provided, company_registration_number will take priority and be sent to vendor .
Either vat_number or company_registraion_number must match the org_name which must contains full official name.
reg_type Required The type of order being requested.
Allowed values are:
new—Submit a new order
renew—Renew a SSL Service product
upgrade—Upgrade a SiteLock product.
You do not need to specify the domain or the period.
When you upgrade, the product_type changes, you are charged the price for a one year term at the new level, and the new expiry date is one year from the date of the upgrade.
server_type Optional The type of server software used to generate the CSR.
For more details, please refer to: server_types
* * *
Response parameters
Standard response parameters
action = SW_REGISTER:REPLY
object = trust_service
is_success = Boolean 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.
📘Response_code: 250 (processing)
The Reseller Agent (RSA) can respond with a 250 response_code, which indicates that your request was submitted for processing in an asynchronous registry.
When the registry's reply is received by OpenSRS, it is processed.
Performing a get_userinfo command indicates if there is an action currently waiting on a domain.
Response attributes
ParameterObligationDefinition
order_id Always returned The ID number of the SSL Service order.
state Always returned The state of the order.
Allowed values are:
approver-confirmed—Owner has confirmed the domain vetted certificate.
awaiting-approval—Order processed successfully; waiting for supplier approval.
cancelled—Pending order was cancelled.
completed—Order is complete.
declined—Order cancelled after it was processed or declined by the supplier.
in-progress—Order is in progress.
pending—Order saved as pending.
domain Returned for domain vetted certificates The domain with which the SSL Service is associated.
dv_auth_method Returned for domain vetted certificates The File or DNS data to be used for DV authorization to validate the certificate.
* * *
Examples
New Order: product_type: securesite RequestResponse
<?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">sw_register</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="reg_type">NEW</item> <item key="product_type">securesite</item> <item key="handle">process</item> <item key="contact_set"> <dt_assoc> <item key="organization"> <dt_assoc> <item key="first_name">Owen</item> <item key="last_name">Ottway</item> <item key="org_name">Example Inc.</item> <item key="address1">32 Oak Street</item> <item key="address2">Suite 500</item> <item key="city">SomeCity</item> <item key="state">CA</item> <item key="country">US</item> <item key="postal_code">90210</item> <item key="phone">+1.4165550123 </item> <item key="fax">+1.4165550124 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="csr"> -----BEGIN CERTIFICATE REQUEST----- MIICuzCCAaMCADB3MQswCQYDVQQGEwJVUzEUMBIGA1UEAxMLZXhhbXBsZS5jb20x FDASBgNVBAcTC1NhbnRhIENsYXJhMRUwEwYDVQQKEwxFeGFtcGxlIEluYy4xEzAR BgNVBAgTCkNhbGlmb3JuaWExEDAOBgNVBAsTB1N1cHBvcnQwggEiMA0GCSqGSIb3 DQEBAQUAA4IBDwAwggEKAoIBAQDTCJ1qnH3gaKVd8VXTOx5GR+MYinU36Z9psxuG haMZ70qhTwng5zcbC93XIpAJRkbMwMu1EI10QDNi91Z4ORI9ExbBg0HBrAz+k85O lMUk1xTR8FQ8eHWXLnL3uXDevi5XMsb0ASB6wADDdvVm2Eb4qu+B1KD5qCSPiRJ2 FLeNNI3JNosmKmtmhqgy6+0qYYTP5RPFJeIu55cvX+r9ghiL11eBg/A+3RBhLdLR +z0CsngOFMlNxzmP0csINw4FIj4AoAkMiA/2Hf6rT6bHiAtJDbkW6jAS3AQjB1IC LlkFbr12e5P7USqSsKSbwslOHHBJpfYceA6582MI4ZZ3CerNAgMBAAGgADANBgkq hkiG9w0BAQsFAAOCAQEAaUwWHGCekeDC9U0OqLHlaXT9yRTpBcMu3waqWWhIgxLP 6ut1YlYjz1yAc7XIJPNo+uyXX1BtrMpGgXt7cJmwLeXPHHs1WoleQfKOGjVRf3+8 sQgdVroMR8HtOPid00Vxd4v1caUQtM7N2e2sWe5IL5OS2ziAflc3UhSoLu7JQwNg pKCQbOVbq5Y+uWYmMkKaZewIiziUvqngUMgA2ci+BJ2xCZmq00Leq+AZMLKPI2NE NcKsc4yjB4envG4vzc4qMFQakvH0uvsswZc80H7R7neThUgpfQM+PhDI/z3woTPG exAECZo+AqWhnwdut/Socu+aFkMO0vl77JD4acjODA== -----END CERTIFICATE REQUEST----- </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">SW_REGISTER:REPLY</item> <item key="object">TRUST_SERVICE</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="order_id">195243</item> <item key="state">awaiting-approval</item> <item key="domain">example.com </item> </dt_assoc> </item> <item key="response_code">200</item> <item key="response_text">Command completed successfully.</item> </dt_assoc> </data_block> </body> </OPS_envelope>
New Order: product_type: SSL123 (DV) Domain Vetted Certificate
approver_email is not included, by default the admin email is selected.
only admin contact is required.
period is not included, default is selected as 1.
server_type is not included, default is selected as null/blank.
dv_auth_method not specified, email selected by default.
RequestResponse
<?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">sw_register</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="reg_type">NEW</item> <item key="product_type">ssl123</item> <item key="handle">process</item> <item key="contact_set"> <dt_assoc> <item key="admin"> <dt_assoc> <item key="title">Admin</item> <item key="first_name">Adler</item> <item key="last_name">Adams</item> <item key="address1">32 Oak Street</item> <item key="city">Santa Clara</item> <item key="state">CA</item> <item key="country">US</item> <item key="postal_code">90210</item> <item key="phone">+1.4165550123 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="csr"> -----BEGIN CERTIFICATE REQUEST----- MIICuzCCAaMCADB3MQswCQYDVQQGEwJVUzEUMBIGA1UEAxMLZXhhbXBsZS5jb20x FDASBgNVBAcTC1NhbnRhIENsYXJhMRUwEwYDVQQKEwxFeGFtcGxlIEluYy4xEzAR BgNVBAgTCkNhbGlmb3JuaWExEDAOBgNVBAsTB1N1cHBvcnQwggEiMA0GCSqGSIb3 DQEBAQUAA4IBDwAwggEKAoIBAQDTCJ1qnH3gaKVd8VXTOx5GR+MYinU36Z9psxuG haMZ70qhTwng5zcbC93XIpAJRkbMwMu1EI10QDNi91Z4ORI9ExbBg0HBrAz+k85O lMUk1xTR8FQ8eHWXLnL3uXDevi5XMsb0ASB6wADDdvVm2Eb4qu+B1KD5qCSPiRJ2 FLeNNI3JNosmKmtmhqgy6+0qYYTP5RPFJeIu55cvX+r9ghiL11eBg/A+3RBhLdLR +z0CsngOFMlNxzmP0csINw4FIj4AoAkMiA/2Hf6rT6bHiAtJDbkW6jAS3AQjB1IC LlkFbr12e5P7USqSsKSbwslOHHBJpfYceA6582MI4ZZ3CerNAgMBAAGgADANBgkq hkiG9w0BAQsFAAOCAQEAaUwWHGCekeDC9U0OqLHlaXT9yRTpBcMu3waqWWhIgxLP 6ut1YlYjz1yAc7XIJPNo+uyXX1BtrMpGgXt7cJmwLeXPHHs1WoleQfKOGjVRf3+8 sQgdVroMR8HtOPid00Vxd4v1caUQtM7N2e2sWe5IL5OS2ziAflc3UhSoLu7JQwNg pKCQbOVbq5Y+uWYmMkKaZewIiziUvqngUMgA2ci+BJ2xCZmq00Leq+AZMLKPI2NE NcKsc4yjB4envG4vzc4qMFQakvH0uvsswZc80H7R7neThUgpfQM+PhDI/z3woTPG exAECZo+AqWhnwdut/Socu+aFkMO0vl77JD4acjODA== -----END CERTIFICATE REQUEST----- </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">SW_REGISTER:REPLY</item> <item key="object">TRUST_SERVICE</item> <item key="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="order_id">195266</item> <item key="state">awaiting-approval</item> <item key="domain">example.com </item> </dt_assoc> </item> <item key="response_code">200</item> <item key="response_text">Command completed successfully.</item> </dt_assoc> </data_block> </body> </OPS_envelope>
New Order: product_type: truebizid_wildcard RequestResponse
<?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">sw_register</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="reg_type">NEW</item> <item key="product_type">truebizid_wildcard</item> <item key="handle">process</item> <item key="contact_set"> <dt_assoc> <item key="organization"> <dt_assoc> <item key="first_name">Adler</item> <item key="last_name">Adams</item> <item key="org_name">Example Inc.</item> <item key="address1">32 Oak Street</item> <item key="address2">Suite 100</item> <item key="city">Santa Clara</item> <item key="state">CA</item> <item key="country">US</item> <item key="postal_code">90210</item> <item key="phone">+1.4165550123 </item> <item key="fax">+1.4165550125 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="csr"> -----BEGIN CERTIFICATE REQUEST----- MIICtjCCAZ4CAQAwcTELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMRQwEgYDVQQH DAtTYW50YSBDbGFyYTEVMBMGA1UECgwMRXhhbXBsZSBJbmMuMRAwDgYDVQQLDAdT dXBwb3J0MRYwFAYDVQQDDA0qLmV4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEF AAOCAQ8AMIIBCgKCAQEAwv27s0I+j53xtGXxftUCHB6aEqlbJtROhLr7VAkzA+WL BZcQyhTY9kJ9CmZVoXs7cXN+wa7ZTxbZNNj5Krylcct+Ctyfxmonug8jQ3j8nR7S s4bPhYKG6ZUCAtfe47zyWraHBTk/AZ7zNubPROT/5uWW/da7VUj5C+t7CPiCDB1U ERer2ZepmgGLxiykdwRB8xOVefuQrxsqBRffHowrZyDoPe7NETQxYZxs/afnEKdE HsaAcZH/Ay0uVuG9SryIYGMZtDyFHRU1fzl/F5759nCnvdyISu+jet1IYzG9jNDu dmkQDTwhSnXRf0PC1GnLBEvZTeKzZ+aOyprHgO78BQIDAQABoAAwDQYJKoZIhvcN AQELBQADggEBABfNX7yPsGJYOnDKFNZ89kGTUUX/VrXgndVUr40Rnh+x9xzg8We3 AcG7picwpeMd/SmB+rBUUGTlRrfqEdFcLhymA2J2dhoABwtcIwyk1H8qU3zPMA8p 5qt3r07i6nHiUcDPGtNw836yBzC3hqrIQlM/Sr0NQNQl25AD8HS5A3EkV53pUpNy ggqViqELn0ynRqqHAPIZ8KOGsAqQgZ4/Jf/W0UTJz+SZHrBBMekS96tzgKNF60KE Xvx80TmEZvaOmexNVUPYDPCunxJOpphc6g6mTzeSXiSo5RkmEYGbmw67x8+Gm7Pi DIBVwUL/YgsnfODhqmtKy73TutapRn01/Is= -----END CERTIFICATE REQUEST----- </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="is_success">1</item> <item key="object">TRUST_SERVICE</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="state">awaiting-approval</item> <item key="order_id">195277</item> <item key="domain">*.example.com </item> </dt_assoc> </item> <item key="response_text">Command completed successfully.</item> <item key="action">SW_REGISTER:REPLY</item> <item key="protocol">XCP</item> </dt_assoc> </data_block> </body> </OPS_envelope>
New Order: product_type: digicert_sslplus_wildcard RequestResponse
<?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">sw_register</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="reg_type">NEW</item> <item key="product_type">digicert_sslplus_wildcard</item> <item key="handle">process</item> <item key="contact_set"> <dt_assoc> <item key="organization"> <dt_assoc> <item key="first_name">Adler</item> <item key="last_name">Adams</item> <item key="org_name">Example Inc.</item> <item key="address1">32 Oak Street</item> <item key="address2">Suite 100</item> <item key="city">Santa Clara</item> <item key="state">CA</item> <item key="country">US</item> <item key="postal_code">90210</item> <item key="phone">+1.4165550123 </item> <item key="fax">+1.4165550125 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="csr"> -----BEGIN CERTIFICATE REQUEST----- MIICtjCCAZ4CAQAwcTELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMRQwEgYDVQQH DAtTYW50YSBDbGFyYTEVMBMGA1UECgwMRXhhbXBsZSBJbmMuMRAwDgYDVQQLDAdT dXBwb3J0MRYwFAYDVQQDDA0qLmV4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEF AAOCAQ8AMIIBCgKCAQEAwv27s0I+j53xtGXxftUCHB6aEqlbJtROhLr7VAkzA+WL BZcQyhTY9kJ9CmZVoXs7cXN+wa7ZTxbZNNj5Krylcct+Ctyfxmonug8jQ3j8nR7S s4bPhYKG6ZUCAtfe47zyWraHBTk/AZ7zNubPROT/5uWW/da7VUj5C+t7CPiCDB1U ERer2ZepmgGLxiykdwRB8xOVefuQrxsqBRffHowrZyDoPe7NETQxYZxs/afnEKdE HsaAcZH/Ay0uVuG9SryIYGMZtDyFHRU1fzl/F5759nCnvdyISu+jet1IYzG9jNDu dmkQDTwhSnXRf0PC1GnLBEvZTeKzZ+aOyprHgO78BQIDAQABoAAwDQYJKoZIhvcN AQELBQADggEBABfNX7yPsGJYOnDKFNZ89kGTUUX/VrXgndVUr40Rnh+x9xzg8We3 AcG7picwpeMd/SmB+rBUUGTlRrfqEdFcLhymA2J2dhoABwtcIwyk1H8qU3zPMA8p 5qt3r07i6nHiUcDPGtNw836yBzC3hqrIQlM/Sr0NQNQl25AD8HS5A3EkV53pUpNy ggqViqELn0ynRqqHAPIZ8KOGsAqQgZ4/Jf/W0UTJz+SZHrBBMekS96tzgKNF60KE Xvx80TmEZvaOmexNVUPYDPCunxJOpphc6g6mTzeSXiSo5RkmEYGbmw67x8+Gm7Pi DIBVwUL/YgsnfODhqmtKy73TutapRn01/Is= -----END CERTIFICATE REQUEST----- </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="is_success">1</item> <item key="object">TRUST_SERVICE</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="state">awaiting-approval</item> <item key="order_id">195278</item> <item key="domain">*.example.com </item> </dt_assoc> </item> <item key="response_text">Command completed successfully.</item> <item key="action">SW_REGISTER:REPLY</item> <item key="protocol">XCP</item> </dt_assoc> </data_block> </body> </OPS_envelope>
New Order: product_type: sslwebserver_wildcard RequestResponse
<?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">sw_register</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="reg_type">NEW</item> <item key="product_type">sslwebserver_wildcard</item> <item key="handle">process</item> <item key="contact_set"> <dt_assoc> <item key="organization"> <dt_assoc> <item key="first_name">Adler</item> <item key="last_name">Adams</item> <item key="org_name">Example Inc.</item> <item key="address1">32 Oak Street</item> <item key="address2">Suite 100</item> <item key="city">Santa Clara</item> <item key="state">CA</item> <item key="country">US</item> <item key="postal_code">90210</item> <item key="phone">+1.4165550123 </item> <item key="fax">+1.4165550125 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="csr"> -----BEGIN CERTIFICATE REQUEST----- MIICtjCCAZ4CAQAwcTELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMRQwEgYDVQQH DAtTYW50YSBDbGFyYTEVMBMGA1UECgwMRXhhbXBsZSBJbmMuMRAwDgYDVQQLDAdT dXBwb3J0MRYwFAYDVQQDDA0qLmV4YW1wbGUuY29tMIIBIjANBgkqhkiG9w0BAQEF AAOCAQ8AMIIBCgKCAQEAwv27s0I+j53xtGXxftUCHB6aEqlbJtROhLr7VAkzA+WL BZcQyhTY9kJ9CmZVoXs7cXN+wa7ZTxbZNNj5Krylcct+Ctyfxmonug8jQ3j8nR7S s4bPhYKG6ZUCAtfe47zyWraHBTk/AZ7zNubPROT/5uWW/da7VUj5C+t7CPiCDB1U ERer2ZepmgGLxiykdwRB8xOVefuQrxsqBRffHowrZyDoPe7NETQxYZxs/afnEKdE HsaAcZH/Ay0uVuG9SryIYGMZtDyFHRU1fzl/F5759nCnvdyISu+jet1IYzG9jNDu dmkQDTwhSnXRf0PC1GnLBEvZTeKzZ+aOyprHgO78BQIDAQABoAAwDQYJKoZIhvcN AQELBQADggEBABfNX7yPsGJYOnDKFNZ89kGTUUX/VrXgndVUr40Rnh+x9xzg8We3 AcG7picwpeMd/SmB+rBUUGTlRrfqEdFcLhymA2J2dhoABwtcIwyk1H8qU3zPMA8p 5qt3r07i6nHiUcDPGtNw836yBzC3hqrIQlM/Sr0NQNQl25AD8HS5A3EkV53pUpNy ggqViqELn0ynRqqHAPIZ8KOGsAqQgZ4/Jf/W0UTJz+SZHrBBMekS96tzgKNF60KE Xvx80TmEZvaOmexNVUPYDPCunxJOpphc6g6mTzeSXiSo5RkmEYGbmw67x8+Gm7Pi DIBVwUL/YgsnfODhqmtKy73TutapRn01/Is= -----END CERTIFICATE REQUEST----- </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="is_success">1</item> <item key="object">TRUST_SERVICE</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="state">awaiting-approval</item> <item key="order_id">195279</item> <item key="domain">*.example.com </item> </dt_assoc> </item> <item key="response_text">Command completed successfully.</item> <item key="action">SW_REGISTER:REPLY</item> <item key="protocol">XCP</item> </dt_assoc> </data_block> </body> </OPS_envelope>
New Order: product_type: actalis_ssl_ov (Email Validation) RequestResponse
<?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">sw_register</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="reg_type">NEW</item> <item key="product_type">actalis_ssl_ov</item> <item key="handle">process</item> <item key="dv_auth_method">EMAIL</item> <item key="approver_email">[email protected]</item> <item key="contact_set"> <dt_assoc> <item key="organization"> <dt_assoc> <item key="vat_number">5808530583</item> <item key="company_registration_number">58279753</item> <item key="first_name">qa</item> <item key="last_name">tester</item> <item key="org_name">Tucows</item> <item key="address1">96 mowat ave</item> <item key="city">toronto</item> <item key="state">ON</item> <item key="country">CA</item> <item key="postal_code">m3j2k4</item> <item key="phone">+1.4165550123 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="admin"> <dt_assoc> <item key="first_name">qa</item> <item key="last_name">tester</item> <item key="address1">96 mowat ave</item> <item key="city">toronto</item> <item key="state">ON</item> <item key="country">CA</item> <item key="postal_code">m3j2k4</item> <item key="phone">+1.4165550123 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="csr"> -----BEGIN CERTIFICATE REQUEST----- MIICwjCCAawCAQAwRDESMBAGA1UEAwwJZGVjMTQuY29tMQ8wDQYDVQQKDAZ0dWNv d3MxEDAOBgNVBAcMB3Rvcm9udG8xCzAJBgNVBAgMAm9uMIIBIjANBgkqhkiG9w0B AQEFAAOCAQ8AMIIBCgKCAQEAo++5TNqw9DIR3p0SM+fxfTEfYIOTHEeTkD9v6HV0 Oavasm3NfzcJIIS1TSxvPHOKc4mn8d+5/bXKVpTrMa+NoO+SgPLiBY99+4W7FptG cMy2pebFunTMnGc+uQ2IArHEjzcCL8nfWofSTQcm22QdFpas1PiEeZhLPIFRDPvo 1fjE4Q1XSTezeR8CTnArBSGNHoo20NaAlUnUU0tOc1X6REHc6QQWUdVDCO00Zk9T GQ+UdYK/Ea8AJ1EDFivVJ6xc8WIrTYawUzxmlBmKBzcZY2sB8rSK0MMPZAs/LC9w zXvN9akpfZ3bhf4HcIgEeMeN/Q6nqwq7BJ7fDetJyaIynwIDAQABoDswOQYJKoZI hvcNAQkOMSwwKjAdBgNVHQ4EFgQUS/siDy/VQf4NPQa8nD/+/rt98jMwCQYDVR0R BAIwADALBgkqhkiG9w0BAQsDggEBAB5RBRM3j7/pytXvYMj914bGcHqzc1FIkaeE BwJkA1VdMc5rildrSwgEfHgFPyf6P+HwxFuyPWF2VgWgxjTFtp9jYP1uPBWVaq+b 2rvlVIu5/ZyHT7iInyGnszrNWK3LgQdcUA7eVyckoVNrKVR5ErKUjFGsB6sRlR0I K/UUK21kCKyPFm882dPqyRoopNfoR31RVdHl0f2UL+DZnGXjVktvgVM69dQlZcZE Ydb3uZb7uA58447fiL3nfcyuMSSOfiAMm6xT1z7GbQuLerSxS1UIJPi1q/E+TBg8 Wkgj+3I4585ixhvj9oi9zk70yC+GbalUhnWcs2gU84t5ZHVX860= -----END CERTIFICATE REQUEST----- </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="response_text">Command completed successfully.</item> <item key="object">TRUST_SERVICE</item> <item key="action">SW_REGISTER:REPLY</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="state">awaiting-approval</item> <item key="domain">dec14.com </item> <item key="order_id">62045</item> </dt_assoc> </item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
New Order: product_type: actalis_ssl_ov (DNS validation) RequestResponse
<?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">sw_register</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="reg_type">NEW</item> <item key="product_type">actalis_ssl_ov</item> <item key="handle">process</item> <item key="dv_auth_method">DNS</item> <item key="contact_set"> <dt_assoc> <item key="organization"> <dt_assoc> <item key="vat_number">5808530583</item> <item key="company_registration_number">58279753</item> <item key="first_name">qa</item> <item key="last_name">tester</item> <item key="org_name">Tucows</item> <item key="address1">96 mowat ave</item> <item key="city">toronto</item> <item key="state">ON</item> <item key="country">CA</item> <item key="postal_code">m3j2k4</item> <item key="phone">+1.4165550123 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="admin"> <dt_assoc> <item key="first_name">qa</item> <item key="last_name">tester</item> <item key="address1">96 mowat ave</item> <item key="city">toronto</item> <item key="state">ON</item> <item key="country">CA</item> <item key="postal_code">m3j2k4</item> <item key="phone">+1.4165550123 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="csr"> -----BEGIN CERTIFICATE REQUEST----- MIICwjCCAawCAQAwRDESMBAGA1UEAwwJZGVjMTQuY29tMQ8wDQYDVQQKDAZ0dWNv d3MxEDAOBgNVBAcMB3Rvcm9udG8xCzAJBgNVBAgMAm9uMIIBIjANBgkqhkiG9w0B AQEFAAOCAQ8AMIIBCgKCAQEAo++5TNqw9DIR3p0SM+fxfTEfYIOTHEeTkD9v6HV0 Oavasm3NfzcJIIS1TSxvPHOKc4mn8d+5/bXKVpTrMa+NoO+SgPLiBY99+4W7FptG cMy2pebFunTMnGc+uQ2IArHEjzcCL8nfWofSTQcm22QdFpas1PiEeZhLPIFRDPvo 1fjE4Q1XSTezeR8CTnArBSGNHoo20NaAlUnUU0tOc1X6REHc6QQWUdVDCO00Zk9T GQ+UdYK/Ea8AJ1EDFivVJ6xc8WIrTYawUzxmlBmKBzcZY2sB8rSK0MMPZAs/LC9w zXvN9akpfZ3bhf4HcIgEeMeN/Q6nqwq7BJ7fDetJyaIynwIDAQABoDswOQYJKoZI hvcNAQkOMSwwKjAdBgNVHQ4EFgQUS/siDy/VQf4NPQa8nD/+/rt98jMwCQYDVR0R BAIwADALBgkqhkiG9w0BAQsDggEBAB5RBRM3j7/pytXvYMj914bGcHqzc1FIkaeE BwJkA1VdMc5rildrSwgEfHgFPyf6P+HwxFuyPWF2VgWgxjTFtp9jYP1uPBWVaq+b 2rvlVIu5/ZyHT7iInyGnszrNWK3LgQdcUA7eVyckoVNrKVR5ErKUjFGsB6sRlR0I K/UUK21kCKyPFm882dPqyRoopNfoR31RVdHl0f2UL+DZnGXjVktvgVM69dQlZcZE Ydb3uZb7uA58447fiL3nfcyuMSSOfiAMm6xT1z7GbQuLerSxS1UIJPi1q/E+TBg8 Wkgj+3I4585ixhvj9oi9zk70yC+GbalUhnWcs2gU84t5ZHVX860= -----END CERTIFICATE REQUEST----- </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="action">SW_REGISTER:REPLY</item> <item key="response_code">200</item> <item key="protocol">XCP</item> <item key="object">TRUST_SERVICE</item> <item key="response_text">Command completed successfully.</item> <item key="attributes"> <dt_assoc> <item key="dv_auth_method">dns</item> <item key="order_id">62041</item> <item key="dv_auth_details"> <dt_assoc> <item key="dns_entry">dec14.com IN TXT actalis-dcv=5dcqdn4frtckuv2h33sc34spj8</item> </dt_assoc> </item> <item key="state">awaiting-approval</item> <item key="domain">dec14.com </item> </dt_assoc> </item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
New Order: product_type: actalis_ssl_ov (File Validation) RequestResponse
<?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">sw_register</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="reg_type">NEW</item> <item key="product_type">actalis_ssl_ov</item> <item key="handle">process</item> <item key="dv_auth_method">FILE</item> <item key="contact_set"> <dt_assoc> <item key="organization"> <dt_assoc> <item key="vat_number">5808530583</item> <item key="company_registration_number">58279753</item> <item key="first_name">qa</item> <item key="last_name">tester</item> <item key="org_name">Tucows</item> <item key="address1">96 mowat ave</item> <item key="city">toronto</item> <item key="state">ON</item> <item key="country">CA</item> <item key="postal_code">m3j2k4</item> <item key="phone">+1.4165550123 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="admin"> <dt_assoc> <item key="first_name">qa</item> <item key="last_name">tester</item> <item key="address1">96 mowat ave</item> <item key="city">toronto</item> <item key="state">ON</item> <item key="country">CA</item> <item key="postal_code">m3j2k4</item> <item key="phone">+1.4165550123 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="csr"> -----BEGIN CERTIFICATE REQUEST----- MIICwjCCAawCAQAwRDESMBAGA1UEAwwJZGVjMTQuY29tMQ8wDQYDVQQKDAZ0dWNv d3MxEDAOBgNVBAcMB3Rvcm9udG8xCzAJBgNVBAgMAm9uMIIBIjANBgkqhkiG9w0B AQEFAAOCAQ8AMIIBCgKCAQEAo++5TNqw9DIR3p0SM+fxfTEfYIOTHEeTkD9v6HV0 Oavasm3NfzcJIIS1TSxvPHOKc4mn8d+5/bXKVpTrMa+NoO+SgPLiBY99+4W7FptG cMy2pebFunTMnGc+uQ2IArHEjzcCL8nfWofSTQcm22QdFpas1PiEeZhLPIFRDPvo 1fjE4Q1XSTezeR8CTnArBSGNHoo20NaAlUnUU0tOc1X6REHc6QQWUdVDCO00Zk9T GQ+UdYK/Ea8AJ1EDFivVJ6xc8WIrTYawUzxmlBmKBzcZY2sB8rSK0MMPZAs/LC9w zXvN9akpfZ3bhf4HcIgEeMeN/Q6nqwq7BJ7fDetJyaIynwIDAQABoDswOQYJKoZI hvcNAQkOMSwwKjAdBgNVHQ4EFgQUS/siDy/VQf4NPQa8nD/+/rt98jMwCQYDVR0R BAIwADALBgkqhkiG9w0BAQsDggEBAB5RBRM3j7/pytXvYMj914bGcHqzc1FIkaeE BwJkA1VdMc5rildrSwgEfHgFPyf6P+HwxFuyPWF2VgWgxjTFtp9jYP1uPBWVaq+b 2rvlVIu5/ZyHT7iInyGnszrNWK3LgQdcUA7eVyckoVNrKVR5ErKUjFGsB6sRlR0I K/UUK21kCKyPFm882dPqyRoopNfoR31RVdHl0f2UL+DZnGXjVktvgVM69dQlZcZE Ydb3uZb7uA58447fiL3nfcyuMSSOfiAMm6xT1z7GbQuLerSxS1UIJPi1q/E+TBg8 Wkgj+3I4585ixhvj9oi9zk70yC+GbalUhnWcs2gU84t5ZHVX860= -----END CERTIFICATE REQUEST----- </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="is_success">1</item> <item key="attributes"> <dt_assoc> <item key="order_id">62043</item> <item key="dv_auth_method">file</item> <item key="domain">dec14.com </item> <item key="state">awaiting-approval</item> <item key="dv_auth_details"> <dt_assoc> <item key="file_contents">446mr5u6d3jqvts08tl7hbgkjg</item> <item key="file_name">actalis.txt </item> </dt_assoc> </item> </dt_assoc> </item> <item key="response_code">200</item> <item key="action">SW_REGISTER:REPLY</item> <item key="object">TRUST_SERVICE</item> <item key="response_text">Command completed successfully.</item> <item key="protocol">XCP</item> </dt_assoc> </data_block> </body> </OPS_envelope>
New Order: product_type: actalis_ssl_ov_san (DNS Validation) RequestResponse
<?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">sw_register</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="reg_type">NEW</item> <item key="product_type">actalis_ssl_ov_san</item> <item key="handle">process</item> <item key="dv_auth_method">DNS</item> <item key="additional_domains"> <dt_array> <item key="0">extra.dec14 .com</item> </dt_array> </item> <item key="contact_set"> <dt_assoc> <item key="organization"> <dt_assoc> <item key="vat_number">5808530583</item> <item key="company_registration_number">58279753</item> <item key="first_name">qa</item> <item key="last_name">tester</item> <item key="org_name">Tucows</item> <item key="address1">96 mowat ave</item> <item key="city">toronto</item> <item key="state">ON</item> <item key="country">CA</item> <item key="postal_code">m3j2k4</item> <item key="phone">+1.4165550123 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="admin"> <dt_assoc> <item key="first_name">qa</item> <item key="last_name">tester</item> <item key="address1">96 mowat ave</item> <item key="city">toronto</item> <item key="state">ON</item> <item key="country">CA</item> <item key="postal_code">m3j2k4</item> <item key="phone">+1.4165550123 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="csr"> -----BEGIN CERTIFICATE REQUEST----- MIICwjCCAawCAQAwRDESMBAGA1UEAwwJZGVjMTQuY29tMQ8wDQYDVQQKDAZ0dWNv d3MxEDAOBgNVBAcMB3Rvcm9udG8xCzAJBgNVBAgMAm9uMIIBIjANBgkqhkiG9w0B AQEFAAOCAQ8AMIIBCgKCAQEAo++5TNqw9DIR3p0SM+fxfTEfYIOTHEeTkD9v6HV0 Oavasm3NfzcJIIS1TSxvPHOKc4mn8d+5/bXKVpTrMa+NoO+SgPLiBY99+4W7FptG cMy2pebFunTMnGc+uQ2IArHEjzcCL8nfWofSTQcm22QdFpas1PiEeZhLPIFRDPvo 1fjE4Q1XSTezeR8CTnArBSGNHoo20NaAlUnUU0tOc1X6REHc6QQWUdVDCO00Zk9T GQ+UdYK/Ea8AJ1EDFivVJ6xc8WIrTYawUzxmlBmKBzcZY2sB8rSK0MMPZAs/LC9w zXvN9akpfZ3bhf4HcIgEeMeN/Q6nqwq7BJ7fDetJyaIynwIDAQABoDswOQYJKoZI hvcNAQkOMSwwKjAdBgNVHQ4EFgQUS/siDy/VQf4NPQa8nD/+/rt98jMwCQYDVR0R BAIwADALBgkqhkiG9w0BAQsDggEBAB5RBRM3j7/pytXvYMj914bGcHqzc1FIkaeE BwJkA1VdMc5rildrSwgEfHgFPyf6P+HwxFuyPWF2VgWgxjTFtp9jYP1uPBWVaq+b 2rvlVIu5/ZyHT7iInyGnszrNWK3LgQdcUA7eVyckoVNrKVR5ErKUjFGsB6sRlR0I K/UUK21kCKyPFm882dPqyRoopNfoR31RVdHl0f2UL+DZnGXjVktvgVM69dQlZcZE Ydb3uZb7uA58447fiL3nfcyuMSSOfiAMm6xT1z7GbQuLerSxS1UIJPi1q/E+TBg8 Wkgj+3I4585ixhvj9oi9zk70yC+GbalUhnWcs2gU84t5ZHVX860= -----END CERTIFICATE REQUEST----- </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="attributes"> <dt_assoc> <item key="dv_auth_details"> <dt_assoc> <item key="dns_entry">dec14.com IN TXT actalis-dcv=hjnop0hbash5icmep3kuoq5d3f extra.dec14 .com IN TXT actalis-dcv=62umvh962n4ea7ekvjrr0he0r1</item> </dt_assoc> </item> <item key="state">awaiting-approval</item> <item key="domain">dec14.com </item> <item key="dv_auth_method">dns</item> <item key="order_id">62047</item> </dt_assoc> </item> <item key="is_success">1</item> <item key="protocol">XCP</item> <item key="object">TRUST_SERVICE</item> <item key="response_text">Command completed successfully.</item> <item key="action">SW_REGISTER:REPLY</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
New Order: product_type: actalis_ssl_ov_san (File Validation) RequestResponse
<?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">sw_register</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="reg_type">NEW</item> <item key="product_type">actalis_ssl_ov_san</item> <item key="handle">process</item> <item key="dv_auth_method">FILE</item> <item key="additional_domains"> <dt_array> <item key="0">extra.dec14 .com</item> </dt_array> </item> <item key="contact_set"> <dt_assoc> <item key="organization"> <dt_assoc> <item key="vat_number">5808530583</item> <item key="company_registration_number">58279753</item> <item key="first_name">qa</item> <item key="last_name">tester</item> <item key="org_name">Tucows</item> <item key="address1">96 mowat ave</item> <item key="city">toronto</item> <item key="state">ON</item> <item key="country">CA</item> <item key="postal_code">m3j2k4</item> <item key="phone">+1.4165550123 </item> <item key="email">[email protected]</item> </dt_assoc> </item> <item key="admin"> <dt_assoc> <item key="first_name">qa</item> <item key="last_name">tester</item> <item key="address1">96 mowat ave</item> <item key="city">toronto</item> <item key="state">ON</item> <item key="country">CA</item> <item key="postal_code">m3j2k4</item> <item key="phone">+1.4165550123 </item> <item key="email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> <item key="csr"> -----BEGIN CERTIFICATE REQUEST----- MIICwjCCAawCAQAwRDESMBAGA1UEAwwJZGVjMTQuY29tMQ8wDQYDVQQKDAZ0dWNv d3MxEDAOBgNVBAcMB3Rvcm9udG8xCzAJBgNVBAgMAm9uMIIBIjANBgkqhkiG9w0B AQEFAAOCAQ8AMIIBCgKCAQEAo++5TNqw9DIR3p0SM+fxfTEfYIOTHEeTkD9v6HV0 Oavasm3NfzcJIIS1TSxvPHOKc4mn8d+5/bXKVpTrMa+NoO+SgPLiBY99+4W7FptG cMy2pebFunTMnGc+uQ2IArHEjzcCL8nfWofSTQcm22QdFpas1PiEeZhLPIFRDPvo 1fjE4Q1XSTezeR8CTnArBSGNHoo20NaAlUnUU0tOc1X6REHc6QQWUdVDCO00Zk9T GQ+UdYK/Ea8AJ1EDFivVJ6xc8WIrTYawUzxmlBmKBzcZY2sB8rSK0MMPZAs/LC9w zXvN9akpfZ3bhf4HcIgEeMeN/Q6nqwq7BJ7fDetJyaIynwIDAQABoDswOQYJKoZI hvcNAQkOMSwwKjAdBgNVHQ4EFgQUS/siDy/VQf4NPQa8nD/+/rt98jMwCQYDVR0R BAIwADALBgkqhkiG9w0BAQsDggEBAB5RBRM3j7/pytXvYMj914bGcHqzc1FIkaeE BwJkA1VdMc5rildrSwgEfHgFPyf6P+HwxFuyPWF2VgWgxjTFtp9jYP1uPBWVaq+b 2rvlVIu5/ZyHT7iInyGnszrNWK3LgQdcUA7eVyckoVNrKVR5ErKUjFGsB6sRlR0I K/UUK21kCKyPFm882dPqyRoopNfoR31RVdHl0f2UL+DZnGXjVktvgVM69dQlZcZE Ydb3uZb7uA58447fiL3nfcyuMSSOfiAMm6xT1z7GbQuLerSxS1UIJPi1q/E+TBg8 Wkgj+3I4585ixhvj9oi9zk70yC+GbalUhnWcs2gU84t5ZHVX860= -----END CERTIFICATE REQUEST----- </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="attributes"> <dt_assoc> <item key="order_id">62048</item> <item key="dv_auth_method">file</item> <item key="domain">dec14.com </item> <item key="state">awaiting-approval</item> <item key="dv_auth_details"> <dt_assoc> <item key="file_contents">dec14.com :b35mr6mhngi470jsesc2fk3n3d extra.dec14 .com:62r6jgguhnkrhqcakvcpr18kd4</item> <item key="file_name">actalis.txt </item> </dt_assoc> </item> </dt_assoc> </item> <item key="is_success">1</item> <item key="protocol">XCP</item> <item key="response_text">Command completed successfully.</item> <item key="object">TRUST_SERVICE</item> <item key="action">SW_REGISTER:REPLY</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
* * *
Glossary
Product Types
Product TypeNameSignerOrganizationAdminTech
digicert_csc DigiCert Code Signing Certificate ✓
digicert_sslplus DigiCert SSL Plus Certificate ✓
digicert_sslplus_ev DigiCert SSL Plus EV Certificate ✓ ✓
digicert_sslplus_wildcard DigiCert SSL Plus Wildcard Certificate ✓
actalis_ssl_dv Actalis DV SSL Server Certificate ✓
actalis_ssl_dv_wildcard Actalis DV SSL Wildcard Certificate ✓
actalis_ssl_dv_san Actalis DV SSL Server Certificate with SAN ✓
actalis_ssl_ov Actalis OV SSL Server Certificate ✓ ✓
actalis_ssl_ov_wildcard Actalis OV SSL Wildcard Certificate ✓ ✓
actalis_ssl_ov_san Actalis OV SSL Server Certificate with SAN ✓ ✓
actalis_ssl_ev Actalis EV SSL Server Certificate ✓ ✓
actalis_ssl_ev_wildcard Actalis EV SSL Wildcard Certificate ✓ ✓
actalis_ssl_ev_san Actalis EV SSL Server Certificate with SAN ✓ ✓
securesite Secure Site Certificate ✓
securesite_ev Secure Site with EV Certificate ✓ ✓
securesite_ev_san Secure Site EV SAN ✓ ✓
securesite_pro Secure Site Pro Certificate ✓
securesite_pro_ev Secure Site with EV Certificate ✓ ✓
securesite_pro_ev_san Secure Site Pro EV SAN ✓ ✓
symantec_ssl_lite DigiCert SSL Lite Certificate ✓ ✓
symantec_ssl_lite_wildcard DigiCert SSL Lite Wildcard Certificate ✓ ✓
quickssl_premium GeoTrust QuickSSL Premium Certificate ✓
quickssl_premium_san QuickSSL Premium SAN ✓
rapidssl GeoTrust RapidSSL Certificate ✓
rapidssl_wildcard GeoTrust RapidSSL Wildcard Certificate ✓
truebizid GeoTrust True BusinessID Certificate ✓
truebizid_wildcard GeoTrust True BusinessID Wildcard Certificate ✓
truebizid_san TrueBusinessID SAN ✓
truebizid_ev GeoTrust True BusinessID with EV Certificate ✓ ✓
truebizid_ev_san TrueBusinessID EV SAN ✓ ✓
comodo_ev Sectigo EV SSL Certificate ✓ ✓ ✓
comodo_instantssl Sectigo InstantSSL Certificate ✓
comodo_premiumssl Sectigo PremiumSSL Certificate ✓
comodo_premiumssl_wildcard Sectigo PremiumSSL Wildcard Certificate ✓
comodo_ssl Sectigo SSL Certificate ✓
comodo_wildcard Sectigo SSL Wildcard Certificate ✓
essentialssl Sectigo EssentialSSL Certificate ✓
essentialssl_wildcard Sectigo EssentialSSL Wildcard Certificate ✓
positivessl Sectigo PositiveSSL Certificate ✓
positivessl_wildcard Sectigo PositiveSSL Wildcard Certificate ✓
ssl123 Thawte SSL123 Certificate ✓
sslwebserver Thawte SSL Web Server Certificate ✓
sslwebserver_san SSL Web Server Certificate with SAN ✓
sslwebserver_ev Thawte SSL Web Server Certificate with EV ✓ ✓
sslwebserver_ev_san SSL Web Server EV SAN ✓ ✓
sslwebserver_wildcard Thawte SSL Web Server Certificate Wildcard ✓
trustwave_dv Trustwave Domain-Vetted SSL Certificate ✓
trustwave_ev Trustwave Premium Extended Validation SSL Certificate ✓
trustwave_ev_san5 Trustwave Premium Extended Validation SSL Certificate with 5 SANs ✓
trustwave_premiumssl Trustwave Premium 256-Bit SSL Certificate ✓
trustwave_premiumssl_san5 Trustwave Premium 256-Bit SSL Certificate with 5 SANs ✓
trustwave_premiumssl_wildcard Trustwave Premium Wildcard 256-Bit SSL Certificate ✓
sitelock_911 SiteLock 911 ✓
sitelock_find SiteLock Find ✓
sitelock_fix SiteLock Fix ✓
sitelock_prevent SiteLock Prevent ✓
Server Types
ProviderServer Types
DigiCert
GeoTrust
Thawte apache—Apache
barracuda—Barracuda
cisco—Cisco
citrix—Citrix
citrixessentials—Citrix Access Essentials
citrixgateway4—Citrix Access Gateway 4.x
citrixgateway—Citrix Access Gateway 5.x and higher
cpanel—Cpanel
f5bigip—F5 Big-IP
f5firepass—F5 FirePass
ibmhttp—IBM HTTP
iis4—Microsoft IIS 1.x to 4.x
iis6—Microsoft IIS 5.x to 6.x
iis7—Microsoft IIS 7
iis8—Microsoft IIS 8
iis10—Microsoft IIS 10
iplanet—iPlanet Server 4.1
javawebserver—Java Web Server (Javasoft/Sun)
juniper—Juniper
lighttpd—Lighttpd
domino—Lotus Domino
macxserver—Mac OS X Server
msexchange2003—Microsoft Exchange Server 2003
msexchange2007—Microsoft Exchange Server 2007
msexchange2010—Microsoft Exchange Server 2010
msexchange2013—Microsoft Exchange Server 2013
msexchange2016—Microsoft Exchange Server 2016
mslcs2005—Microsoft Live Communications Server 2005
mslync2010—Microsoft Lync Server 2010
mslync2013—Microsoft Lync Server 2013
msocsr2—Microsoft OCS R2
msocs2007—Microsoft Office Communications Server 2007
mssbs2011—Microsoft Small Business Server 2008 & 2011
msuag—Microsoft Forefront Unified Access Gateway
netscape—Netscape Enterprise/FastTrack
nginx—Nginx
novell—Novell Web Server
novellichain—Novell iChain
oracle—Oracle
qmail—Qmail
sunone—SunOne
tomcat—Tomcat
weblogic7—Weblogic 7 and older
weblogic9—Weblogic 8 & 9
webstar—Webstar
zeusv3—Zeus v3+
other—Other
Sectigo apachessl—Apache + MOD SSL
citrix—Citrix
ensim—Ensim
hsphere—Hsphere
ibmhttp—IBM HTTP
iplanet—iPlanet Server 4.1
javawebserver—Java Web Server (Javasoft/Sun)
domino—Lotus Domino
iis4—Microsoft IIS 1.x to 4.x
iis6—Microsoft IIS 5.x to 6.x
iis7—Microsoft IIS 7
netscape—Netscape Enterprise/FastTrack
novell—Novell Web Server
oracle—Oracle
plesk—Plesk
redhat—RedHat Linux
sap—SAP Web Application Server
tomcat—Tomcat
webstar—Webstar
whmcpanel—WHM/cPanel
other—Other
TrustWave Not Applicable
SiteLock Not Applicable
Updated about 1 year ago
* * *
Table of Contents
Request parameters Request attributes
Response parameters Response attributes
Examples
Glossary Product Types
Server Types
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
TLD Data
Suggest Edits
Helpful Links
TLD policy articles
The tld_data associative array contains additional information that is required by some registries, such as the residency of the registrant.
For instance, .AU domains require eligibility information to demonstrate Australian presence and this information is provided within the tld_data associative array, under au_registrant_info.
The allowed values for tld_data are:
au_registrant_info—Eligibility requirements for .AU registrants.
br_register_number—Legal Brazilian identifier.
ipr_data—Sponsored Community information associated with .XXX domains.
it_registrant_info—Regional presence requirements for .IT domains.
nexus —American presence requirements for .US domains.
professional_data—The professional designation information that is associated with the .PRO domain.
registrant_extra_info—Additional parameters that are required by various domain registries.
See below for specific requirements for each TLD.
ie_cro_number— Irish Companies Registration Office number.
Requirement for .IE domains.
The tld_data information is used by the following commands: sw_register, modify domain, get domain, get_order_info, and trade domain (.FR only)..AERO
Registration of .AERO domains is restricted to members of the aviation community such as airlines, airports, and qualifying companies and individuals.
To prove that they meet the requirements, registrants must provide an Eligibility and Name Selection (ENS) ID and password, which can be obtained by applying to the registry through this site: https://information.aero /registration
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/Valuesw_register (request)
aero_ens_id Eligibility and Name Selection (ENS) identifier Required
aero_ens_password Eligibility and Name Selection (ENS) password Required
.AU .ASN.AU .COM.AU .ID.AU .NET.AU .ORG.AU
For more information please reference: .AU domain policies.
Parameters within the au_registrant_info associative array are described below.
Parameter nameDefinition/Valuesw_ register (request)get domain (response)get_order_info (response)
eligibility_id The identifier of the eligibility document.
Important: This number will be verified, and if you submit an incorrect number, the registration will fail.
Required for .ASN.AU , .COM.AU .NET.AU , .ORG.AU
Required for .AU if eligibility_type = Organization
Note: This value is optional for .ID.AU unless you specify an
eligibility_id_type, in which case this value is required.
Always returned Returned if submitted in the order
eligibility_id_type The Eligibility ID type.
The allowed values depend on the eligibility_type specified.
Allowed value for Charity is ABN.
Allowed value for Club is ABN.
Allowed value for
Incorporated Association is ABN.
Allowed value for Non- profit Organization is ABN.
Allowed value for Trade Union is OTHER.
Allowed value for Company is ACN or ABN.
Allowed value for Sole Trader is ABN.
Allowed value for Trademark Owner is TM.
Allowed value for Pending Trademark Owner is TM.
Allowed value for Partnership is ABN.
Required for .ASN.AU , .COM.AU .NET.AU , .ORG.AU
Required for .AU if eligibility_type = Organization Always returned Returned if submitted in the order
eligibility_name The name on the eligibility ID document.
Required for .ASN.AU , .COM.AU .NET.AU , .ORG.AU , and .AU
Required for .AU if eligibility_type = Organization Returned if submitted in the order Returned if submitted in the order
eligibility_type The reason that the registrant is eligible for the domain name.
The eligibility_type must correspond to the eligibility_name.
For example, if the registrant is using their company name to register the domain, then their eligibility_type is Company.
Allowed values for .ASN.AU and .ORG.AU domains are:
Charity
Club
Incorporated
Association
Non-profit
Organization
Trade Union
Allowed values for .COM.AU and .NET.AU domains are:
Company
Partnership
Pending TM Owner
Sole Trader
Trademark
Owner
Allowed value for .ID.AU domains is Citizen/Resident
Allowed Value for .AU is
Citizen/Resident Required for .ASN.AU , .COM.AU .NET.AU , .ORG.AU , .ID.AU , and .AU Always returned Always returned
policy_reason The name on the eligibility ID document.
Indicates the reason the registrant is entitled to the domain name.
Allowed values are:
1—The name exactly matches the acronym or abbreviation of the registrant's company or trading name, organization or association name, or trademark.
2—The name is connected closely and substantially to the registrant.
This is the default.
Required for .ASN.AU , .COM.AU , .NET.AU , and .ORG.AU
Required for .AU if eligibility_type = Organization Returned if submitted in the order Returned if submitted in the order
registrant_id The registrant identifier.
Must correspond to the registrant_id_type value (that is, the ABN or ACN),
Important: This number will be verified, and if you submit an incorrect number, the registration will fail.
Required if
registrant_ id_type = ACN or ABN
Required for .AU if eligibility_type = Organization Always returned Always returned
registrant_id_type The Registrant ID type.
Allowed values are:
ACN—Australian Company Number
ABN—Australian Business Number Required for .ASN.AU , .COM.AU , .NET.AU , and .ORG.AU
Required for .AU if eligibility_type = Organization Always returned Always returned
registrant_name The legal entity such as a company, incorporated association, government agency or individual person.
Cannot be a registered business name or trademark.
Required for .ASN.AU , .COM.AU .NET.AU , .ORG.AU , ID.AU , and .AU Always returned Always returned
priority_contact_id Registrants wishing to obtain a license for a .AU domain will have to submit this value if there is an existing 3rd level domain with the same name.
This information can be obtained from auDA via the provided Priority Status Tool Required for all 2nd level .AU domains if there is an existing 3rd level domain registered with the same name.
Returned if submitted in the order Returned if submitted in the order
priority_auth_info Registrants wishing to obtain a license for a .AU domain will have to submit this value if there is an existing 3rd level domain with the same name.
This information can be obtained from auDA via the provided Priority Status Tool Required for all 2nd level .AU domains if there is an existing 3rd level domain registered with the same name.
Returned if submitted in the order Returned if submitted in the order
.CA
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/Valuesw_register (request)trade domain (request)get domain (response)get_order_info (response)
legal_type legal_type is required for both transfers and new registrations.
Possible values are as follows
ABO—Aboriginal
ASS—Association
CCO—Canadian Corporation
CCT—Canadian Citizen
EDU—Educational Institution
GOV—Government
HOP—Hospital
INB—Indian Band
LAM—Library, Archive, or Museum
LGR—Legal Representative
MAJ—His Majesty the King
OMK—Protected by Trademarks Act
PLT—Political Party
PRT—Partnership
RES—Permanent Resident
TDM—Trademark Owner
TRD—Trade Union
TRS—Trust
Please note:
To change the legal_type of a .CA domain during a transfer from another registrar, you must also submit the change_contact parameter.
Required Required Returned if applicable and is_success = true Returned if is_success = true
.CL
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/ Valuesw_ register (request)trade domain (request)get domain (response)get_order_info (response)
id_card_number The number of the individual's identity card.
Optional: can be submitted when registrant_ type = individual Optional: can be submitted when registrant_ type = individual Returned if applicable and is_success = true Returned if applicable and is_success = true
registrant_type The entity type of registrant.
Allowed values are individual or organization.
Required Required Returned if
is_success = true Returned if
is_success = true
registrant_vat_id Value Added Tax registration number.
Optional: can be submitted when registrant_ type = organization Optional: can be submitted when registrant_ type = organization Returned if applicable and is_success = true Returned if applicable and is_success = true
.COM.AR .PT .COM.PT
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/ Valuesw_ register (request)trade domain (request)get domain (response)getorder info (response)
id_card_number The number of the individual's identity card.
Required when
registrant_ type = individual Required when
registrant_ type = individual Returned if
is_success = true Returned if
is_success = true registrant_ type = individual
registrant_type The entity type of registrant.
Allowed values are individual or organization.
Required Required Returned if
is_success = true Returned if
is_success = true
tax_number The number used for tax purposes.
Required Required Returned if
is_success = true Returned if
is_success = true
.COM.BR
Parameters within the tld_data associative array are described below.
Parameter namename Definition/Valuesw_ register (request)get domain (response)getorder info (response)
br_register_number The Brazilian legal identifier.
For organizations, this is the SNPJ (Business Identifier/Cadastro Nacional de Pessoa Juridica)
For individuals, this is the CPF (Individual Tax Number/Cadastro de Pessoa Fisica) Required Returned if
is_success = true Returned if
is_success = true
.COOP
Registration of .COOP domains is restricted to cooperatives and related organizations.
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/ Valuesw_ register (request)modify domain (request)get domain (response)getorder info (response)
coopverification code The coop verification code (CVC) is issued by dotCoop, and proves that the registrant is eligible to register the domain name.
Required Required Returned if
is_success = true Returned if
is_success = true
.ES
Registration of a .es domain requires validation by identification number ( in most cases an NIF or NIF number)
If registrant_extra_info is not provided in the API, or the es_id_type='other', the default values which will be provided to the registry are as follows:
EsTipoIdentificacion => 0 (other)
EsIdentificacion => "111111"
Parameters within the registrant_extra_info associative array are described below.
Parameter nameObligationDefinition/Valuesw_registerget_order_info
es_id_type Required.
Possible values include:
Other
NIE
NIF Required.
Returned if
is_success = true.
es_id_number Required if es_id_type is NIF or NIE The NIE or NIF number.
Required.
Returned if
is_success = true..EU
As of October 19th 2019, EU Citizens (Natural Persons) situated outside the EU must specify an EU country of citizenship
Parameter nameObligationsw_registermodifyupdate_contacts
country_of_citizenship Allowed Values
AT
BE
BG
CY
CZ
DE
DK
EE
ES
FI
FR
GR
HR
HU
IE
IS
IT
LI
LT
LU
LV
MT
NL
NO
PL
PT
RO
SE
SI
SK Required if Owner Contact is Blank & Owner Country is not in EU.
Required if Owner Contact is Blank & Owner Country is not in EU.
Required if Owner Contact is Blank & Owner Country is not in EU..DE
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/ Valuesw_register (request)get domain (response)get_order_info (response)
registrant_type The entity type of registrant.
Allowed values are individual or organization.
Required Returned if
is_success = true Returned if
is_success = true
.DK
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/ Valuesw_register (request)trade domain (request)get domain (response)getorder info (response)
registrant_type The entity type of
registrant.
Allowed values are individual or organization.
Required Required Returned if
is_success = true Returned if
is_success = true
registrant_vat_id Value Added Tax
registration number.
Required when registrant_ type = organization Required when
registrant_ type = organization Returned if is_success = true and type = organization Returned if is_success = true and type = organization
.FI .MY .SG
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/Valuesw_register (request)trade domain (request)get domain (response)getorder info (response)
id_card_number The number of the
individual's identity card.
Required when registrant_ type = organization Required when registrant_ type = organization Returned if
is_success = true and registrant_ type = individual Returned if
is_success = true and registrant_ type = individual
registrant_type The entity type of
registrant.
Allowed values are individual or organization.
Required Required Returned if
is_success = true Returned if
is_success = true
registration_number The business number of the
organization.
Required when
registrant_ type = organization Required when
registrant_ type = organization Returned if
is_success = true and registrant_ type = organization Returned if
is_success = true and registrant_ type = organization
date_of_birth .FI Only
Date of birth of registrant, format is YYYY-MM-DD Required when registrant_type = individual Required when registrant_type = individual Returned if type = all_info and is_success = true Returned if is_success = true
.FR
.FR domains are available to any individuals and organizations located in the European Union, Switzerland, Norway, Iceland, or Liechtenstein.
Individuals must reside within one of the qualifying countries; organizations must have their registered or main office located in a qualifying country; therefore, when registering or transferring .FR domains, you must provide additional residency information.
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/Valuesw_ register (request)get_order_info (response)trade domain (request)
registrant_type The entity type of registrant.
Allowed values are individual and organization.
Required Always returned Required
registrant_vat_id The Value Added Tax (VAT) number of the organization.
Optional, but recommended for organizations located in France Returned if submitted in the order Optional, but recommended for organizations located in France
siren_siret The 9 digit SIREN code or the 14 digit SIRET code that is used to identify the business for tax reasons.
Optional, but recommended for organizations located in France Returned if submitted in the order Optional, but recommended for organizations located in France
trademark_number The organization's trademark registrationnumber,if applicable.
Optional, but recommended for organizations located in France Returned if submitted in the order Optional, but recommended for organizations located in France
.HK
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/ Valuesw_ register (request)trade domain (request)get domain (response)getorder info (response)
date_of_birth The registrant's
date of birth in the format YYYY-MM-DD.
Required when registrant_ type = individual Required when registrant_ type = individual Returned if is_success = true and registrant_ type = individual Returned if is_success = true and registrant_ type = individual
id_card_number The number of the
individual's identity card.
Required when registrant_ type = individual Required when registrant_ type = individual Returned if
is_success = true and registrant_ type = individual Returned if
is_success = true and registrant_ type = individual
registrant_type The entity type of
registrant.
Allowed values are individual and organization.
Required Required Returned if
is_success = true Returned if
is_success = true
registration_number The business number of the organization.
Required when registrant_ type = organization Required when registrant_ type = organization Returned if
is_success = true and registrant_ type = organization Returned if
is_success = true and registrant_ type = organization
.HU .CO.HU
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/ Valuesw_ register (request)trade domain (request)get domain (response)getorder info (response)
id_card_number The number of the individual's identity card Required when registrant_ type = individual Required when registrant_ type = individual Returned if is_success = true and registrant_type = individual Returned if is_success = true and registrant_type = individual
registrant_type The entity type of registrant.
Allowed values are individual or organization.
Required Required Returned if
is_success = true Returned if
is_success = true
registrant_vat_id Value Added Tax registration number.
Required when
registrant_ type = organization Required when
registrant_ type = organization Returned if
is_success = true and registrant_ type = organization Returned if
is_success = true and registrant_ type = organization
.IL
For more information, please see the OpenSRS Domain Policies .IL documentation..IT
Parameters within the it_registrant _info associative array are described below.
Parameter nameDefinition/Valuesw_ register (request)get domain (response)getorder info (response)
entity_type The legal entity type of registrant.
Allowed values are:
1—Italian and foreign natural persons
2—Companies/one man companies
3—Freelance workers/professiona ls
4—Non-profit organizations
5—Public organizations
6—Other subjects
7—Foreigners who match 2-6 Required Always returned Always returned
nationality_code The 2-digit ISO 3166-1 code that identifies the Registrant's nationality.
If entity_type = 1, nationality or owner's country or both must be an EU country.
If entity_type = 2-6, this value must be IT.
If entity_type = 7, this value must match owner's country and must be an EU country other than IT.
Note: Be sure to use capital letters.
Optional Returned if submitted in order Returned if submitted in order
reg_code An identifying number, usually the VAT or Codice Fiscale (numeric tax code).
The value that you need to enter depends on the entity type of the registrant.
Italian citizens must enter their Codice Fiscale.
Non Italians not living in Italy can enter a document number.
Italian companies, freelancers, and other subjects must enter their 11 digit VAT number or tax identification number.
Italian non-profit organizations must enter their VAT number or tax identification number.
Non Italian entities other than persons (organizations, freelancers, companies, etc.) may enter their VAT number.
Required Always returned Always returned
.JOBS
Registration of .JOBS domains is restricted to those who are involved in Human Resource management.
To be eligible, registrants must be a member of the Society for Human Resource Management (SHRM) or involved in HR practices that meet any of the following criteria:
Possess salaried-level human resource management experience.
Are certified by the Human Resource Certification Institute.
Are supportive of the SHRM Code of Ethical and Professional Standards in Human Resource Management, as amended from time to time.
Consequently, when registering a .JOBS domain, registrants must complete some additional information.
For more information on the restrictions and policies regarding .JOBS registrations, see http://www.policy .jobs/
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/Valuesw_register (request)modify domain (request)get domain (response)
jobs_admin_type Indicates whether the registrant is the Admin contact.
Allowed values are Yes or No Required Required Always returned
jobs_association_member Indicates whether the registrant is a member of SHRM.
Allowed values are Yes or No Required Required Always returned
jobs_industry_type The type of business.
Optional Optional Returned if submitted in order
jobs_title The registrant's job title.
Optional Optional Returned if submitted in order
jobs_website The URL for the registrant's company.
Required Required Always returned
.LAW .ABOGADO
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/ Valuesw_ register (request)
qli_accreditation_id Qualified Lawyer's Accreditation ID Required
qli_accreditation_body Qualified Lawyer's Accreditation Body Required
qli_jurisdiction_country Accreditation Jurisdiction Country.
Allowed value is an uppercase 2-letter ISO country code.
Must be one of the following:
AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BX, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, EU, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, OT, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZR, ZW Required
qli_jurisdiction_state Accreditation Jurisdiction State/Province Optional
qli_accreditation_year Qualified Lawyer's Accreditation Year.
Allowed value is 4 digits.
Required
.LV .COM.LV
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/Valuesw_register (request)modify domain (request)get domain (response)getorder info (response)
id_card_number The number of the individual's
identity card.
Required when registrant_ type = individual Required when registrant_ type = individual Returned if is_success = true and registrant_ type = individual Returned if is_success = true and registrant_ type = individual
registration_number The business number of the organization.
Required when registrant_type = organization Required when registrant_type = organization Returned if is_success = true and registrant_ type = organization Returned if is_success = true and registrant_ type = organization
registrant_type The entity type of registrant.
Allowed values are: individual
organization Required Required Returned if
is_success =
true Returned if
is_success =
true
registrant_vat_id The Value Added Tax (VAT) number of the organization Required when registrant_type = organization Required when registrant_type = organization Returned if
is_success =
true and
registrant_
type =
organization Returned if
is_success =
true and
registrant_
type =
organization
.MX .COM.MX .CO.ZA
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/ Valuesw_ register (request)modify domain (request)get domain (response)getorder info (response)
registrant_type The entity type of registrant.
Allowed values are:
individual
organization Required Required Returned if
is_success =
true Returned if
is_success =
true
.NO
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/ Valuesw_ register (request)trade domain (request)get domain (response)getorder info (response)
registration_number Norwegian company register number.
This number can be verified [here].(https://w2.brreg .no/enhet/sok/index.jsp ).
Required Required Returned if is_success = true Returned if is_success = true
.NYC
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/ Valuesw_ register (request)get domain (response)get_order_info (response)
registrant_type The entity
type of
registrant.
Allowed values
are individual
or
organization.
Required Returned if
is_success =
true Returned if
is_success =
true
.PM .RE .TF .WF .YT
Parameters within the registrant_extra_info associative array are described
below.
Parameter nameDefinition/ Valuesw_ register (request)trade domain (request)get domain (response)getorder info (response)
registrant_type The entity
type of
registrant.
Allowed values
are individual
and
organization.
Required Required Returned if
is_success =
true Returned if
is_success =
true
registrant_vat_id The Value
Added Tax
(VAT) number
of the
organization.
Optional.
May
be used when
registrant_
type =
organization Optional.
May
be used when
registrant_
type =
organization Returned if
is_success =
true if
submitted in
the order Returned if
is_success
= true if
submitted
registration_number The business
number of the
organization.
Optional, but
recommended
for
organizations
located in
France Optional, but
recommended
for
organizations
located in
France Returned if
is_success =
true if
submitted in
the order Returned if
is_success
= true if
submitted in
the order
trademark_number The number
assigned to
the
organization’s
pending or
registered
trademark.
Optional but
recommended
when
registrant_
type =
organization Optional but
recommended
when
registrant_
type =
organization Returned if
is_success =
true if
submitted in
the order Returned if
is_success
= true if
submitted in
the order
.PRO
In order to register a .PRO domain name, the registrant must belong to an
accredited profession.
Parameters within the professional_data associative array are described
below.
Parameter nameDefinition/Valuesw_ register (request)modify domain (request)get domain (response)get_order _info (response)
authority The name of the authority from which the registrant receives their professional credentials.
Optional Optional Returned if submitted
in order Returned if submitted
in order
authority_website The URL to an online
resource for the authority, preferably, a member search directory.
Optional Optional Returned if submitted
in order Returned if submitted
in order
license_number The license number of the registrant's credentials, if applicable.
Optional Optional Returned if submitted
in order Returned if submitted
in order
profession The stated profession of
the registrant.
Required Required Always
returned Always
returned
.RO .COM.RO
Parameters within the registrant_extra_info associative array are described
below.
Parameter nameDefinition/ Valuesw_ register (request)trade domain (request)get domain (response)getorder info (response)
id_card_number The number of
the individual's
identity card.
Required when
registrant_
type = individual Required when
registrant_
type = individual Returned if is_success = true and
registrant_type =
individual Returned if
is_success = true and
registrant_type =
individual
registration_number The business number of the organization.
Required when registrant_type = organization Required when
registrant_type = organization Returned if
is_success = true and
registrant_type =
organization Returned if
is_success = true and
registrant_type =
organization
registrant_type The entity type of
registrant.
Allowed values are individual or
organization.
Required Required Returned if
is_success = true Returned if
is_success = true
registrant_vat_id The Value Added Tax
(VAT) number of the
organization Required when
registrant_type =
organization Required when
registrant_type =
organization Returned if
is_success = true and
registrant_type =
organization Returned if
is_success = true and
registrant_type =
organization
.RU
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition /Valuesw_ register (request)trade domain (request)get domain (response)getorder info (response)
date_of_birth The registrant's
date of birth in the
format YYYY-MMDD.
Required when
registrant_type = individual Required when
registrant_type =
individual Returned if is_success = true and registrant_type =
individual Returned if is_success =true and registrant_type =
individual
id_card_authority The name of the issuer.
Required when
registrant_type = individual Required when
registrant_type =
individual Returned if is_success = true and registrant_type =
individual Returned if is_success = true and
registrant_type =
individual
id_card_issue_date The date that the ID card was issued, in the format
YYYY-MMDD Required when registrant_type =
individual Required when registrant_type =
individual Returned if
is_success = true and
registrant_type =
individual Returned if is_success = true and registrant_type =
individual
id_card_number The number of the
individual's identity
card.
Required when
registrant_type =
individual Required when
registrant_type =
individual Returned if
is_success = true and
registrant_type =
individual Returned if
is_success = true and
registrant_type = individual
place_of_birth The city in which the
individual was born.
Required when
registrant_type =
individual Required when
registrant_type =
individual Returned if
is_success = true and
registrant_type =
individual Returned if
is_success = true and
registrant_type =
individual
registrant_type The entity type of registrant.
Allowed values are individual
and organization.
Required Required Returned if is_success = true Returned if is_success = true
.SE .NU
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/ Valuesw_ register (request)trade domain (request)get domain (response)getorder info (response)
id_card_number The number of
the individual's
identity card.
Required when registrant_type =
individual Required when
registrant_type =
individual Returned if is_success = true and registrant_type =
individual Returned if is_success = true and registrant_type =
individual
registrant_type The entity
type of
registrant.
Allowed values
are
individual or
organization.
Required Required Returned if
is_success = true Returned if
is_success = true
registrant_vat_id The Value
Added Tax
(VAT) number
of the
organization Required when
registrant_type =
organization Required when
registrant_type =
organization Returned if is_success = true and registrant_type = organization Returned if is_success = true and registrant_type = organization
registration_number The business
number of the
organization Required when
registrant_type =
organization Required when
registrant_type =
organization Returned if is_success = true and
registrant_type =
organization Returned if is_success = true and
registrant_type =
organization
.TRAVEL
In order to register a .TRAVEL domain name, the registrant must be a participant in the travel and tourism industry, and they must have a Unique Identifying Number (UIN).
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/Valuesw_ register (request)modify domain (request)get domain (response)get_order _info (response)
travel_uin The Unique Identifying
Number that proves the
registrant is a participant in the travel and tourism
industry Optional Optional Returned if
submitted
in order Returned if
submitted
in order
.UK .CO.UK .ORG.UK
Parameters within the registrant_extra_info associative array are described below.
Parameter nameDefinition/Valuesw_ register (request)modify domain (request)get domain (response)get_order _info (response)
registrant_type CRC
FCORP
FIND
FOTHER
GOV
IND
IP
LLP
LTD
OTHER
PLC
PTNR
RCHAR
SCH
STAT
STRA Required Required Required Required
registration_number Organization ID issued by the government.
registrant type =
LTD
PLC
LLP
IP
SCH
RCHAR registrant type =
LTD
PLC
LLP
IP
SCH
RCHAR registrant type =
LTD
PLC
LLP
IP
SCH
RCHAR registrant type =
LTD
PLC
LLP
IP
SCH
RCHAR
trading_name The trading name of the organization.
Required if registrant type = LTD
PLC
LLP
IP
RCHAR
FCORP
OTHER
FOTHER
STRA Required if registrant type = LTD
PLC
LLP
IP
RCHAR
FCORP
OTHER
FOTHER
STRA Required if registrant type = LTD
PLC
LLP
IP
RCHAR
FCORP
OTHER
FOTHER
STRA Required if registrant type = LTD
PLC
LLP
IP
RCHAR
FCORP
OTHER
FOTHER
STRA
.UK registrant_type
Registrant Type CodeDefinition/Value
CRC UK Corporation by Royal Charter
FCORP Non-UK Corporation
FIND Foreign Individual
FOTHER Non-UK Entity that does not fit another category
GOV Uk Government Body
IND Individual
IP UK Industrial/Provident Registered Company
LLP UK Limited Liability Partnership
LTD UK Limited Company
OTHER UK Entity that does not fit another category
PLC UK Public Limited Company
PTNR UK Partnership
RCHAR UK Registered Charity
SCH UK School
STAT UK Statutory Body
STRA UK Sole Trader
.US
Parameters within the nexus associative array are described below.
Parameter nameDefinition/Valuesw_ register (request)modify domain (request)get domain (response)get_order _info (response)
app_purpose A description of the
domain's application
purpose:
_ P1—Business use
for profit.
_ P2—Non-profit
business, club,
association,
religious organization, and so on.
_ P3—Personal use.
_ P4—Education
purposes.
* P5—Government
purposes.
Required Required Always
returned Always
returned
category A description of the
domain's nexus category:
_ C11—A citizen of the U.S .
or any of
its territories.
_ C12—A permanent resident of the U.S .
or any of its
territories.
_ C21—An
organization incorporated within the U.S .
_ C31—An entity that regularly engages in
lawful activities in
the U.S .
* C32—An entity that has an office or
other facility in the
U.S .
Required Required Always
returned Always
returned
validator The domain owner's
country of citizenship.
Value must be a valid two letter country code.
Required if category =
C31 or C32 Required if category =
C3 or C32 Returned if category =
C31 or C32 Returned if category =
C31 or C32
.XXX
.XXX domains are available to those within the adult entertainment industry who are members of the Sponsored Community (SC).
The ipr_data associative array contains information to prove that the registrant is a member of the Sponsored Community.
Parameters within the ipr_data associative array are described below.
Parameter nameDefinition/Valuesw_ register (request)modify domain (request)get domain (response)get_order _info (response)
icm_membership_id The ID number that was provided when the
registrant successfully
completed the XXX
Sponsored Community
validation process.
If this
value is not submitted with the domain registration, the registry will contact the registrant with instructions on how to become a member of the Sponsored Community.
If you submit this value,
you do not need to submit any of the other ipr_data values.
Optional Optional Returned if
submitted
in the order Returned if
submitted
in the order
ipr_email The email address to which all communications from
the registry will be
addressed.
Optional N/A N/A N/A
ipr_name The name (in the format
firstname lastname) to
which all communications
from the registry will be
addressed.
Optional N/A N/A Returned if
submitted
in the
order
ipr_non_resolver When this value is set to 1 the domain will not
resolve.
Optional N/A N/A N/A
Updated about 1 month ago
* * *
Table of Contents
Helpful Links
.AERO
.AU .ASN.AU .COM.AU .ID.AU .NET.AU .ORG.AU
.CA
.CL
.COM.AR .PT .COM.PT
.COM.BR
.COOP
.ES
.EU
.DE
.DK
.FI .MY .SG
.FR
.HK
.HU .CO.HU
.IL
.IT
.JOBS
.LAW .ABOGADO
.LV .COM.LV
.MX .COM.MX .CO.ZA
.NO
.NYC
.PM .RE .TF .WF .YT
.PRO
.RO .COM.RO
.RU
.SE .NU
.TRAVEL
.UK .CO.UK .ORG.UK
.US
.XXX
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
trade_domain
Transfers ownership of a domain name from one registrant to another.
This command may be used for the following domains: .CL, .COM.AR , .DK, FI, .FR, .HK, .HU, .MY, .NO, .NU, .PM, .RE, .RO, .RU, .SE, .SG, .TF, .WF, and .YT.
Suggest Edits
Request parameters for trade_domain
Standard parameters
action = trade_domain
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
address1 Required for all except .BE.
The street address of the new owner.
city Required for all except .BE.
The new owner’s city.
country Required for all except .BE.
The new owner’s country.
domain Required The domain that is being traded.
domain_auth_info Required for .BE The domain's Authcode.
To request an Authcode you can use the send_authcode command; the Authcode is sent to the domain's admin contact.
email Required The new owner’s email address.
first_name Required The first name of the new owner.
last_name Required The last name of the new owner
org_name Required The name of the new owner’s organization.
phone Required for all except .BE.
The new owner’s phone number.
postal_code Required for all except .BE.
The new owner’s postal code.
state Required for all except .BE.
The new owner’s state.
tld_data Required for all except .BE.
An associative array containing the except .BE.
registrant_extra_info associative array
which submits additional parameters that are required by various domain registries.
For more information, see the TLD Data section.
Response parameters for trade_domain
Standard parameters
action = reply
object = domain
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 trade_domain
Example 1
Transfers ownership of a .BE domain.
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">TRADE_DOMAIN</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="first_name">Simon</item> <item key="last_name">Dubois</item> <item key="domain">js4.be </item> <item key="email">[email protected]</item> <item key="org_name">Example Co.</item> <item keyi="domain_auth_info">ewgnRwnH</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">DOMAIN</item> <item key="response_text">Command completed successfully OK</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="registry_response_code">1000</item> <item key="response_text">Trade for js4.be has been successfully issued.</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
Transfers ownership of a .DK domain
Request
<?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">TRADE_DOMAIN</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="org_name">Example Co.</item> <item key="domain">example.dk </item> <item key="first_name">Daniel</item> <item key="last_name">Jensen</item> <item key="address1">Gammel Kongevej 1</item> <item key="city">Copenhagen V</item> <item key="state" /> <item key="country">DK</item> <item key="postal_code">1610</item> <item key="phone">+1.33257400 </item> <item key="email">[email protected]</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="registrant_type">individual</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="action">REPLY</item> <item key="object">DOMAIN</item> <item key="response_text">Trade for example.dk has been successfully issued.</item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 3
Transfers ownership of a .FR domain.
Request
<?xml version='1.0 ' encoding='UTF-8'?> <OPS_envelope> <header> <version>0.9 </version> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">TRADE_DOMAIN</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">example.fr </item> <item key="first_name">Henri</item> <item key="last_name">LeFluer</item> <item key="address1">13 Rue Daze</item> <item key="city">Paris</item> <item key="state" /> <item key="country">FR</item> <item key="postal_code">75002</item> <item key="org_name">French Impressions</item> <item key="phone">+1.3365551212 </item> <item key="email">[email protected]</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="date_of_birth">1979-03-03</item> <item key="place_of_birth">Paris</item> <item key="country_of_birth">FR</item> <item key="postal_code_of_birth">75008</item> <item key="registrant_type">individual</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="action">REPLY</item> <item key="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Trade for example.fr has been successfully issued.</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 4
Transfers ownership of a .COM.AR domain
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">TRADE_DOMAIN</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="first_name">Daniela</item> <item key="last_name">Sosa</item> <item key="address1">Piedras No 623</item> <item key="city">San Sebastian</item> <item key="state" /> <item key="postal_code">B1000TBU</item> <item key="country">AR</item> <item key="org_name">Sosa Informatica S.A .</item> <item key="domain">example.com .ar</item> <item key="phone">+1.4165350123 </item> <item key="email">[email protected]</item> <item key="tld_data"> <dt_assoc> <item key="registrant_extra_info"> <dt_assoc> <item key="tax_number">27-10563145-8</item> <item key="id_card_number">10563145</item> <item key="registrant_type">individual</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="action">REPLY</item> <item key="object">DOMAIN</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Trade for example.com .ar has been successfully issued.</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 2 years ago
* * *
Table of Contents
Request parameters for trade_domain
Standard parameters
Attributes
Response parameters for trade_domain
Standard parameters
Examples for trade_domain
Example 1
Example 2
Example 3
Example 4
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Transfer Event: message_status_change
Suggest Edits
Response Parameters for message_status_change (transfer event)
If the request is successful, the attributes associative array may include the
following:
Parameter nameObligationDefinition/Value
message_status Always returned The updated status of the message.
Possible values are:
Queued
Sent
* Bounced
message_type Always returned The type of message.
reference_id Always returned The unique message ID.
Example Response for message_status_change (transfer event)
<?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">EVENT</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="transaction_id">2016-12-02 15:24:56 10026 101</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="events"> <dt_array> <item key="0"> <dt_assoc> <item key="object_data"> <dt_assoc> <item key="domain_name">somedomain.com </item> <item key="message_type">enduser.icann .trade.new .registrant.approval </item> <item key="domain_id">310499</item> <item key="message_status">QUEUED</item> <item key="reference_id">7814e71bb27b751a33bd79555c08e7546b70ce9b4156cbdea8284864b01733cd104a36e1</item> <item key="to_address">[email protected]</item> </dt_assoc> </item> <item key="object">DOMAIN</item> <item key="event_id">d417c52e31e3ff537a034e982546b64f</item> <item key="event">MESSAGE_STATUS_CHANGE</item> <item key="event_date">2016-12-02T20:24:27Z</item> </dt_assoc> </item> </dt_array> </item> <item key="total">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Response Parameters for message_status_change (transfer event)
Example Response for message_status_change (transfer event)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Transfer Event: status_change
This event notification will be generated when there is an update to the status of a domain transfer.
Suggest Edits
Response Parameters for status_change (transfer)
If the request is successful, the attributes associative array may include the following:
Parameter nameObligationDefinition/Value
transfer_status Always returned.
The updated status of the transfer.
Possible values include:
cancelled
completed
pending_admin
cancel_icann_trade
pending_owner
pending_registry
Example Response for status_change
<?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">EVENT</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="transaction_id">2014-06-19 11:34:16 27657 101</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="events"> <dt_array> <item key="0"> <dt_assoc> <item key="object_data"> <dt_assoc> <item key="domain_name">tucows-2ad844aa412e6.com </item> <item key="transfer_id">95094</item> <item key="order_id">701988</item> <item key="transfer_status">pending_owner</item> </dt_assoc> </item> <item key="object">TRANSFER</item> <item key="event_id">21bd704aba7804b839f87aee292fcf72</item> <item key="event">STATUS_CHANGE</item> <item key="event_date">2014-06-19T15:34:01Z</item> </dt_assoc> </item> </dt_array> </item> <item key="total">11</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Response Parameters for status_change (transfer)
Example Response for status_change
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Troubleshooting HTTPS Post
Suggest Edits
401 Authentication Error
Check that you are using the correct API Key for each system – Production or Horizon.
The private keys are different in both systems and will need to be retrieved from each system individually.
Check that you have the correct RSP username.
Check that the IP address of the machine transmitting the data to the OpenSRS server is in your list of allowed IP addresses in the Reseller Web Interface.
📘Note
IP changes take up to 15 mins to take affect.
If the above checks are correct, check the MD5:
Ensure that you have concatenated the XML content and the Private Key
Ensure that you have performed an MD5 twice.
See the MD5 section for more information.
Ensure that your HTTP Post implementation is not adding any extra information.
Some implementations of HTTP Post add a NULL to the end of the HTTP Request.
This is reflected in the MD5 and causes an authentication error.
Ensure that the result is in lowercase before sending it to OpenSRS.
Some MD5 algorithms put the MD5 hash in uppercase.
Some MD5 algorithms need to convert the string to bytes before generating the hash.
Make sure this is done properly.
You can test your script by performing an MD5 on the following text:
Text: ConnecttoOpenSRSviaSSL
MD5 Result: e787cc1d1951dfec4827cede7b1a0933
Invalid XML Response
Make sure you are sending the XML.
The XML used in the MD5 is only for authentication purposes.
You must also send the XML as part of the content header.
Further troubleshooting
If you are still having issues connecting to our API or even the web interface, please run these commands from the server/computer you are connecting from and email the output to OpenSRS support.
The XML API port is 55443
Commands to run
curl http://icanhazip.com /s/ OR wget -q -O - http://icanhazip.com /s/ ping rr-n1-tor.opensrs .net traceroute rr-n1-tor.opensrs .net openssl s_client -connect rr-n1-tor.opensrs .net:55443
📘HRS customers:
Be sure to replace rr-n1-tor.opensrs .net with the API URL that was provided to you.
What we are testing for
The curl and the wget commands are to obtain the IP address of the computer/server that you are connecting from.
Depending on what is enabled on your computer/server, one of the commands should return the IP address.
This step is to verify that the IP address returned is the same one whitelisted in in the Reseller Control Panel.
📘HRS Customers:
Whitelisting an IP in your own HRS instance is not enough.
You will also need to contact OpenSRS Support to be whitelisted in our firewall.
ping rr-n1-tor.opensrs .net
Expected output
PING rr-n1-tor.opensrs .net (216.40 .33.39 ) 56(84) bytes of data.
64 bytes from rr-n1-tor.opensrs .net (216.40 .33.39 ): icmp_seq=1 ttl=253 time=1.38 ms
If the ping doesn't work
There is likely a problem with your network.
It's highly unlikely that the OpenSRS API isn't reachable.
HRS Customers: It's possible that the external connections have not been opened and this might be a firewall related.
Send us a trace route:
traceroute rr-n1-tor.opensrs .net
Expected output
traceroute rr-n1-tor.opensrs .net traceroute to rr-n1-tor.opensrs .net (216.40 .33.39 ), 30 hops max, 60 byte packets 1 123.125 .51.1 (123.125 .51.1 ) 0.881 ms 1.227 ms 2.712 ms 2 123.78 .201.2 (123.78 .201.2 ) 0.784 ms 0.768 ms 100.78 .201.3 (100 ...
15 ...
rr-n1-tor.opensrs .net (216.40 .33.39 ) 29.723 ms 29.694 ms 29.604 ms
Are you able to connect to the API host/port ?
openssl s_client -connect rr-n1-tor.opensrs .net:55443
Expected output
CONNECTED(00000003) depth=2 C = US, O = GeoTrust Inc., CN = GeoTrust Global CA verify error:num=20:unable to get local issuer certificate verify return:0 --- Certificate chain 0 s:/C=CA/ST=Ontario/L=Toronto/O=Tucows, Inc./CN=*.opensrs.net i:/C=US/O=GeoTrust Inc./CN=GeoTrust SSL CA - G3 1 s:/C=US/O=GeoTrust Inc./CN=GeoTrust SSL CA - G3 i:/C=US/O=GeoTrust Inc./CN=GeoTrust Global CA 2 s:/C=US/O=GeoTrust Inc./CN=GeoTrust Global CA i:/C=US/O=Equifax/OU=Equifax Secure Certificate Authority --- Server certificate -----BEGIN CERTIFICATE----- MIIE3DCCA8SgAwIBAgIQQx0R1BnpAT2POz65f8LyzDANBgkqhkiG9w0BAQsFADBE MQswCQYDVQQGEwJVUzEWMBQGA1UEChMNR2VvVHJ1c3QgSW5jLjEdMBsGA1UEAxMU R2VvVHJ1c3QgU1NMIENBIC0gRzMwHhcNMTUxMjIyMDAwMDAwWhcNMTgwMjE5MjM1 OTU5WjBgMQswCQYDVQQGEwJDQTEQMA4GA1UECBMHT250YXJpbzEQMA4GA1UEBxQH VG9yb250bzEVMBMGA1UEChQMVHVjb3dzLCBJbmMuMRYwFAYDVQQDFA0qLm9wZW5z cnMubmV0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAw1LOy0I+Hfd9 Ia6qccA1S46as29WgNCzhg84cgQpudRkFWJb0KPJArRVLm7c1WszG+ajtGaIDldo eED/iuu4G7Q+EAo0/oYu6E3i1jtzZC6xOp2tM3cdQUVcQFI6BAjpJZqV6+LQIRnP reDdG1vHS/32H3bWIkaCaLyhD26WlAQrCzIRO6roTy7cXv3adYvjcSdSHnr6xAQq Jvm8NlY8SGIW03mjXfenzlxma3zYu/KtTK96a6/MiDQw0Xtde8R3xW1wzuI42D3L 4myPwu9y7H6sMpvtxYflL3/z1HTP8uGQQNcFmsuqc4esWQW/5+gGtScs6Xa/qPNt ZuhOTv8D+QIDAQABo4IBrDCCAagwJQYDVR0RBB4wHIINKi5vcGVuc3JzLm5ldIIL b3BlbnNycy5uZXQwCQYDVR0TBAIwADAOBgNVHQ8BAf8EBAMCBaAwKwYDVR0fBCQw IjAgoB6gHIYaaHR0cDovL2duLnN5bWNiLmNvbS9nbi5jcmwwgZ0GA1UdIASBlTCB kjCBjwYGZ4EMAQICMIGEMD8GCCsGAQUFBwIBFjNodHRwczovL3d3dy5nZW90cnVz dC5jb20vcmVzb3VyY2VzL3JlcG9zaXRvcnkvbGVnYWwwQQYIKwYBBQUHAgIwNQwz aHR0cHM6Ly93d3cuZ2VvdHJ1c3QuY29tL3Jlc291cmNlcy9yZXBvc2l0b3J5L2xl Z2FsMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAfBgNVHSMEGDAWgBTS b/eW9IU/cjwwfSPahXibo3xafDBXBggrBgEFBQcBAQRLMEkwHwYIKwYBBQUHMAGG E2h0dHA6Ly9nbi5zeW1jZC5jb20wJgYIKwYBBQUHMAKGGmh0dHA6Ly9nbi5zeW1j Yi5jb20vZ24uY3J0MA0GCSqGSIb3DQEBCwUAA4IBAQCBWoK/hZzxGKPcShmT6MkA cuHb/WDD1r2/t5WIthoixnq0gQi1NNBFx35ZTJiRx2oXc7FC8fa+IELRjeDAWh8X ZPeGU153cJGWxOmkq0/tW7PM9X/JoByQKxDLJ908E/XcUGaL6Fgv2S71UeaIS+Q6 roH8OFHp+NJovbmVZJLa7Y1rNznRYH/gMgqQ4jOM7o7StCcNEYC5JDEVoXyqYWPr 4MaRXOZw4SIgZiT8pmguTpKiwTSyBXmfE4L4q7VGv0IPORMqG/0C3hjXki3dzriY mFQQ6LrOy42wJ0jnPOQ98XWQK6ASR4lnYqHlNiM5kGowcsBznslvOzABx8G3bF1V -----END CERTIFICATE----- subject=/C=CA/ST=Ontario/L=Toronto/O=Tucows, Inc./CN=*.opensrs.net issuer=/C=US/O=GeoTrust Inc./CN=GeoTrust SSL CA - G3 --- No client certificate CA names sent --- SSL handshake has read 3443 bytes and written 637 bytes --- New, TLSv1/SSLv3, Cipher is AES128-SHA Server public key is 2048 bit Secure Renegotiation IS supported Compression: NONE Expansion: NONE SSL-Session: Protocol : TLSv1.2 Cipher : AES128-SHA Session-ID: 59AA9115520F3D10BD86BD3DF6DB4EA996FDB3851301112B349744210015BBC2 Session-ID-ctx: Master-Key: 10ECC1BC594B8DB568D006B34C3D14DDDBEEB303CA20969F9C3D2E17CD98EBDAB088EDD328D84EBA332C26D4426E0415 Key-Arg : None PSK identity: None PSK identity hint: None SRP username: None Start Time: 1456503963 Timeout : 300 (sec) Verify return code: 20 (unable to get local issuer certificate) ---
If you don't get the above result, instead you have:
CONNECTED(00000003) write:errno=104 --- no peer certificate available --- No client certificate CA names sent --- SSL handshake has read 0 bytes and written 295 bytes --- New, (NONE), Cipher is (NONE) Secure Renegotiation IS NOT supported Compression: NONE Expansion: NONE ---
HRS Customers: this probably means you're not whitelisted at OpenSRS also.
Please provide us with the output from the test commands.
Or if you have:
connect: Connection refused connect:errno=111
HRS Customers: This means that the port isn't open at all.
Please provide us with the output from the test commands.
Try sending a simple XML command:
openssl s_client -connect rr-n1-tor.opensrs .net:55443 # Now paste the following: POST / HTTP/1.0 Content-Length:505 Content-Type: text/xml X-Username: test X-Signature: c9fd4c8fde71912c63cc4ba83bbb6bc1 <?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">LOOKUP</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">acmeinc.biz </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope> # You may need to press Ctrl + D
If you get this 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="response_text">Connection refused: invalid ip address [123.123 .119.150 ]</item> <item key="action">REPLY</item> <item key="response_code">555</item> </dt_assoc> </data_block> </body> </OPS_envelope>read:errno=104
This means the OpenSRS/HRS API is responding to you but your IP address is not whitelisted within SRS/HRS.
Updated over 2 years ago
* * *
What’s Next
Protocol Message Structure
Table of Contents
401 Authentication Error
If the above checks are correct, check the MD5:
Invalid XML Response
Further troubleshooting
Commands to run
What we are testing for
If the ping doesn't work
Are you able to connect to the API host/port ?
If you don't get the above result, instead you have:
Or if you have:
Try sending a simple XML command:
If you get this response:
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Trust Order Event: message_status_change
Suggest Edits
Response Parameters for message_status_change (trust order event)
If the request is successful, the attributes associative array may include the
following:
Parameter nameObligationDefinition/Value
message_status Always returned The updated status of the message.
Possible values are:
Queued
Sent
* Bounced
message_type Always returned The type of message.
reference_id Always returned The unique message ID.
Example Response for message_status_change (trust order event)
<?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">EVENT</item> <item key="response_code">200</item> <item key="is_success">1</item> <item key="response_text">Command successful</item> <item key="transaction_id">2016-12-02 15:24:56 10026 101</item> <item key="action">REPLY</item> <item key="attributes"> <dt_assoc> <item key="events"> <dt_array> <item key="0"> <dt_assoc> <item key="object_data"> <dt_assoc> <item key="domain_name">somedomain.com </item> <item key="message_type">enduser.icann .trade.new .registrant.approval </item> <item key="domain_id">310499</item> <item key="message_status">QUEUED</item> <item key="reference_id">7814e71bb27b751a33bd79555c08e7546b70ce9b4156cbdea8284864b01733cd104a36e1</item> <item key="to_address">[email protected]</item> </dt_assoc> </item> <item key="object">DOMAIN</item> <item key="event_id">d417c52e31e3ff537a034e982546b64f</item> <item key="event">MESSAGE_STATUS_CHANGE</item> <item key="event_date">2016-12-02T20:24:27Z</item> </dt_assoc> </item> </dt_array> </item> <item key="total">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Response Parameters for message_status_change (trust order event)
Example Response for message_status_change (trust order event)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
uk_get_blocker_contact
Until June 10, 2019, if you want to register an available second level .UK
domain name, and the name is already registered as a third level .UK domain
(for example..co.uk or .org.uk ), the owner contact information for the
second level .UK name must be an exact match to the owner contact
information of the equivalent third level .UK domain name.
This command checks whether the specified domain name is registered as a
third level .UK domain (for example..co.uk or .org.uk ) with the same
registrar and reseller, and if so, returns the owner contact details.
Suggest Edits
Request parameters for uk_get_blocker_contact
Standard parameters
action = uk_get_blocker_contact
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
domain Required The second level domain name, including the .uk
extension.
Response parameters for uk_get_blocker_contact
Standard parameters
action = reply
object = domain
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
The owner contact details for the third level domain.
Examples for uk_get_blocker_contact
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">UK_GET_BLOCKER_CONTACT</item> <item key="attributes"> <dt_assoc> <item key="domain">example.uk </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
If no equivalent third level domain is registered with the same registrar and reseller
<?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">DOMAIN</item> <item key="response_text">There is no domain blocking example.uk </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
If there is an equivalent domain name registered under the same registrar and reseller
<?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">DOMAIN</item> <item key="response_text">Command Successfully Completed</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="first_name">Spencer</item> <item key="last_name">Gibbons</item> <item key="address1">96 Mowat Ave</item> <item key="address2"></item> <item key="address3"></item> <item key="city">Bristol</item> <item key="state"></item> <item key="country">GB</item> <item key="postal_code">BS1 4AW </item> <item key="uk_whois_opt">N</item> <item key="org_name">Spencer Gibbons</item> <item key="phone">+44.2075551234 </item> <item key="registrant_type">IND</item> <item key="email">[email protected]</item> <item key="blocker">example.co .uk</item> </dt_assoc> </item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
If the equivalent domain name is not registered with the same registrar and reseller
<?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">REPLY</item> <item key="is_success">1</item> <item key="response_text">Cannot get contact details for example.co .uk which is blocking registration of example.uk because example.co .uk is not with this registrar or not with this reseller</item> <item key="response_code">465</item> <item key="attributes"> <dt_assoc> <item key="blocker">example.co .uk</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
If the domain name is not available
<?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">DOMAIN</item> <item key="response_text">Domain name not available</item> <item key="response_code">211</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for uk_get_blocker_contact
Standard parameters
Attributes
Response parameters for uk_get_blocker_contact
Standard parameters
Attributes
Examples for uk_get_blocker_contact
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Update Contacts
Submits a domain-contact information update to the OpenSRS system.
Each contact object is submitted as a whole to OpenSRS.
Suggest Edits
Request parameters for update_contacts
Standard parameters
action = update_contacts
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/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 nameObligationDefinition/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">[email protected]</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">[email protected]</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">[email protected]</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>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for update_contacts
Standard parameters
Attributes
Response parameters for update_contacts
Standard parameters
Attributes
Examples for update_contacts
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
update (surname)
Changes properties of the domain.
You can use this command to change the DNS records, enable or disable email forwarding, or to change the service type, for example, to switch from Webmail (no IMAP/POP/SMTP) to a regular mailbox.
Suggest Edits
Request parameters for update surname
Standard parameters
action = update
object = surname attributes
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/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 to be updated.
mailbox Optional An array that defines the type of account.
For more information, see the Mailbox table below.
DnsRecords
Parameters within the dnsRecords associative array are described below.
Parameter nameObligationDefinition/Value
content Optional The IP address or the fully qualified domain name.
name Optional The new name for the DNS record.
Specify @ to indicate the actual zone rather than another record in the zone.
type Optional Type of DNS record.
Allowed values are A or CNAME.
Warning: If you update dnsRecords, you must supply a full list of records.
Any committed records will be deleted.
Mailbox
Parameters within the mailbox associative array are described below.
Parameter nameObligationDefinition/Value
disableforward email Optional Disable email forwarding.
Allowed value is 1.
Note: To enable forwarding, use the forward_email parameter.
forward_email Optional The address to which email is forwarded.
mailbox_type Optional Change the type of mailbox account.
Allowed values are:
MAILBOX—Change to regular email account.
WEBMAIL_ONLY—Change to Webmail only account (no IMAP/POP/SMTP).
password Optional The registrant's new email password.
Response parameters for update surname
Standard parameters
action = reply
object = surname
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 surname
Change a regular mailbox account to a webmail only account and enable email forwarding
RequestResponse
<?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">UPDATE</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="forward_email">[email protected]</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="object">SURNAME</item> <item key="is_success">1</item> <item key="response_text">Command completed successfully</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Change a webmail only account to a regular mailbox, change the password, and set the A record
RequestResponse
<?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">UPDATE</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">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>
<?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">REPLY</item> <item key="object">SURNAME</item> <item key="is_success">1</item> <item key="response_text">Command completed successfully</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Change a webmail only account to a regular mailbox and disable email forwarding
RequestResponse
<?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">UPDATE</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="disable_forward_email">1</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">REPLY</item> <item key="object">SURNAME</item> <item key="is_success">1</item> <item key="response_text">Command completed successfully</item> <item key="response_code">200</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for update surname
Standard parameters
Attributes
Mailbox
Response parameters for update surname
Standard parameters
Examples for update surname
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
update_contacts
Submits a domain-contact information update to the OpenSRS system.
Each contact object is submitted as a whole to OpenSRS, and changes are parsed against the existing information.
Suggest Edits
📘NOTE:
This command cannot be used for .DK TLDs.
For .UK domains, if you use this command to submit a change to the Organization field, it is recognized by OpenSRS, but not by the registry.
To change the .UK Organization information, you must contact the Nominet Registry.
For .ES domains, if you use this command to submit any changes to the owner contact information, the changes are recognized by OpenSRS, but not by the registry.
To change the .ES Owner contact information, you must contact the Esnic Registry.
For .IT domains, the owner contact requires three additional parameters: entity_type, nationality_code, and reg_code.
For more information about contact_set values, see .IT contact requirements.
Request parameters for update_contacts
Standard parameters
action = update_contacts
object = domain
Attributes
Parameters within the attributes associative array are described below.
Parameter nameParameter nameDefinition/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 Required 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 nameObligationDefinition/Valu
details Returned if is_success = true 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 Appendix C: Encoding Types for
IDNs.
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
RequestResponse
<?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">UPDATE_CONTACTS</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="types"> <dt_array> <item key="0">owner</item> <item key="1">admin</item> <item key="2">billing</item> <item key="3">tech</item> </dt_array> </item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="country">US</item> <item key="org_name">Example Inc.</item> <item key="phone">+1.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="title">Organization</item> </dt_assoc> </item> <item key="admin"> <dt_assoc> <item key="country">US</item> <item key="org_name">Example Inc.</item> <item key="phone">+1.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="title">Admin</item> </dt_assoc> </item> <item key="billing"> <dt_assoc> <item key="country">US</item> <item key="org_name">Example Inc.</item> <item key="phone">+1.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="title">Billing</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="country">US</item> <item key="org_name">Example Inc.</item> <item key="phone">+1.4165550123 </item> <item key="last_name">Wayne</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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">Thomas</item> <item key="title">Tech</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">UPDATE_CONTACTS</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">example.com </item> <item key="types"> <dt_array> <item key="0">owner</item> <item key="1">admin</item> <item key="2">billing</item> <item key="3">tech</item> </dt_array> </item> <item key="contact_set"> <dt_assoc> <item key="owner"> <dt_assoc> <item key="country">US</item> <item key="org_name">Example Inc.</item> <item key="phone">+1.4165550123 </item> <item key="last_name">Ottway</item> <item key="address2">Suite 500</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="title">Owner</item> </dt_assoc> </item> <item key="admin"> <dt_assoc> <item key="country">US</item> <item key="org_name">Example Inc.</item> <item key="phone">+1.4165550123 </item> <item key="last_name">Adams</item> <item key="address2">Suite 100</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="title">Admin</item> </dt_assoc> </item> <item key="billing"> <dt_assoc> <item key="country">US</item> <item key="org_name">Example Inc.</item> <item key="phone">+1.4165550123 </item> <item key="last_name">Burton</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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> <item key="title">Billing</item> </dt_assoc> </item> <item key="tech"> <dt_assoc> <item key="country">US</item> <item key="org_name">Example Inc.</item> <item key="phone">+1.4165550123 </item> <item key="last_name">Wayne</item> <item key="address2">Suite 200</item> <item key="state">CA</item> <item key="email">[email protected]</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">Thomas</item> <item key="title">Tech</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for update_contacts
Standard parameters
Attributes
Response parameters for update_contacts
Standard parameters
Attributes
Examples for update_contacts
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
update_dv_auth
Changes the authentication method for a domain-vetted RapidSSL, Geotrust or Comodo certificate, or sends an immediate request for validation of a domain-vetted RapidSSL.
Attributes used are dv_auth_method or dv_auth_on_demand_check, respectively.
Suggest Edits
Request parameters for update_dv_auth
Standard parameters
action = update_dv_auth
object = trust_service
Attributes:
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
order_id Required.
The ID number of SSL service order.
Example: 17559
dv_auth_on_demand_check Optional.
Required to send an immediate request for validation.
1 is the only valid value for dv_on_demand_check
dv_auth_method Optional.
Required to make a change to the authentication method.
Possible values:
file
DNS
Response parameters for update_dv_auth
Standard parameters
action = update_dv_auth: reply
object = trust_service
response_ text = message describing the outcome of requested attributes
response_code = code indicating outcome of request
is_success = boolean indication success or failure of request
Attributes:
If the request is successful, the attributes associative array may include the
following:
Parameter nameObligationDefinition/Value
order_id always returned The ID number of SSL service order example 17559
Examples for update_dv_auth_check (dv_auth_on_demand_check)
Request
FileDNSEmail
<?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">update_dv_auth</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="order_id">16679</item> <item key="dv_auth_on_demand_check">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">update_dv_auth</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="order_id">16680</item> <item key="dv_auth_on_demand_check">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">update_dv_auth</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="order_id">16682</item> <item key="dv_auth_on_demand_check">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
FileDNS Email
<?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="object">TRUST_SERVICE</item> <item key="response_text">Command completed successfully.</item> <item key="action">UPDATE_DV_AUTH:REPLY</item> <item key="attributes"> <dt_assoc> <item key="order_id">16679</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">TRUST_SERVICE</item> <item key="response_text">Command completed successfully.</item> <item key="action">UPDATE_DV_AUTH:REPLY</item> <item key="attributes"> <dt_assoc> <item key="order_id">16679</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">TRUST_SERVICE</item> <item key="response_text">on-demand check is not supported for EMAIL Auth Method</item> <item key="action">UPDATE_DV_AUTH:REPLY</item> <item key="response_code">465</item> <item key="error_details"> <dt_array> <item key="0"> <dt_assoc> <item key="error_detail">on-demand check is not supported for EMAIL Auth Method</item> <item key="field_name">dv_on_demand_check</item> <item key="error_code">465</item> </dt_assoc> </item> </dt_array> </item> <item key="is_success">0</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Examples for update_dv_auth_check (dv_auth_method)
Request
FileDNSEmail
<?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">update_dv_auth</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="order_id">17559</item> <item key="dv_auth_method">file</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">update_dv_auth</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="order_id">17559</item> <item key="dv_auth_method">dns</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">update_dv_auth</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="order_id">17559</item> <item key="dv_auth_method">email</item> <item key='approver_email'>[email protected]</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">TRUST_SERVICE</item> <item key="response_text">Command completed successfully.</item> <item key="action">UPDATE_DV_AUTH:REPLY</item> <item key="attributes"> <dt_assoc> <item key="order_id">17559</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated about 2 years ago
* * *
Table of Contents
Request parameters for update_dv_auth
Standard parameters
Attributes:
Response parameters for update_dv_auth
Standard parameters
Attributes:
Examples for update_dv_auth_check (dv_auth_on_demand_check)
Examples for update_dv_auth_check (dv_auth_method)
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
update_order
Submits a SSL Service order update to the OpenSRS system.
When updating existing SSL Service orders, the general rules are:
Include the parameters and values that you want to change.
To remove a remove a value, submit the parameter with an empty value
Omit any parameters that you do not want to change.
Suggest Edits
📘NOTE:
This command can only be used on pending orders.
Important: If you are using this command to add or change the additional domains for a SAN certificate order, you must specify all of the domains that will be secured by the certificate.
The additional_domains list specified in this command overwrites the additional_domains list in the original order.
Request parameters for update_order
Standard parameters
action = update_order
object = trust_service
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
additional_domains Optional.
May be used for SAN certificates.
The list of additional domains or other entities (other than the primary domain) that will be secured by the SSL certificate.
This list overwrites the previous list in the order, so be sure to specify all of the domains that you want to secure with this certificate.
For more information, see Request parameters for sw_register (trust_service).
approver_email Optional The email of one of the individuals who can approve the SSL Service order.
The SSL Service provider sends the approver email to the address that you specify.
contact_set Optional The SSL Certificate contact information.
Most products require: admin, billing and
tech contacts.
For admin, tech, and billing contacts for thawte, Symantec, and all EV certificates, title is required.
For Symantec certificates, organization, address, city, state/province, postal code, and country are required for admin and tech contacts.
All organization vetted certificates require an organization contact.
csr Optional The certificate signing request for the required certificate.
The SSL Service provider uses this information to generate the certificate.
Note: All certificates require 2048 bit CSRs; however, Symantec will accept 1024 bit CSRs for certificates with expiry dates prior to December 31, 2013, except for EV certs, which require 2048, regardless of the term.
dv_auth_method Optional Allows you to specify how you want to validate the certificate.
Allowed values are:
File
DNS
Note: Default value is email.
end_user_auth_info Optional - used only for SiteLock and TRUSTe Specify the username and password that the end user will use to log in to the Domain Admin interface where they can manage their account.
The login credentials will be sent to the specified email_address.
If you resend the Domain Admin login information (through the Control Panel), this is the address to which the Domain Admin login credentials are sent.
Please note the following conditions:
If you specify username and password and the user already exists, the command will fail.
If you specify username but not password, and the user does not already exist, the user credentials cannot be created and the command will fail.
* If you specify username but not password, and the user already exists, the service will be associated with the existing end user profile.
If you want to associate the SSL Service product with an existing account, you only need to include the username value.
For more information see the End user auth info table below.
order_id Required The ID of the SSL Service order.
period Optional The number of years of the registration period.
Allowed values are 1 – 4, depending on the SSL Service that is ordered.
comodo_ev—1to 2
comodo_instantssl—1to 4
comodo_premiumssl—1to 4
comodo_premiumssl_wildcard—1to 4
comodo_ssl—1to 4
comodo_wildcard—1 to 4
malwarescan—1
quickssl—1to 4
quickssl_premium—1to 4
quickssl_premium_san —1to 4
rapidssl — 1 to 3
rapidssl_wildcard — 1 to 3
securesite—1to 4
securesite_ft—1
securesite_ev—1 to 2
securesite_ev_ft—1
securesite_pro—1 to 4
securesite_pro_ft—1
securesite_pro_ev—1 to 2
securesite_pro_ev_ft—1
securesite_pro_ev_san—1 to 2
securesite_pro_san —1 to 4
securesite_san—1to 4
symantec_csc —1to 3
securesite_ev_san—1 to 2
sgcsuper_certs—1to 4
sitelock_basic—1
sitelock_premium—1
sitelock_enterprise—1
sitelock_find—1
sitelock_fix—1
sitelock_prevent—1
sitelock_911—1
ssl123—1 to 3
sslwebserver—1 to 3
sslwebserver_ev—1 to 2
sslwebserver_ev_san—1 to 2
sslwebserver_san—1 to 3
sslwebserver_wildcard—1 to 2
symantec_ssl_lite—1
symantec_ssl_lite_wildcard—1
truebizid—1to 2
truebizid_ev—1 to 2
truebizid_ev_ft—1
truebizid_ev_san—1 to 2
truebizid_san—1to 2
truebizid_wildcard—1 to 3
thawte_csc —1 to 2
trustwave_dv—1 to 3
trustwave_ev—1 to 2
trustwave_ev_san5—1 to 2
trustwave_premiumssl—1 to 3
trustwave_premiumssl_san5 —1 to 3
trustwave_premiumssl_wildcard—1 to 3
product_type Optional The product type from the SSL Certificate inventory.
The product types are detailed in the allowed values section for this key.
Allowed values are:
comodo_ev
comodo_instantssl
comodo_premiumssl
comodo_premiumssl_wildcard
comodo_ssl
comodo_wildcard
malwarescan
quickssl
quickssl_premium
securesite
securesite_pro
securesite_ev
securesite_pro_ev
sgcsuper_certs
sitelock_basic
sitelock_premium
sitelock_enterprise
sitelock_find
sitelock_fix
sitelock_prevent
sitelock_911
ssl123
sslwebserver
sslwebserver_wildcard
sslwebserver_ev
symantec_ssl_lite
symantec_ssl_lite_wildcard
truebizid
truebizid_wildcard
truebizid_ev
truste_hpp(HostedPrivacyPolicy)
truste_tps(TRUSTEPrivacyPolicy
with seal)
trustwave_dv
trustwave_ev
trustwave_premiumssl
trustwave_premiumssl_wildcard
reg_type Optional The type of registration being requested:
new—Submit a new or SSL Service order.
renew—Renew a SSL Service offering.
* upgrade—Upgrade a SiteLock Find or Fix SSL certificate to a higher level certificate.
When you upgrade, the product_type changes, you are charged the price for a one year term at the new level, and the new expiry date is one year from the date of the upgrade.
Note: This feature is currently available only for SiteLock certificates.
server_count Required when product_type = securesite*, ssl123, sgcsuper_certs, sslwebserver, sslwebserver_wildcard, sslwebserver_ev, comodo_premiumssl_wildcard, comodo_wildcard The number of servers on which the SSL Service product will be installed.
server_type Optional The type of server software used to generate the CSR.
Allowed values are:
Symantec, thawte, and GeoTrust
apache2
apacheapaches sl
apacheopenssl
apacheraven
apachessl
apachessleay
c2net
cobaltseries
cobaltraq3
cobaltraq2
cpanel
domino
dominogo4626
dominogo4625
ensim
hsphere
iis
iis4
iis5
iplanet
ipswitch
netscape
ibmhttp
other
plesk
tomcat
weblogic
website
webstar
webstar4
zeusv3
Comodo
apachessl
citrix
domino
ensim
hsphere
iis4
iis6
iis7
iplanet
javawebser
netscape
ibmhttp
novell
oracle
other
plesk
redhat
sap
tomcat
webstar
whmcpanel
Note: Trustwave does not support server types.
special_instructions Optional Any special instructions regarding the SSL Service purchase.
End_user_auth_info
Parameters within the end_user_auth_info associative array are described
below.
Parameter nameObligationDefinition/Value
email_address Optional - used only for SiteLock and TRUSTe to send Domain Admin credentials Specify the email address to which you want to send the login credentials (username and password) for Domain Admin.
Note: If you want to associate the SSL Service product with an existing account, only username is required.
password Optional - used only for SiteLock and TRUSTe to create Domain Admin credentials The password must be at least eight characters.
username Optional - used only for SiteLock and TRUSTe to create Domain Admin credentials The username must be at least six characters
Response parameters for update_order
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 nameObligationDefinition/Value
domain Returned if
is_success = true The domain with which the SSL Service order is associated.
order_id Returned if
is_success = true The ID number of the SSL Service order.
state Returned if
is_success = true The state of the order.
Allowed values are:
approver-confirmed—Owner has confirmed the domain vetted certificate.
awaiting-approval—Order processed successfully; waiting for supplier approval.
cancelled—Pending order was cancelled.
completed—Order is complete.
declined—Order cancelled after it was processed or declined by the
supplier.
in-progress—Order is in progress.
* pending—Order saved as pending.
Examples for update_order
Example 1
This example changes the information associated with an order, but does not change it's processing state.
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">update_order</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="server_type">apachessl</item> <item key="special_instructions"></item> <item key="approver_email">[email protected]</item> <item key="csr">-----BEGIN CERTIFICATE REQUEST----- MIIC3DCCAcQCAQAwgZYxJTAjBgNVBAMTHHVwZGF0ZW9yZGVyLnFhcmVncmVzc2lv bi5vcmcxCzAJBgNVBAYTAkNBMQswCQYDVQQIEwJPTjEQMA4GA1UEBxMHVG9yb250 bzENMAsGA1UEChMEVGVzdDEQMA4GA1UECxMHUUEgRGVwdDEgMB4GCSqGSIb3DQEJ ARYRcWFmaXZlQHR1Y293cy5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK AoIBAQDkMouJLDenKrVS9FdcmdY3BHrJ9iS5o8TbNSAKf2loYF1afa6tJyxO6bCj Mk6WegE+Yugb42ONAgz0zhJq5bNTuWb9FvBZLEuN/jUBR/iVdTlf//W/BPoE2CmK lbgskzFooQ7v3SSAoYl3TjwfN8iPWwni/yLDMJYJekxcZtsro7vugtl2HZDRhxLy B0WB0y8Kx3lh1c7xC9CbXfqjJf+j1sKiGEh+cy1H71VdcakleoG+Tll8qvtWreEf pZYczmeyn1pPZfbDzVw9AR9x1Yohrwaah1KNZoMIp0taVTkMe/NNEdMP2Rm7Y8ak Eof49VBrRfDGkW135EYYJCHxBvXJAgMBAAGgADANBgkqhkiG9w0BAQQFAAOCAQEA nQHOcqylM/b7NUqFuoWRG9R1GP6/gjixHqyyV4fe2c66HlBHcKR1Tm88cpT8mfu2 oE2Hw55DVUtkrBfNdVZqVXEK8yfiuF2EKuVk+34anCwwIQOg4o6Oy3xBU1oIKpqX 1x0Z7HZJ097DK6uwUqFsviEWyxrNCfJ3DYU5TfrZtnzIdOB6ztI3wBv1IYZyYzk/ zU65N4MDv64yUazmqjZKgxvl4THhWeFVPPy+4dk8k8dkuPkcqhdxeJVwntG7tQIw utv8IShy2ckHVC0URV1RHbr660ygD/fAE3hGjzPbdgwu1DLlC5ANlpSfgeJc3feK sqC2b/EfPHfdbtu6+eJgGw== -----END CERTIFICATE REQUEST-----</item> <item key="server_count">2</item> <item key="period">2</item> <item key="order_id">2326</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="is_success">1</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="domain">updateorder.example .com</item> <item key="order_id">2326</item> <item key="state">pending</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 2
This example creates login credentials for Domain Admin and changes the processing instruction for the order from save to process.
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">update_order</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="handle">process</item> <item key="order_id">7419</item> <item key="product_type">sitelock_fix</item> <item key="end_user_auth_info"> <dt_assoc> <item key="email_address">[email protected]</item> <item key="username">customer111</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">TRUST_SERVICE</item> <item key="is_success">1</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="domain">example.ca </item> <item key="order_id">7419</item> <item key="state">awaiting-approval</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 3
This example updates the list of domains that are secured by the SSL Service product.
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">update_order</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="additional_domains"> <dt_array> <item key="0">upadditional1.example .org</item> <item key="1">upadditional2.example .org</item> <item key="2">upadditional3.example .org</item> <item key="3">upadditional4.example .org</item> <item key="4">upadditional5.example .org</item> </dt_array> </item> <item key="handle">save</item> <item key="order_id">186332</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="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="domain">example.org </item> <item key="order_id">186332</item> <item key="state">pending</item> </dt_assoc> </item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Example 4
This example changes DV authorization details for all three methods (File, DNS and Email) for Comodo and Symantec SSL products.
Request
FileDNSEmail
<?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">update_order</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="server_type">apachessl</item> <item key="approver_email">[email protected]</item> <item key="server_count">2</item> <item key="period">2</item> <item key="order_id">16684</item> <item key="dv_auth_method">file</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">update_order</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="server_type">apachessl</item> <item key="approver_email">[email protected]</item> <item key="server_count">2</item> <item key="period">2</item> <item key="order_id">16685</item> <item key="dv_auth_method">dns</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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">update_order</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="server_type">apachessl</item> <item key="approver_email">[email protected]</item> <item key="server_count">2</item> <item key="period">2</item> <item key="order_id">16686</item> <item key="dv_auth_method">email</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
FileDNSEmail
<?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="object">TRUST_SERVICE</item> <item key="response_text">Command completed successfully.</item> <item key="action">UPDATE_ORDER:REPLY</item> <item key="attributes"> <dt_assoc> <item key="domain">20160122comodofileb.com </item> <item key="dv_auth_method">file</item> <item key="order_id">16684</item> <item key="dv_auth_details"> <dt_assoc> <item key="file_contents">1F8DB0E04120A58714B8FC4EAD01E6AE16199D1Dcomodoca.com </item> <item key="file_name">B35A9AF0A25CDF8D12244FBEF67D0E91.txt </item> </dt_assoc> </item> <item key="state">pending</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">TRUST_SERVICE</item> <item key="response_text">Command completed successfully.</item> <item key="action">UPDATE_ORDER:REPLY</item> <item key="attributes"> <dt_assoc> <item key="domain">20160122comododnsb.com </item> <item key="dv_auth_method">dns</item> <item key="order_id">16685</item> <item key="dv_auth_details"> <dt_assoc> <item key="dns_entry">5AE9CDA1ECEF9D587CD513F8DE6000D5.20160122comododnsb .com CNAME AD09E6567790BE3D9AF8D11DC7AFBDEE7BFDB8DC.comodoca .com</item> </dt_assoc> </item> <item key="state">pending</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
<?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="object">TRUST_SERVICE</item> <item key="response_text">Command completed successfully.</item> <item key="action">UPDATE_ORDER:REPLY</item> <item key="attributes"> <dt_assoc> <item key="domain">20160122comodoemailb.com </item> <item key="order_id">16686</item> <item key="state">pending</item> </dt_assoc> </item> <item key="response_code">200</item> <item key="is_success">1</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated almost 8 years ago
* * *
Table of Contents
Request parameters for update_order
Standard parameters
Attributes
End_user_auth_info
Response parameters for update_order
Standard parameters
Attributes
Examples for update_order
Example 1
Example 2
Example 3
Example 4
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
update_product
Updates the SSL Service product and enables or disables the Symantec SSL Seal and/or the Symantec Search-in-Seal.
Suggest Edits
📘NOTE:
In order to enable the Symantec Search-in-Seal, SSL Seal must be enabled.
Request parameters for update_product
Standard parameters
action = update_product
object = trust_service attributes
Attributes
Parameters within the attributes associative array are described below.
Parameter nameObligationDefinition/Value
contact_email Optional The email address for the new SSL Service contact.
let_expire Optional Specifies whether renewal reminder email messages will be sent for the SSL Service product.
This parameter may be used for any active SSL Service product.
Allowed values are:
0—Send renewal reminder emails when the certificate is approaching its expiry date.
This is the default.
1—Do not send any renewal reminder emails.
product_id Required The ID number for the SSL Service.
seal_in_search Optional Specifies whether to enable the Symantec Seal-in-Search which displays the Symantec seal next to the link for your web site in online search results.
Allowed values are:
0—Do not enable the Symantec Seal-in- Search.
1—Enable the Symantec Seal-in-Search
Important: If you submit this parameter, you must also submit the trust_seal parameter with the value equal to 1.
trust_seal Optional Specifies whether to enable the Symantec SSL Seal on your website.
Allowed values are:
0—Do not enable the Symantec SSL Seal.
1—Enable the Symantec TrustSeal.
Response parameters for update_product
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 nameObligationDefinition/Value
contact_email Optional The email address for the new SSL Service contact.
let_expire Optional Indicates whether renewal reminder email messages will be sent for the SSL Service product.
Allowed values are:
0—Send renewal reminder emails when the certificate is approaching its expiry date.
This is the default.
1—Do not send any renewal reminder emails.
product_id Returned if
is_success = true The ID number for the SSL Service.
seal_in_search Optional The status of the Symantec Seal-in-Search.
Allowed values are:
0—Not enabled.
1—Enabled.
trust_seal Optional The status of the Symantec SSL Seal.
Allowed values are:
0—Not enabled.
1—Enabled.
Examples for update_product
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">update_product</item> <item key="object">trust_service</item> <item key="attributes"> <dt_assoc> <item key="trust_seal">1</item> <item key="contact_email">[email protected]</item> <item key="seal_in_search">1</item> <item key="let_expire">1</item> <item key="product_id">279</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="is_success">1</item> <item key="response_text">Command completed successfully.</item> <item key="response_code">200</item> <item key="attributes"> <dt_assoc> <item key="trust_seal">1</item> <item key="product_id">279</item> <item key="contact_email">[email protected]</item> <item key="let_expire">1</item> <item key="seal_in_search">1</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 2 years ago
* * *
Table of Contents
Request parameters for update_product
Standard parameters
Attributes
Response parameters for update_product
Standard parameters
Attributes
Examples for update_product
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Verify (Check validation .AU)
Suggest Edits
This API call is used to determine the validity of .AU ABN/ACN details
Verify
Request
XML
<?xml version="1.0 "?> <OPS_envelope> <header> <version>0.9 </version> </header> <body> <data_block> <dt_assoc> <item key="protocol">XCP</item> <item key="action">verify</item> <item key="object">DOMAIN</item> <item key="domain">example.com .au</item> <item key="attributes"> <dt_assoc> <item key="data">tld_data</item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope>
Response
XML
<?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="action">REPLY</item> <item key="response_code">200</item> <item key="response_text">Command Successful</item> <item key="is_success">1</item> <item key="protocol">XCP</item> <item key="attributes"> <dt_assoc> <item key="tld_data"> <dt_assoc> <item key="au_registrant_info"> <dt_assoc> <item key="eligibility_id">11111111111</item> <item key="eligibility_name">Example PTY LTD</item> <item key="registrant_id">1111111111</item> <item key="eligibility_id_type">ABN</item> <item key="registrant_id_type">ABN</item> <item key="policy_reason">2</item> <item key="registrant_name">Example PTY LTDD</item> <item key="eligibility_type">Company</item> </dt_assoc> </item> </dt_assoc> </item> </dt_assoc> </item> <item key="object">DOMAIN</item> </dt_assoc> </data_block> </body> </OPS_envelope>
Updated over 3 years ago
* * *
Table of Contents
Verify
Request
Response
[ENDPOINT]
Appendix C: Encoding Types for IDNs
Overview
Powered by
Writing your own client
Suggest Edits
This section contains an explanation of the OpenSRS client/server data exchange.
This information is useful if you want to write your own client.
XML client protocol fundamentals
In our XML Client Protocol (XCP), the sender of a message (request or reply) must always precede the message with the header 'Content-Length: X', where 'X' is the number of bytes in the actual message (without the header).
This header must be followed by a carriage return and line feed combination.
Counted bytes only occur on the first non-blank line.
Example
Content-length: 55\015\012 # carriage return/line feed # blank lines are ignored <?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> [ etc ]
XCP allows empty space to be placed in the XML message, as long as the XML is still valid, so empty lines or end-of-line characters may be inserted (though they must be counted in the byte count).
For more information regarding the transmission of data over HTTPS, refer to this document: http://www.ietf .org/rfc/rfc2616.txt
MD5 examples
The following examples show how to add an MD5 Signature and create an XML packet for the various client languages.
PerlPHPJavaPythonRuby
use Digest::MD5 qw/md5_hex/; md5_hex(md5_hex($xml, $private_key),$private_key)
md5(md5($xml.$private_key).$private_key);
protected String md5Sum(String str) { String sum = new String(); try { MessageDigest md5 = MessageDigest.getInstance ("MD5"); sum = String.format ("%032x", new BigInteger(1, md5.digest (str.getBytes ()))); } catch (Exception ex) { } return sum; } public String getSignature(String xml) { return md5Sum(md5Sum(xml + privateKey) + privateKey); }
md5_obj = hashlib.md5 () md5_obj.update ((xml + api_key).encode()) signature = md5_obj.hexdigest () md5_obj = hashlib.md5 () md5_obj.update ((signature + api_key).encode()) signature = md5_obj.hexdigest ()
md5 = Digest::MD5.new md5.update (xml + api_key) signature = md5.hexdigest md5 = Digest::MD5.new md5.update (signature + api_key) signature = md5.hexdigest
Coding examples
PerlPHPJavaPythonRuby
#!/usr/bin/perl use strict; use warnings; use IO::Socket::SSL; use Digest::MD5 qw/md5_hex/; use LWP::UserAgent; use Data::Dumper; my $TEST_MODE = 1; # Will connect to OpenSRS's test environment my $connection_options = { 'live' => { # IP whitelisting required api_host_port => 'rr-n1-tor.opensrs .net:55443', api_key => '<YOUR API KEY>', reseller_username => '<YOUR RESELLER USERNAME>', }, 'test' => { # IP whitelisting not required api_host_port => 'horizon.opensrs .net:55443', api_key => '<YOUR API KEY>', reseller_username => '<YOUR RESELLER USERNAME>', }, }; my $connection_details; if ($TEST_MODE) { $connection_details = $connection_options->{'test'}; } else { $connection_details = $connection_options->{'live'}; } my $ua = new LWP::UserAgent; # Simple lookup command my $xml = <<DATA; <?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">LOOKUP</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">myfirstopensrsapitest.com </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope> DATA my $response = $ua->post( "https://$connection_details->{api_host_port}", 'Content-Type' => 'text/xml', 'X-Username' => $connection_details->{reseller_username}, 'X-Signature' => md5_hex( md5_hex( $xml, $connection_details->{api_key} ), $connection_details->{api_key} ), 'Content' => $xml ); print "Request to $connection_details->{api_host_port} as reseller: $connection_details->{reseller_username}\n$xml\n"; print "Response:\n"; if ( $response->is_success ) { print Dumper( $response->content ); } else { print Dumper($response); }
<?php // Note: Requires cURL library $TEST_MODE = true; $connection_options = [ 'live' => [ 'api_host_port' => 'https://rr-n1-tor.opensrs .net:55443', 'api_key' => '<YOUR API KEY>', 'reseller_username' => '<YOUR RESELLER USERNAME>' ], 'test' => [ 'api_host_port' => 'https://horizon.opensrs .net:55443', 'api_key' => '<YOUR API KEY>', 'reseller_username' => '<YOUR RESELLER USERNAME>' ] ]; if ($TEST_MODE) { $connection_details = $connection_options['test']; } else { $connection_details = $connection_options['live']; } $xml = <<<EOD <?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">LOOKUP</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">myfirstopensrsapitest.com </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope> EOD; $data = [ 'Content-Type:text/xml', 'X-Username:' .
$connection_details['reseller_username'], 'X-Signature:' .
md5(md5($xml .
$connection_details['api_key']) .
$connection_details['api_key']), ]; $ch = curl_init($connection_details['api_host_port']); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_HTTPHEADER, $data); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $xml); $response = curl_exec($ch); echo 'Request as reseller: ' .
$connection_details['reseller_username'] .
"\n" .
$xml .
"\n"; echo "Response\n"; echo $response .
"\n"; ?>
import java.util .HashMap; import java.io .*; import java.security .MessageDigest; import java.math .BigInteger; import java.net .HttpURLConnection; import java.net .URL; public class OpenSRSAPITest { public static void main (String[] args) { final boolean TEST_MODE = true; HashMap <String, String> liveDetails = new HashMap <String,String>(); liveDetails.put ("apiHostPort","https://rr-n1-tor.opensrs .net:55443"); liveDetails.put ("apiKey", "<YOUR_API_KEY>"); liveDetails.put ("resellerUsername", "<YOUR_RESELLER_USERNAME>"); HashMap <String, String> testDetails = new HashMap <String,String>(); testDetails.put ("apiHostPort", "https://horizon.opensrs .net:55443"); testDetails.put ("apiKey", "<YOUR_API_KEY>"); testDetails.put ("resellerUsername", "<YOUR_RESELLER_USERNAME>"); HashMap <String, String> connectionDetails; if (TEST_MODE) connectionDetails = testDetails; else connectionDetails = liveDetails; // Simple lookup command String xml = "<?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'>LOOKUP</item>" + "<item key='object'>DOMAIN</item>" + "<item key='attributes'>" + "<dt_assoc>" + "<item key='domain'>myfirstopensrsapitest.com </item>" + "</dt_assoc>" + "</item>" + "</dt_assoc>" + "</data_block>" + "</body>" + "</OPS_envelope>"; // Create signature String signature = md5_hex( md5_hex(xml + connectionDetails.get ("apiKey")) + connectionDetails.get ("apiKey")); System.out .println("Request as reseller: " + connectionDetails.get ("resellerUsername")); System.out .println(xml); // Make HTTP Post try { URL url = new URL(connectionDetails.get ("apiHostPort")); HttpURLConnection conn = (HttpURLConnection) url.openConnection (); conn.setDoOutput (true); conn.setRequestMethod ("POST"); conn.setRequestProperty ("Content-Type", "text/xml"); conn.setRequestProperty ("X-Username", connectionDetails.get ("resellerUsername")); conn.setRequestProperty ("X-Signature", signature); OutputStreamWriter writer = new OutputStreamWriter(conn.getOutputStream ()); writer.write (xml); writer.flush (); System.out .println("Response Code: " + conn.getResponseCode ()); System.out .println("Response Message: " + conn.getResponseMessage ()); System.out .println("Response XML:"); String line; BufferedReader reader = new BufferedReader(new InputStreamReader(conn.getInputStream ())); while ((line = reader.readLine ()) != null) { System.out .println(line); } writer.close (); reader.close (); } catch (Exception e) { e.printStackTrace (); } } private static String md5_hex(String s) { try { MessageDigest m = MessageDigest.getInstance ("MD5"); m.update (s.getBytes (), 0, s.length ()); BigInteger i = new BigInteger(1,m.digest ()); return String.format ("%1$032x", i); } catch (Exception e) { e.printStackTrace (); } return null; } }
#!/usr/bin/python import requests import hashlib TEST_MODE = 1 connection_options = { 'live' : { # IP whitelisting required 'reseller_username': '<YOUR RESELLER USERNAME>', 'api_key':'<YOUR API KEY>', 'api_host_port': 'https://rr-n1-tor.opensrs .net:55443', }, 'test' : { # IP whitelisting not required 'reseller_username': '<YOUR RESELLER USERNAME>', 'api_key':'<YOUR API KEY>', 'api_host_port': 'https://horizon.opensrs .net:55443', } } if TEST_MODE == 1: connection_details = connection_options['test'] else: connection_details = connection_options['live'] xml = ''' <?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">LOOKUP</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">myfirstopensrsapitest.com </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope> ''' md5_obj = hashlib.md5 () md5_obj.update ((xml + connection_details['api_key']).encode()) signature = md5_obj.hexdigest () md5_obj = hashlib.md5 () md5_obj.update ((signature + connection_details['api_key']).encode()) signature = md5_obj.hexdigest () headers = { 'Content-Type':'text/xml', 'X-Username': connection_details['reseller_username'], 'X-Signature':signature, }; print("Request to {} as reseller {}:".format(connection_details['api_host_port'],connection_details['reseller_username'])) print(xml) r = requests.post (connection_details['api_host_port'], data = xml, headers=headers ) print("Response:") if r.status_code == requests.codes .ok: print(r.text ) else: print (r.status_code ) print (r.text )
#!/usr/bin/ruby require 'uri' require 'net/http' require 'net/https' require 'digest' TEST_MODE = 1 connection_options = { 'live' => { # IP whitelisting required 'reseller_username' => '<YOUR RESELLER USERNAME>', 'api_key' => '<YOUR API KEY>', 'api_host_port' => 'https://rr-n1-tor.opensrs .net:55443', }, 'test' => { # IP whitelisting not required 'reseller_username' => '<YOUR RESELLER USERNAME>', 'api_key' => '<YOUR API KEY>', 'api_host_port' => 'https://horizon.opensrs .net:55443', } } if TEST_MODE == 1 connection_details = connection_options['test'] else connection_details = connection_options['live'] end xml = <<-eos <?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">LOOKUP</item> <item key="object">DOMAIN</item> <item key="attributes"> <dt_assoc> <item key="domain">myfirstopensrsapitest.com </item> </dt_assoc> </item> </dt_assoc> </data_block> </body> </OPS_envelope> eos md5 = Digest::MD5.new md5.update (xml + connection_details['api_key']) signature = md5.hexdigest md5 = Digest::MD5.new md5.update (signature + connection_details['api_key']) signature = md5.hexdigest uri = URI.parse ("#{connection_details['api_host_port']}/") https = Net::HTTP.new (uri.host ,uri.port ) https.use_ssl = true req = Net::HTTP::Post.new (uri.path , initheader = { 'Content-Type' =>'text/xml', 'X-Username' => connection_details['reseller_username'], 'X-Signature' => signature, }) req.body = xml puts "Request to #{connection_details['api_host_port']} as reseller #{connection_details['reseller_username']}:" res = https.request (req) puts xml puts "Response:" if res.code == "200" puts res.body else puts res.code puts res.message end
Data exchange
For each line of data passed, you must prepend the data with the length of the string packed in 'network' or big-endian order.
In Perl, this is accomplished by:
$length = pack('n', length($data));
Where $data is the information you are going to send.
For example, assuming you have a socket SERVER already open to the server process, you could send data as follows:
print SERVER pack('n', length($data));
print SERVER $data;
Since you must always send the length of the string first, it will not work to simply telnet to the OpenSRS server and begin issuing commands.
Authentication handshake
The first step in communicating with the server process is the authentication handshake.
This proceeds between the reseller Client and reseller Agent (server) as follows:
ProcessDescription
1 Reseller Client Initiates connection with Reseller Agent (server process) on a specific TCP/IP hostname:port.
Horizon: horizon.opensrs .net:55000 Live: rr-n1-tor.opensrs .net:55000
2 Reseller Agent Server sends an XCP 'check version' request.
Perl Example (hash):
{
'protocol' => 'XCP',
'action' => 'check',
'object' => 'version',
'attributes' => {
'sender' => 'OpenSRS SERVER',
'version' => '$VERSION',
'state' => 'ready'
}
}
The values of $VERSION could be something such as 'XML:0.1 ', which indicates the language spoken and the minimum version of the client required by this RSA.
At this point, the only value for 'state' is 'ready'.
Other states may be added in the future.
3 Reseller Client Client responds with an XCP 'check version' response (where version is the client's protocol version.)
Note: This number should not be changed.
It allows for API changes and backward compatibility.
If you change the version number of the client, results may be unpredictable.
Perl Example (hash):
{
'protocol' => 'XCP', 'action' => 'check', 'object' => 'version', 'attributes' => {
'sender' => 'OpenSRS CLIENT',
'version' => 'XML:0.1 ',
'state' => 'ready'
}
}
The only difference here is the value of the sender attribute.
Again, the only valid state at this point is 'ready'.
4 Reseller Client Client sends user data for authentication.
This is done using the XCP 'authenticate user' request.
Note: As a reseller, you have a password and a username.
Do NOT send the password in this request, it is not needed.
The current XML Perl Client actually sends the username in both the username and password fields.
This is because the data packets are not encrypted at this stage of the transmission.
Perl Example (hash):
{
'protocol' => 'XCP',
'action' => 'authenticate',
'object' => 'user',
'attributes' => {
'crypt_type' => '',
'username' => '',
'password' => ''
}
}
The crypt_type can be either 'des' or 'blowfish'.
5 Reseller Agent If authentication is successful, the Reseller Agent (server side), sends the first challenge, but without XML.
The challenge is a random number of random bits.
6 Reseller Client The client returns the challenge's md5 checksum, encrypted with the Reseller's private key and without XML.
7 Reseller Agent If the challenge is successful, the Reseller Agent (server) replies with an XCP 'authenticate user' response.
Perl Example (hash):
{
'protocol' => 'XCP',
'action' => 'reply',
'response_code' => '200',
'response_text' => 'Authentication Successful'
}
If the Reseller Agent deems that the Reseller Client has failed the challenge, it closes the socket without sending a decline reply because it is assumed that the Reseller Client cannot understand any of the encrypted messages anyway.
Another possible response code would be code 310, if the reseller's command rate is exceeded.
8 Reseller Client If the Reseller Client receives a response code of 200, it can then send its first XCP command.
All further communication for the established session is encrypted.
The first XCP command the client must send after being authenticated is 'set(cookie)'.
This is required because the cookie is used for all further authenticated commands.
Encryption
Supported ciphers
We currently supports the DES and Blowfish encryption algorithms.
The suggested method of using these encryption types is through their respective Perl modules, Crypt::DES and Crypt::Blowfish, which are then accessed through a common interface created by Crypt::CBC.
For your convenience, Crypt::CBC is now included in the OpenSRS client distribution.
If you are unable to install Crypt::DES or Crypt::Blowfish there is a third option available: Crypt::Blowfish_PP, which is a module for Blowfish written in Pure Perl (PP).
Our initial testing has shown this module to be at least 10 times slower than the standard Crypt::Blowfish, but it may be used as a last resort.
Private key
DES only supports keys of 8 bytes, while Blowfish supports keys of up to 56 bytes for greater security.
Private keys in OpenSRS are 112 characters in length (56 bytes), to provide the maximum security for people using Blowfish.
When creating your encryption cipher, do not use the private key in raw form.
Instead, first pack the key into a hexadecimal binary string.
In Perl this is accomplished with:
$private_key = pack('H*', $private_key);
You may then use the private key to create your encryption cipher, authenticate, and begin sending data to the server.
Updated about 2 years ago
* * *
Table of Contents
XML client protocol fundamentals
MD5 examples
Coding examples
Data exchange
Authentication handshake
Encryption Supported ciphers
Private key
[ENDPOINT]
Archive Assistant
Greetings. I am ready to analyze this library entry for you.