API Module Domain createDomainForwardingRequest
From Openprovider API documentation
(Difference between revisions)
(→Module Domain > Create domain forwarding) |
|||
| (2 intermediate revisions not shown) | |||
| Line 10: | Line 10: | ||
|'''Use''' | |'''Use''' | ||
|Create domain forwarding rule | |Create domain forwarding rule | ||
| + | |- | ||
| + | |'''Prerequisites''' | ||
| + | |After API request succeeds - A-record with forwarding service IP 185.107.225.45 should be created in DNS zone of the domain | ||
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Input''' | |'''Input''' | ||
| Line 16: | Line 19: | ||
*schemeFrom (only 'http' now) | *schemeFrom (only 'http' now) | ||
*forwardTo (hostname) | *forwardTo (hostname) | ||
| - | *forwardType ('permanent'|'temporary'|'iframe') | + | *[[API Format forwardType|forwardType]] ('permanent'|'temporary'|'iframe') |
|- | |- | ||
|'''output''' | |'''output''' | ||
| Line 22: | Line 25: | ||
*true | *true | ||
|} | |} | ||
| + | |||
| + | ==Examples== | ||
| + | ===Using PHP class=== | ||
| + | $request = new OP_Request; | ||
| + | $request->setCommand('createDomainForwardingRequest') | ||
| + | ->setAuth(array('username' => 'username', 'password' => 'password')) | ||
| + | ->setArgs(array( | ||
| + | 'forwardFrom' => 'test.nl', | ||
| + | 'schemeFrom' => 'http', | ||
| + | 'forwardTo' => 'test2.nl', | ||
| + | 'forwardType' => 'permanent', | ||
| + | )); | ||
| + | |||
| + | ===Raw XML=== | ||
| + | ''Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.'' | ||
| + | <?xml version="1.0" encoding="UTF-8"?> | ||
| + | <openXML> | ||
| + | <credentials> | ||
| + | <username>username</username> | ||
| + | <password>password</password> | ||
| + | </credentials> | ||
| + | <createDomainForwardingRequest> | ||
| + | <forwardFrom>test.nl</forwardFrom> | ||
| + | <schemeFrom>http</forwardFrom> | ||
| + | <forwardTo>test2.nl</forwardFrom> | ||
| + | <forwardType>permanent</forwardFrom> | ||
| + | </createDomainForwardingRequest> | ||
| + | </openXML> | ||
| + | |||
| + | <?xml version="1.0" encoding="UTF-8"?> | ||
| + | <openXML> | ||
| + | <reply> | ||
| + | <nowiki><code>0</code></nowiki> | ||
| + | <desc> | ||
| + | </desc> | ||
| + | <data>1</data> | ||
| + | </reply> | ||
| + | </openXML> | ||
Current revision as of 06:05, 14 December 2016
Contents |
Module Domain > Create domain forwarding
| Module | domain |
| Command name | createDomainForwardingRequest |
| Use | Create domain forwarding rule |
| Prerequisites | After API request succeeds - A-record with forwarding service IP 185.107.225.45 should be created in DNS zone of the domain |
| Input |
|
| output |
|
Examples
Using PHP class
$request = new OP_Request;
$request->setCommand('createDomainForwardingRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'forwardFrom' => 'test.nl',
'schemeFrom' => 'http',
'forwardTo' => 'test2.nl',
'forwardType' => 'permanent',
));
Raw XML
Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<credentials>
<username>username</username>
<password>password</password>
</credentials>
<createDomainForwardingRequest>
<forwardFrom>test.nl</forwardFrom>
<schemeFrom>http</forwardFrom>
<forwardTo>test2.nl</forwardFrom>
<forwardType>permanent</forwardFrom>
</createDomainForwardingRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
<code>0</code>
<desc>
</desc>
<data>1</data>
</reply>
</openXML>