- Home
- API reference
- API documentation (JSON/XML)
- Tasks
- Redirect tasks
Redirect create
Function
The RedirectCreate task creates a new redirect for a domain or email address.
Redirections are made via a dedicated server (IP address 62.116.130.8). Parallel to the entry in the redirect administration, the domain and the desired subdomain entries must be changed to this IP address! If you run your own name servers, you have to enter the IP address manually on your name server. If you only want to set up email forwarding without web forwarding, you must change the MX of the sources to point to the IP address 62.116.130.8. Please change the IP address of the subdomain used as MX. Domains are case sensitive. The system automatically converts email addresses to lower case letters.
Examples: Redirecting domains
example.com => example.de
example.com => example.de / subfolder / index.html
Examples: Redirecting email addresses
jane_smith@example.com => jane@example.de (mode=single)
@example.com=> jane@example.de (mode=catchall)
Description
Route: POST /redirect
{
"source": "example.com",
"target": "example-target.com/test",
"type": "DOMAIN",
"mode": "HTTP"
}{
"stid": "20190701-app2-dev-15314",
"status": {
"code": "S0501",
"text": "Redirect has been created successfully.",
"type": "SUCCESS"
},
"object": {
"type": "Redirect",
"summary": 1
},
"object": {
"type": "Redirect",
"value": "example.com",
"data":
{
"created": "2014-10-24T09:43:47.000+0200",
"updated": "2017-11-17T17:35:21.000+0100",
"source": "example.com",
"target": "example-target.de/test",
"type": "DOMAIN",
"mode": "HTTP",
"domain": "example.com"
}
}
}Task code: 0501
Uses Redirect object
Domain redirect, http-mode
<request>
<auth>
<user>customer</user>
<password>password</password>
<context>4</context>
</auth>
<task>
<code>0501</code>
<redirect>
<type>domain</type>
<mode>http</mode>
<source>www.source-example.com</source>
<target>www.target-example.com</target>
</redirect>
</task>
</request><response>
<result>
<status>
<code>S0501</code>
<text>Redirect has been created successfully.</text>
<type>success</type>
</status>
</result>
</response>Domain redirect, frame mode
<request>
<auth>
<user>customer</user>
<password>password</password>
<context>4</context>
</auth>
<task>
<code>0501</code>
<redirect>
<type>domain</type>
<mode>frame</mode>
<title>Redirection-Title</title>
<source>www.source-example.com</source>
<target>www.target-example.com</target>
<backup>www.backup-target1.de</backup>
<backup>www.backup-target2.de</backup>
<backup>www.backup-target3.de</backup>
</redirect>
</task>
</request><response>
<result>
<status>
<code>S0501</code>
<text>Redirect has been created successfully.</text>
<type>success</type>
</status>
</result>
</response>Email redirect single mode
<request>
<auth>
<user>customer</user>
<password>password</password>
<context>4</context>
</auth>
<task>
<code>0501</code>
<redirect>
<type>email</type>
<mode>single</mode>
<source>source@email-address.com</source>
<target>target@email-address.com</target>
</redirect>
</task>
</request><response>
<result>
<status>
<code>S0501</code>
<text>Redirect has been created successfully.</text>
<type>success</type>
</status>
</result>
</response>Email redirect catch-all mode
<request>
<auth>
<user>customer</user>
<password>password</password>
<context>4</context>
</auth>
<task>
<code>0501</code>
<redirect>
<type>email</type>
<mode>catchall</mode>
<source>@email-address.com</source>
<target>target@email-address.com</target>
</redirect>
</task>
</request><response>
<result>
<status>
<code>S0501</code>
<text>Redirect has been created successfully.</text>
<type>success</type>
</status>
</result>
</response>