Domains-domainName-lock:GET
From Hostway API Documentation
(Difference between revisions)
Mike.robski (Talk | contribs) m (1 revision: Release 87) |
Latest revision as of 16:22, 15 November 2013
[edit] GET /domains/{domainName}/lock
Get the current lock status of a domain. This corresponds to a status of 'clientTransferProhibited' at the registry. A domain name with this status cannot be transferred to another registrar but may be renewed and it may be modified; such as changes to the name servers or contact info.
Contents |
[edit] Request
GET /domains/{domainName}/lock
[edit] Parameters
- domainName - string
- The 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.
[edit] URI Parameters
None.
[edit] Request Headers
None.
[edit] Request Body
None.
[edit] Response
[edit] Status Code
- 200 OK
- Returns the domain lock 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.
[edit] Response Body
- true
- Means that domain lock status is set, domain is locked.
- false
- Means that domain lock status is not set, domain is unlocked.
[edit] Example of getting the domain lock status.
Request
GET /domains/example.com/lock
Response
200 OK Content-Type: application/json; charset=UTF-8 true
[edit] See also