Activate Domain Forwarding Service Using the API

When you want to activate or manage domain forwarding using the API. This article explains forwarding configuration options and API request details.

Activating the Domain Forwarding Service

This API call can be used to Activate and Manage the Domain Forwarding service.

Name	Data Type	Required / Optional	Description
auth-userid	Integer	Required	Authentication Parameter
api-key	String	Required	Authentication Parameter
order-id	Integer	Required	The Order Id for which Domain Forwarding service needs to be activated
sub-domain-prefix	String	Optional	The prefix for the sub-domain
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`

POST

https://test.httpapi.com/api/domainforward/activate.json?auth-userid=0&api-key=key&order-id=0

Returns a map containing status information.

Did you find this article helpful?