Web Forwarding - Domain Name API

Web forwarding allows a domain to be redirecting to another website without needing to configure a web server

Become a Reseller

Filter:

All
GET
POST
PUT
DELETE
DELETE
Chargeable *

* You will be charged every time this command is run.

GET/dom/domain/{domain_uuid}/web-forward

Gets all active web forwards for the specific domain

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- domain_uuid
- String
- True
The UUID of the domain to query the web forward for

Response Details

200 Response

{
    "result" : [
        {
            "catch_all" : true,
            "created_on" : "2023-06-02",
            "forward_to" : "www.gmail.com",
            "host_name" : "email.example.com",
            "redirect_type" : 1,
            "updated_on" : "2023-06-02",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

GET/dom/domain/{domain_uuid}/web-forward/{uuid}

Gets a specific web forward for the specified domain

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the web forward to query
- domain_uuid
- String
- True
The UUID of the domain to query the web forward for

Response Details

200 Response

{
    "result" : {
        "catch_all" : true,
        "created_on" : "2023-06-02",
        "forward_to" : "www.gmail.com",
        "host_name" : "email.example.com",
        "redirect_type" : 1,
        "updated_on" : "2023-06-02",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

404 Response

{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}

POST/dom/domain/{domain_uuid}/web-forward?replace_dns={replace_dns}

Creates an web forward for the specific domain
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- domain_uuid
  
  String
  
  True
  
  The UUID of the domain to create the web forward for
- replace_dns
  
  String
  
  True
  
  When true, the domains A and CNAME records will be replaced with the web forwarding service details in the DNS zone
POST body
- Name
- Type
- Required
- catch_all
  
  boolean
  
  False
  
  When true, this forward will ignore the hostName and will apply for any host name under the target domain
- forward_to
  
  String
  
  True
  
  The destination for the web forward
- host_name
  
  String
  
  True
  
  The host name for the web forward
- redirect_type
  
  int
  
  False
  
  How the web forward will work, either 301 or a 302 redirect, defaults to a 301 redirection
JSON all-fields example:
{ "catch_all" : true, "forward_to" : "www.gmail.com", "host_name" : "email.example.com", "redirect_type" : 1 }
Response Details

201 Response
```
{
    "result" : {
        "catch_all" : true,
        "created_on" : "2023-06-02",
        "forward_to" : "www.gmail.com",
        "host_name" : "email.example.com",
        "redirect_type" : 1,
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 201,
    "status_message" : "Created"
}
```
400 Response
```
{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```
409 Response
```
{
    "result" : {},
    "status_code" : 409,
    "status_message" : "Conflict"
}
```
PUT/dom/domain/{domain_uuid}/web-forward/{uuid}

Updates the specified web forward for the specific domain
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- domain_uuid
  
  String
  
  True
  
  The UUID of the domain to update the web forward for
- uuid
  
  String
  
  True
  
  The UUID of the web forward to be updated
PUT body
- Name
- Type
- Required
- catch_all
  
  boolean
  
  False
  
  When true, this forward will ignore the hostName and will apply for any host name under the target domain
- forward_to
  
  String
  
  True
  
  The destination for the web forward
- host_name
  
  String
  
  True
  
  The host name for the web forward
- redirect_type
  
  int
  
  False
  
  How the web forward will work, either 301 or a 302 redirect, defaults to a 301 redirection
JSON all-fields example:
{ "catch_all" : true, "forward_to" : "www.gmail.com", "host_name" : "email.example.com", "redirect_type" : 1 }
Response Details

200 Response
```
{
    "result" : {
        "catch_all" : true,
        "created_on" : "2023-06-02",
        "forward_to" : "www.gmail.com",
        "host_name" : "email.example.com",
        "redirect_type" : 1,
        "updated_on" : "2023-06-02",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}
```
400 Response
```
{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```
409 Response
```
{
    "result" : {},
    "status_code" : 409,
    "status_message" : "Conflict"
}
```
DELETE/dom/domain/{domain_uuid}/web-forward/{uuid}

Deletes the specified web forward for the specific domain
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- domain_uuid
  
  String
  
  True
  
  The UUID of the domain to update the web forward for
- uuid
  
  String
  
  True
  
  The UUID of the web forward to be updated
Response Details

204 Response
```
{
    "result" : {},
    "status_code" : 204,
    "status_message" : "No Content"
}
```
400 Response
```
{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```