Domains-domainName-hold:PUT
From Hostway API Documentation
Revision as of 15:21, 15 November 2013 by Mike.robski (Talk | contribs)
PUT /domains/{domainName}/hold
Put a domain name on hold status. This corresponds to a status of 'clientHold' at the registry. A domain name with this status is removed from the registry zone files and will cease resolving but may be transferred to another registrar, may be renewed and it may be modified; such as changes to the name servers or contact info.
Contents |
Request
PUT /domains/{domainName}/hold
Parameters
- domainName - string
- The valid domain name to put on hold including only the labels that are appropriate for a valid domain name. IE: example.com is a valid domain name , whereas http://www.example.com or www.example.com are not. If the domain name is invalid, or is otherwise not registered, an error will be returned. Domain names are case insensitive. The domain name must be an open or suspended product under the authenticated franchise.
URI Parameters
None.
Request Headers
None.
Request Body
- true
- Set the body to 'true' in order to add the hold.
- false
- Set the body to 'false' in order to have the hold removed.
Response
Status Code
- 204 OK (No Content)
- Domain hold status applied successfully.
- 400 Bad Request
- The domain name is not valid.
- 403 Forbidden
- Domain is not registered in this account and cannot be accessed.
- 404 Not Found
- No domain records found for the given domain name.
Response Body
- None
Example remove hold on a domain.
Request
PUT /domains/example.com/hold false
Response
204 No Content
See also
