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
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 name | Obligation | Definition/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 almost 2 years ago