Domains-domainName-renew:POST
From Hostway API Documentation
Revision as of 15:22, 15 November 2013 by Mike.robski (Talk | contribs)
POST /domains/{domainName}/renew
Renew a domain for a specified registration period.
Contents |
Request
POST /domains/{domainName}/renew
URI Parameters
- domainName - string
- The domain name to renew. Domain name is case insensitive.
Request Headers
- Content-Type
- Required. Set this header to
application/json; charset=UTF-8 - Authorization
- Required.
Request Body
Request Body for renewing a domain
{
"term": "{term}",
"currentExpireDate": "{expireDate}"
}
Request Parameters
- term - integer
- Required. The number of years to add to the registration term. This amount must match one of the available cycles for renewing a domain. For example, if the pricing call shows that a domain has available cycles of 1 year, 5 and 10 this means a domain may not be renewed for 3 years, since that is not an available term for renewal. A domain cannot be renewed beyond its maximum registration term. Therefore if the max registration term is 10 years and a domain expires in 5 days, it cannot be renewed for 10 years, since this would mean the new term would be 10 years and 5 days into the future. Only a domain that is already expired can be renewed for its max registration term.
- expireDate - date
- The current expiration date of the domain is required to prove that the renewal request is unique and is not a duplicate renewal that has already been processed. If the given expireDate does not match the current expiration date of the domain, the renewal request is rejected. Use the domain info command to get the expireDate of the domains. The format for the date is yyyy-mm-dd
Response
Status Code
- 201 Accepted
- The domain renewal order has been submitted.
- 400 Bad Request
- If the given data is not acceptable. The domain name may be invalid if it includes parts of the URL like 'http://'. If the registration term is not not a supported registration term for the domain, or if the expire date is in an invalid format. This error is also invoked if any of the required parameters are missing from the request.
- 403 - Not authorized
- The domain name does not belong in the account of the customer who is attempting to renew the domain. Only the account holder may renew the domain.
- 404 - Not found
- The domain name does not exist or is in a closed or suspended state and cannot be renewed.
- 409 - Conflict
- When the registration term exceeds the maximum registration period, or the current expiration date supplied in the request does not match the expire date of the domain.
Response Body
Response Body for renewing a domain None
Example of ordering domain renewal.
Request
POST /domains/ng-test-fitnesse-shortcut-20130412-0940.com/renew
Content-Type: application/json; charset=UTF-8
Authorization: Basic ...
{
"term": "1",
"currentExpireDate": "2013-09-21"
}
Response
201 Accepted
See also
