Modifying the Protection Lock Status
From Boxis.net API Docs
Contents
Domain Function: updateLock
With this command, you are able to editing the Protection Lock Status your domain to boxis.net.
Input params
- version::String - API version (e.g. '1.0')
- timestamp::String - Sequence of characters, denoting the date and time (e.g '1336553826')
- username::String - User e-mail address (e.g 'mail1@example.com')
- authcode::String - md5 hash consisting of the concatenation of timestamp and user_key (e.g md5(1336553826BX3KwWU2SuqvoEWnjYmOibf'))
- section::String - API module name. Use 'domains' value
- action::String - API module function. Use 'updateLock' value
- domain::String - Domain name that you need to change
- protection-lock::Boolean - Enable / Disable Protection Lock service. Possible values are: 1 or 0
Output params
Example in XML (Success)
<?xml version="1.0" encoding="UTF-8"?> <return> <result>1</result> <resulttxt>success</resulttxt> <params/> <timestamp>1335767184</timestamp> </return>
Example in XML (Error)
<?xml version="1.0" encoding="UTF-8"?> <return> <result>0</result> <resulttxt>Error: {error description}</resulttxt> <params/> <timestamp>1335767184</timestamp> </return>
Example in JSON (Success)
{"result":"1", "resulttxt":"success", "params":[], "timestamp":1335777400}
Example in JSON (Error)
{"result":"0", "resulttxt":"Error: {error description}", "params":[], "timestamp":1335777400}
Example using our PHP Class
/* API LOGIN DETAILS */ $email = 'your@mail.com'; // your username $apikey = '1234567890'; // your apikey /* API COMMAND DETAILS */ $apitype = 'domains'; $command = 'updateLock'; $params = array( 'returntype' => 'xml', 'domain' => 'test1.com', 'protection-lock' => 1 ); /* PROCESS THE ACTION */ $boxisAPI = new BoxisAPIConnection($email, $apikey); $return = $boxisAPI->call($apitype, $command, $params);