restore_domain

Syntax

{
   <credentials object> 
   "domain": <domain name>, 
   "id": <domain id>, 
   "new_name": <new domain name>
}

Request fields for restore_domain

The following fields can be used in the restore_domain method:

Field name	Obligation	Definition/Value
domain	Required	The current name of the domain you want to restore.
id	Required	The domain id. This value can be retrieved by using the search_domains method with the deleted field set to true.
new_name	Required	The new name for the domain. This value must be submitted, but can be the same as domain (the original domain name).

Response fields for restore_domain

The following fields may be returned in response to the restore_domain method:

Field name	Obligation	Description/Value
error	Returned if success = false	A text string that explains the error.
error_number	Returned if success = false	A number that represents the error.
success	Always returned	Indicates whether the request was successful or not. Allowed values are true and false.

Examples for restore_domain

Request

{
  "credentials": {
    "user": "[email protected]",
    "password": "sw0rdf1sh"
  },
  "domain": "example2.com",
  "id": "1325876554",
  "new_name": "example2-restored.com"
}

Response

{
  "success": true,
}