API StatusDomain: Difference between revisions
local>ImportBot Imported from old wiki |
m 1 revision imported |
(No difference)
| |
Latest revision as of 11:56, 14 March 2025
<sidebar>
- Domains
- Main_Page|All Domains
- NewTLD_Main_Page| NewTLDs
- Premium_Domains_Main_Page| Premium Domains
- Services
- Registry_Lock|Registry Lock
- Trademark_Clearinghouse|Trademark Clearinghouse
- Early_Access_Program|Early Access Program (EAP)
- DPML|DPML
- Backorder|Backorder
- EOI_API|EOI Service
- Web_Apps|Web Apps
- RegistrarOC|RegistrarOC
- AdultBlock|AdultBlock
- AUValidation|.AU Validation Service for Natural Persons
- API & SDK
- Domain_API|Domain API
- DNS_API|DNS API
- DNSSEC|DNSSEC API
- SSL|SSL API
- Weebly API|Weebly API
- RootServer|Rootserver API
- Renewal_System|Renewal System API
- Core_API|System API
- EPP_Gateway|EPP Gateway
- https://www.hexonet.net/resellers/integration#api%7CSDKs
- Modules & Tools
- https://www.hexonet.net/resellers/integration#whmcs%7CWHMCS modules
- https://www.hexonet.net/resellers/integration#blesta%7CBlesta modules
- ISPAPI | ISPAPI Command-line interface
- Control Panel & Tools
- ControlPanel | Control Panel
- ICANN Policies
- IRTP|IRTP - Change of Registrant Policy
- ERRP| ERRP - Expired Domain Recovery Policy
- Registrant_Verification|Registrant Verification
- HEXONET & Partners
</sidebar>
API StatusDomain[edit]
description[edit]
The StatusDomain command enables you to check the current status of a domain name. It gives information about the created date, expiration, renewal mode, transfer-lock, etc.
IMPORTANT: Please have a look at the Domain API_manual for a list of allowed parameters.
COMMAND
(required) command = StatusDomain domain = (DOMAIN)
RESPONSE
(required) code = (CODE) description = (DESCRIPTION) (optional) property[createdby][0] = <TEXT> property[createddate][0] = <DATE> property[updatedby][0] = <TEXT> property[updateddate][0] = <DATE> property[registrar][0] = <TEXT> property[registrationexpirationdate][0] = <DATE> property[auth][0] = <TEXT> property[status][n] = <DOMAINSTATUS> property[nameserver][n] = <NAMESERVER> property[ownercontact][n] = <CONTACT> property[admincontact][n] = <CONTACT> property[techcontact][n] = <CONTACT> property[billingcontact][n] = <CONTACT> ...
renewal relevant information[edit]
The following response properties exist:
# system internal created / updated / transfer date PROPERTY[CREATEDDATE][0]=2001-01-20 13:40:16 PROPERTY[UPDATEDDATE][0]=2009-02-26 08:17:04 PROPERTY[TRANSFERDATE][0]=2008-01-26 09:43:50 # domain renewal mode is set to AUTORENEW # next action is the finalization of the domain on 2016-03-04 13:40:16 # the domain is prepaid for 2 years (till 2018-01-19 13:40:16) PROPERTY[RENEWALMODE][0]=AUTORENEW PROPERTY[NEXTACTION][0]=finalize PROPERTY[NEXTACTIONDATE][0]=2016-03-04 13:40:16 PROPERTY[PREPAIDPERIOD][0]=2Y PROPERTY[PAIDUNTILDATE][0]=2018-01-19 13:40:16 # accounting period # the accounting of the domain will be on expiration date (if not already explicitly paid before) PROPERTY[ACCOUNTINGPERIOD][0]=0 # accounting date # the domain annual renewal fee will be charged on 2018-01-19 13:40:16 PROPERTY[ACCOUNTINGDATE][0]=2018-01-19 13:40:16 # finalization period # the finalization period is 44 days after the expiration date PROPERTY[FINALIZATIONPERIOD][0]=44d # finalization date # on the finalization date the prepaid fees will be fixed and cannot be refunded anymore PROPERTY[FINALIZATIONDATE][0]=2016-03-04 13:40:16 # failure period # the failure period is 44 days after the expiration date PROPERTY[FAILUREPERIOD][0]=44d # failure date # on the failure date the domain will be deleted (renewalmode AUTODELETE), expired (renewalmode AUTOEXPIRE) # If previous autorenew attempts failed because on insufficient credit / account termination the object will be expired too. PROPERTY[FAILUREDATE][0]=2018-03-04 13:40:16 # XIRCA system internal expiration date PROPERTY[EXPIRATIONDATE][0]=2016-01-20 13:40:16 # registry expirationd ate PROPERTY[REGISTRATIONEXPIRATIONDATE][0]=2016-01-20 13:40:16
Please have a look at HEXONET Renewal System to understand how the system internal renewal works.