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.

Request parameters for get_deleted_domains

Standard parameters

  • action = get_deleted_domains
  • object = domain

Attributes

Parameters within the attributes associative array are described below.

Parameter name

Obligation

Definition / Value

admin_email

Optional

Can be used to search for deleted domains associated with a specific admin email. Wildcards (*) are accepted.

billing_email

Optional

Can be used to search for deleted domains associated with a specific billing email. Wildcards (*) are accepted.

del_from

Optional

Specify a starting date, in the format YYYY-MM-DD, from which to return deleted domains.

Can be used with the del_to attribute to specify a range to search within.

If not used with del_to, all domains from the del_from date onward are returned.

Note: The year specified cannot exceed 2030; otherwise an error is returned.

del_to

Optional

Specify an end date, in the format YYYY-MM-DD, before which to return deleted domains.

Can be used with the del_from attribute to specify a range to search within.

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.

domain

Optional

Submit this attribute only if you want to check if a particular domain has been deleted.

exp_from

Optional

Specify a starting date, in the format YYYY-MM-DD, from which to return expired-deleted domains.

Can be used with the exp_to attribute to specify a range to search within.

If not used with exp_to, all expired-deleted domains from the exp_from date onward are returned.

Note: The year specified cannot exceed 2030; otherwise an error is returned.

exp_to

Optional

Specify a date, in the format YYYY-MM-DD, before which to return expired-deleted domains.

Can be used with the exp_from attribute to specify a range to search within.

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.

limit

Optional

The maximum number of domains to return per page.

owner_email

Optional

Can be used to search for deleted domains associated with a specific owner email. Wildcards (*) are accepted.

page

Optional

Determines which page to retrieve, using the page number. The page index starts at 0 (zero).

tech_email

Optional

Can be used to search for deleted domains associated with a specific tech email. Wildcards (*) are accepted.

Response parameters for get_deleted_domains

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 name

Obligation

Definition / Value

del_domains

Returned if is_success = true

Contains arrays that list details about each deleted domain.

For more information, see the Del_Domains table below.

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 deleted domains.

Del_Domains

Parameters within the del_domains associative array are described below.

Parameter name

Obligation

Definition / Value

delete_date

Always returned for deleted domains.

The date that the domain was deleted, in the format DD-MMM- YYYY hh:mm:ss.

delete_date_epoch

Always returned for deleted domains.

The date that the domain was deleted, in UNIX time.

expire_date

Always returned for deleted domains.

The date that the domain will expire, in the format DD-MMM- YYYY hh:mm:ss.

expiredate_epoch

Always returned for deleted domains.

The date that the domain expires, in UNIX time.

name

Always returned if a deleted domain exists and meets the specified search criteria.

The domain that was deleted.

reason

Always returned for deleted domains.

Indicates if the domain was deleted by request (revoked), or deleted due to expiry:

  • By-Request

  • Expired

  • Transferred

  • Historical

Examples for get_deleted_domains

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_DELETED_DOMAINS</item>
                <item key="object">domain</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="owner_email">*</item>
                        <item key="del_to">2011-10-10</item>
                        <item key="admin_email">*</item>
                        <item key="limit">10</item>
                        <item key="del_from">2000-10-10</item>
                        <item key="page">1</item>
                        <item key="billing_email">*</item>
                        <item key="exp_to">2014-10-10</item>
                        <item key="tech_email">*</item>
                        <item key="exp_from">2002-10-10</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">2</item>
                        <item key="del_domains">
                            <dt_array>
                                <item key="0">
                                    <dt_assoc>
                                        <item key="expiredate_epoch">1229135427</item>
                                        <item key="delete_date">12-DEC-2004
                                            21:31:30</item>
                                        <item key="reason">By-Request</item>
                                        <item key="delete_date_epoch">1102905090</item>
                                        <item key="name">pure-
                                            1102905253608.com</item>
                                        <item key="expiredate">12-DEC-2008
                                            21:30:27</item>
                                    </dt_assoc>
                                </item>
                                <item key="1">
                                    <dt_assoc>
                                        <item key="expiredate_epoch">1229135516</item>
                                        <item key="delete_date">12-DEC-2004
                                            21:32:48</item>
                                        <item key="reason">By-Request</item>
                                        <item key="delete_date_epoch">1102905168</item>
                                        <item key="name">pure-
                                            1102905358159.net</item>
                                        <item key="expiredate">12-DEC-2008
                                            21:31:56</item>
                                    </dt_assoc>
                                </item>
                            </dt_array>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>