Guides

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		OptionalCan be used to search for deleted domains associated with a specific email.
Wildcards (*) are accepted.
del_from
del_to		OptionalSpecify 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		OptionalSpecify 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.
domainOptionalSubmit this attribute only to check if a specific domain has been deleted.
limitOptionalMaximum number of orders to display on a page; the default is 40.
pageOptionalDetermines 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_domainsAlways returnedAssociative array which list details about each deleted domain. For more information, see the del_domains table below.
page_sizeAlways returnedThe maximum number of domains returned per page.
totalAlways returnedThe number of deleted domains.

Response parameters within the del_domains associative array may include the following:

ParameterObligationDefinition/Value
delete_dateAlways returnedThe date the domain was deleted, in the format DD-MMM-YYYY hh:mm:ss
delete_date_epochAlways returnedThe date the domain was deleted, in UNIX time.
expiredateAlways returnedThe date the domain expired, in the format DD-MMM-YYYY hh:mm:ss
expiredate_epochAlways returnedThe date the domain expired, in UNIX time.
nameAlways returnedThe domain name that was deleted.
reasonAlways returnedIndicates the reason the domain was deleted. Possible values are:

Auction
By-Request
Expired
Historical
Transferred

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="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 over 1 year ago