Search in this section
Instructions for the complete automation of the deletion of a domain.
Basics of the JSON and XML API
All important information for the use of the JSON and XML API you can find in the General API Basics and the XML API Basics and JSON API Basics.
Process Overview
Flow Chart
Task Names, Codes and Routes
Task | Code | Route |
---|---|---|
DomainCancelationCreate | 0103101 | POST /domain/ {name} / cancelation |
PollConfirm | 0906 | PUT /poll/$id |
DomainInfo | 0105 | GET / domain/$name |
Process
Deleting domains is an asynchronous process because the registry is involved in the processing of the request. The request notifications are made available in the system upon receipt and can be retrieved by polling.
For more details on asynchronous notifications, see page Asynchronous Notifications.
Starting a Domain Cancelation Create Request
To delete a domain create a cancelation request (DomainCancelationCreate) with the cancelation type DELETE.
There are three options for the time of deletion (execution type):
- EXPIRE: Deletion at expiration date oof the domain
- NOW: immediate deletion
- DATE: Deletion on the specified date
For XML, the date is set in theexecdate
(=execution date) tag.
Format : yyyy-MM-dd or yyyy-MM-dd hh:mm:ss
Example : 2019-06-18 16:33:24
For JSON, it is specified as the value of theregistryWhen
field.
Format : yyyy-MM-dd'T'HH:mm:ssSSSZ
Example : 2019-06-18T16:33:24.000+02
Example: Deleting a domain at the expiration date - execution type EXPIRE
Example: Deleting a domain immediately - cancelation type NOW
Example: Deleting a domain at a specific date - execution type DATE
Checking and confirming Notifications
The order type DomainCancelationCreate creates a cancelation request.
This triggers the creation of a second cancelation request, which is processed asynchronously at the time defined in the cancelation.
Once this second requst has been processed, a request notification is sent, indicating whether the deletion was successful or not.
You must call the notification with the PollInfo task. You must confirm the retrieval with the PollConfirm task.
Since the asynchronous order does not exist at the time the notice is created, the system can not inform you of the JobID in advance. To determine whether this is the request for the desired deletion, check whether these keywords contain the values specified here in the system response sent later:
- data / job / action = delete
- data / job / type = domain
- data / object / name
These three lines indicate that it is the action "Delete", the object type that was deleted is a domain, and the name of the domain here is "example.com".