Domain Url Forward List
Resource path /Domain/UrlForward/List
The command is intended to retrieve the list of URL forwarding rules for a domain.
HTTPS POST/GET Request parameters:
| Parameter name | Description |
ApiKey |
The API key that we provided to you when you requested API access for your account |
Password |
The password we provided when you requested API access for your account |
Domain |
The domain name for which the URL Forwarding rules have to be retrieved |
rangeFrom and |
By default we return all rules. If you want the results paginated use these two parameters. |
ResponseFormat |
This specifies how the response will be returned. Possible values are TEXT, JSON and XML. |
Returned data:
TRANSACTID=Transaction ID
RULE_[x]_SOURCE = the source for the rule [x] where [x] is a number starting with 1 and incrementing for each rule
RULE_[x]_DESTINATION = the destination for rule [x]
RULE_[x]_ISFRAMED = YES/NO. If YES the following fields will also be present
RULE_[x]_TITLE = rule [x] title for framed redirect
RULE_[x]_DESCRIPTION = rule [x] meta description for framed redirect
RULE_[x]_KEYWORDS = rule [x] keywords for framed redirect
Example:
The result for this request is:
total_rules=3
rule_1_source=www.test-api-domain7.net
rule_1_destination=http://www.google.com
rule_1_isframed=YES
rule_1_title=
rule_1_description=
rule_1_keywords=
rule_2_source=w3.test-api-domain7.net
rule_2_destination=http://www.google.com
rule_2_isframed=YES
rule_2_title=
rule_2_description=
rule_2_keywords=
rule_3_source=w8.test-api-domain7.net
rule_3_destination=http://www.google.com
rule_3_isframed=YES
rule_3_title=
rule_3_description=
rule_3_keywords=
status=SUCCESS