Managing Domain Forwarding Service
Knowledge Base
Categories: DNS API
Manage Domain Forwarding Settings Using the API
When you want to update Domain Forwarding settings for a domain. This article explains how to manage forwarding destination, URL masking, meta tags, noframes content, subdomain forwarding, and path forwarding using the API.
Description
Updates settings of the Domain Forwarding service.
Note
This API call does not allow updating the settings for sub-domain forwarding. To do so, use the Activating/Managing the Domain Forwarding Service API call.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| order-id | Integer | Required | Order Id for which settings of the Domain Forwarding service needs to be updated |
| forward-to | String | Required | URL where you want to forward your request. |
| url-masking | Boolean | Optional | Possible values are true or false. If true passed, visitors will see the source URL and not the destination URL. |
| meta-tags | String | Optional |
Sets META Tags and Page Title for the frames page which is sent to the visitor. eg. <title>Your Webpage title can be mentioned here</title><meta name="keywords" CONTENT="Your comma-separated keywords are entered here"><meta name="description" CONTENT="Enter website description here"> |
| noframes | String | Optional |
Sets alternate <NOFRAMES> page content for search engines. Provide your HTML within <NOFRAMES></NOFRAMES> tags to set alternate page content. |
| sub-domain-forwarding | Boolean | Optional | Possible values are true or false. For e.g. if true passed, a request made to https://subdomain.domainname.com will be forwarded to https://destination-domainname.com/subdomain |
| path-forwarding | Boolean | Optional | Possible values are true or false. For e.g. if true passed, a request made to https://domainname.com/some/path will be forwarded to https://destination-domainname.com/some/path |
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/domainforward/manage.xml?auth-userid=0&api-key=key&order-id=0
Response
Returns a map containing "Success" as status if the settings updated successfully.
Did you find this article helpful?