RestoreDomain
Restores a domain that has expired, or was deleted, before it becomes available for others to register. The cost of restoring your domain is billed to your AWS account.
Not every TLD registry supports restoring domains, and the period during which a domain can be restored varies by TLD. To find out whether your domain can be restored and the period during which you can restore it, see Domains that you can register with Amazon Route 53 in the Amazon Route 53 Developer Guide.
Important
Restoring a domain typically costs more, and sometimes much more, than registering or renewing a domain. To get the restoration price for a domain before you restore it, use GetDomainPrices.
Restoration is asynchronous. The response includes an operation ID that you can use with GetOperationDetail to track the progress of the request. When the restoration succeeds, the domain reappears in the response to ListDomains.
For more information, see Restoring an expired or deleted domain in the Amazon Route 53 Developer Guide.
Request Syntax
{
"Consent": {
"Currency": "string",
"MaxPrice": number
},
"DomainName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Consent
-
Specifies the maximum price that you agree to pay to restore the domain name. This element is required if the domain has registry premium pricing, and optional if the domain is priced at the standard rate for its TLD. If you include it and the restoration price is more than
MaxPrice, the request fails.Type: Consent object
Required: No
- DomainName
-
The name of the domain that you want to restore. The domain must have been registered to the AWS account that submits the request.
Type: String
Length Constraints: Maximum length of 255.
Required: Yes
Response Syntax
{
"OperationId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- OperationId
-
Identifier for tracking the progress of the request. To query the operation status, use GetOperationDetail.
Type: String
Length Constraints: Maximum length of 255.
Errors
For information about the errors that are common to all actions, see Common Error Types.
- DuplicateRequest
-
The request is already in progress for the domain.
- message
-
The request is already in progress for the domain.
- requestId
-
ID of the request operation.
HTTP Status Code: 400
- InvalidInput
-
The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For
AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.- message
-
The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.
HTTP Status Code: 400
- OperationLimitExceeded
-
The number of operations or jobs running exceeded the allowed threshold for the account.
- message
-
The number of operations or jobs running exceeded the allowed threshold for the account.
HTTP Status Code: 400
- UnsupportedTLD
-
Amazon Route 53 does not support this top-level domain (TLD).
- message
-
Amazon Route 53 does not support this top-level domain (TLD).
HTTP Status Code: 400
Examples
Example – Restoring a domain
This example illustrates one usage of RestoreDomain.
Sample Request
POST / HTTP/1.1
host:route53domains.us-east-1.amazonaws.com
x-amz-date:20140711T205230Z
authorization:AWS4-HMAC-SHA256
Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,
SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,
Signature=[calculated-signature]
x-amz-target:Route53Domains_v20140515.RestoreDomain
user-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60
content-type:application/x-amz-json-1.1
content-length:[number of characters in the JSON string]
{
"DomainName":"example.com"
}
Sample Response
HTTP/1.1 200
Content-Length:[number of characters in the JSON string]
{
"OperationId":"308c56712-faa4-40fe-94c8-b4230example"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: