Question
How to monitor updates to changes of domain throughout the domain lifecycle?
Answer
Openprovider does not offer a real-time solution for domain change notifications like Webhooks, but there are some API methods which could be helpful is monitoring the domains.
In essence, you can consider running the searchDomainRequest with certain parameters in order to obtain lists of domains in certain statuses and check these against your records. The maximum number of domains which can be returned in each query is 1000.
It would allow you to check most of your domains statuses in a few minutes with 80-100 API calls rather than querying every domain individually.
Note that this method returns a parameter ‘total’ which will indicate the total number of results for the query. The ‘offset’ parameter is then used in subsequent calls to retrieve results which are outside the limit.
Here are some API params examples for searchDomainRequest which are not included in the general API documentation, but could be helpful for monitoring purposes:
- queueStatus, string from ['new', 'trade', 'transfer', 'transferOut', 'renew']
- This describes the queue where the domain can be found. If you are keeping track of active domains
- ‘new‘ would be domains which are requested for registration, but the process has not completed. This will always go with status “REQ” or “FAI”
- ‘renew’ are domains which are active and the next action will be renewal. Status should be “ACT”
- ‘transfer' is similar to ‘new’, but for incoming transfer requests. They should also have status “REQ” or “FAI”
- ‘transferOut' are domains which have been requested for transfer out of your account, and should have status “ACT” if they have not been approved for transfer, or “DEL” if the approval is given and the domain successfully transfers out of your account
- ‘Trade’ is a domain for which an owner trade has been request
- isDeleted, boolean.
- This indicates whether the domain record has been marked as ‘deleted’ in Openprovider.
- If a domain record is not marked as deleted, this means that actions can still be taken on them, for example failed transfers which can be re-requested, or expired domains in quarantine which can still be restored.
- Once a failed transfer is deleted, an expired domain exits “hard quarantine”, or a domain is successfully transferred out of your account, the domain record is marked as “deleted.
Parameters for various domain statuses
- Domain active
- 'status'=>'ACT',
- 'isDeleted' => false
- Domain in quarantaine.
- 'status'=>’DEL’,
- 'isDeleted' => false
- Domain transfer failed.
- 'status'=>'FAI',
- 'queueStatus' => 'transfer',
- 'isDeleted' => //true to find attempted transfers which you've deleted, and false to find transfers which still haven't been deleted
- Domain expired.
- 'status'=>’DEL’,
- 'isDeleted' => false
- Domain verification failed.
- Use the searchEmailVerificationDomainRequest method to retrieve the list of failed verifications
- ‘Status’ => string from [“failed”, “in progress” , “not verified” , “verified”]
- Domain rejected/suspended (by registry?).
- 'status'=>'FAI',
- 'queueStatus' => ‘new’,
- 'isDeleted' => false
- DNS zone (not) created.
- At this time, it unfortunately doesn’t seem possible to retrieve a list of domains where DNS zone creation failed
- Outgoing transfers
- 'status'=>'ACT',
- 'queueStatus' => 'transferOut',
- 'isDeleted' => false,