Domains-domainName-hold:GET
From Hostway API Documentation
Revision as of 15:22, 15 November 2013 by Mike.robski (Talk | contribs)
GET /domains/{domainName}/hold
Get the current hold status of a domain. 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
GET /domains/{domainName}/hold
Parameters
- domainName - string
- The 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 registerable such as for a non-existent or non-supported TLD, 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
None.
Response
Status Code
- 200 OK
- Returns the domain hold status.
- 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
- true
- Means that domain hold status is set, domain is on-hold.
- false
- Means that domain hold status is not set, domain is not on-hold.
Example of getting the domain hold status.
Request
GET /domains/example.com/hold
Response
200 OK Content-Type: application/json; charset=UTF-8 true
See also
