Domains-domainName-lock:PUT
From Hostway API Documentation
(Difference between revisions)
Mike.robski (Talk | contribs) m (1 revision: Release 87) |
Latest revision as of 15:21, 15 November 2013
PUT /domains/{domainName}/lock
Put a domain name on lock status. 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 |
Request
PUT /domains/{domainName}/lock
Parameters
- domainName - string
- The valid domain name to retrieve 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 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
- true
- Set the body to 'true' in order to add the lock.
- false
- Set the body to false in order to have the lock removed.
Response
Status Code
- 204 OK (No Content)
- Domain lock 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 lock domain.
Request
PUT /domains/example.com/lock true
Response
204 No Content
See also