APIs

Server

Download schema

Activate domain forwarding for an order

POST

https://api.sandbox.resellerclub.com/v2

/orders/{orderId}/domain-forward

Authorization (header)

+X-User-Id (header)

Turns on domain forwarding for an order, so visitors to the domain are redirected to the configured URL.

Activate domain forwarding for an order › path Parameters

orderId

integer · int32 · required

The Order Id for which Domain Forwarding service needs to be activated

Activate domain forwarding for an order › Request Body

ActivateDomainForwardRequest

forwardTo

string · minLength: 1 · required

URL where you want to forward your request.

subDomainPrefix

string

The prefix for the sub-domain

urlMasking

boolean

Possible values are true or false . If true passed, visitors will see the source URL and not the destination URL.

metaTags

string

Sets META Tags and Page Title for the frames page which is sent to the visitor. eg.

noframes

string

Sets alternate tags to set alternate page content.

subDomainForwarding

boolean

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

pathForwarding

boolean

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

Activate domain forwarding for an order › Responses

ActivateDomainForwardServiceResponse

transactionId

string

Transaction identifier

status

string

Operation status

message

string

Status message

POST/orders/{orderId}/domain-forward

curl https://api.sandbox.resellerclub.com/v2/orders/:orderId/domain-forward \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --header 'X-User-Id: <api-key>' \
  --data '{
  "forwardTo": "forwardTo",
  "subDomainPrefix": "subDomainPrefix",
  "urlMasking": true,
  "metaTags": "metaTags",
  "noframes": "noframes",
  "subDomainForwarding": true,
  "pathForwarding": true
}'

Example Request Body

{
  "forwardTo": "forwardTo",
  "subDomainPrefix": "subDomainPrefix",
  "urlMasking": true,
  "metaTags": "metaTags",
  "noframes": "noframes",
  "subDomainForwarding": true,
  "pathForwarding": true
}

json

Example Responses

{
  "transactionId": "transactionId",
  "status": "status",
  "message": "message"
}

json

application/json

Delete domain forwarding for a domain

DELETE

https://api.sandbox.resellerclub.com/v2

/domain-forward/zones/{domainName}

Authorization (header)

+X-User-Id (header)

Turns off domain forwarding for the domain entirely.

Delete domain forwarding for a domain › path Parameters

domainName

string · required

Domain name for which you want to disable domain forwarding.

Delete domain forwarding for a domain › Responses

DeleteDomainForwardResponse

status

string

Operation status

Delete sub-domain forwarding

DELETE

https://api.sandbox.resellerclub.com/v2

/orders/{orderId}/domain-forward/subdomains/{subDomainPrefix}

Authorization (header)

+X-User-Id (header)

Turns off forwarding for a specific sub-domain, without affecting forwarding on the main domain.

Delete sub-domain forwarding › path Parameters

orderId

integer · int32 · required

The Order ID of the Order for which is forwarding is to be disabled

subDomainPrefix

string · required

The prefix of the sub-domain for which you want to disable domain forwarding.

Delete sub-domain forwarding › Responses

DeleteSubDomainForwardResponse

status

string

Operation status

Get domain forwarding configuration

GET

https://api.sandbox.resellerclub.com/v2

/orders/{orderId}/domain-forward

Authorization (header)

+X-User-Id (header)

Returns the domain forwarding setup currently configured for an order, including the destination URL.

Get domain forwarding configuration › path Parameters

orderId

integer · int32 · required

Order Id for which details of the Domain Forwarding service need to be fetched

Get domain forwarding configuration › query Parameters

includeSubdomain

boolean

The sub-domain for which details of the Domain Forwarding service need to be fetched

Get domain forwarding configuration › Responses

GetDomainForwardServiceResponse

DomainForwardServiceDetailsDto

Domain forwarding configuration

status

string

Operation status

message

string

Status message

List DNS records for domain forwarding

GET

https://api.sandbox.resellerclub.com/v2

/domain-forward/zones/{domainName}/dns-records

Authorization (header)

+X-User-Id (header)

Returns the DNS records that must be set at the domain's nameserver provider for forwarding to work.

List DNS records for domain forwarding › path Parameters

domainName

string · required

Domain Name (required).

List DNS records for domain forwarding › Responses

ListDomainForwardDnsRecordsResponse

DomainForwardDnsRecordDto[]

DNS records for domain forwarding

transactionId

string

Transaction identifier

status

string

Operation status

message

string

Status message

Update domain forwarding settings

PUT

https://api.sandbox.resellerclub.com/v2

/orders/{orderId}/domain-forward

Authorization (header)

+X-User-Id (header)

Changes an order's domain forwarding setup, such as the destination URL it forwards to.

Update domain forwarding settings › path Parameters

orderId

integer · int32 · required

Order Id for which settings of the Domain Forwarding service needs to be updated

Update domain forwarding settings › Request Body

UpdateDomainForwardRequest

forwardTo

string · minLength: 1 · required

URL where you want to forward your request.

urlMasking

boolean

Possible values are true or false . If true passed, visitors will see the source URL and not the destination URL.

metaTags

string

Sets META Tags and Page Title for the frames page which is sent to the visitor. eg.

noframes

string

Sets alternate tags to set alternate page content.

subDomainForwarding

boolean

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

pathForwarding

boolean

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

Update domain forwarding settings › Responses

UpdateDomainForwardServiceResponse

transactionId

string

Transaction identifier

status

string

Operation status

message

string

Status message

PUT/orders/{orderId}/domain-forward

curl https://api.sandbox.resellerclub.com/v2/orders/:orderId/domain-forward \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --header 'X-User-Id: <api-key>' \
  --data '{
  "forwardTo": "forwardTo",
  "urlMasking": true,
  "metaTags": "metaTags",
  "noframes": "noframes",
  "subDomainForwarding": true,
  "pathForwarding": true
}'

Example Request Body

{
  "forwardTo": "forwardTo",
  "urlMasking": true,
  "metaTags": "metaTags",
  "noframes": "noframes",
  "subDomainForwarding": true,
  "pathForwarding": true
}

json

Example Responses

{
  "transactionId": "transactionId",
  "status": "status",
  "message": "message"
}

json

application/json

Domain Forward Domains

Domain Forward APIs

APIs

Server

Download schema

Activate domain forwarding for an order

POST

https://api.sandbox.resellerclub.com/v2

/orders/{orderId}/domain-forward

Authorization (header)

+X-User-Id (header)

Turns on domain forwarding for an order, so visitors to the domain are redirected to the configured URL.

Activate domain forwarding for an order › path Parameters

orderId

integer · int32 · required

The Order Id for which Domain Forwarding service needs to be activated

Activate domain forwarding for an order › Request Body

ActivateDomainForwardRequest

forwardTo

string · minLength: 1 · required

URL where you want to forward your request.

subDomainPrefix

string

The prefix for the sub-domain

urlMasking

boolean

Possible values are true or false . If true passed, visitors will see the source URL and not the destination URL.

metaTags

string

Sets META Tags and Page Title for the frames page which is sent to the visitor. eg.

noframes

string

Sets alternate tags to set alternate page content.

subDomainForwarding

boolean

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

pathForwarding

boolean

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

Activate domain forwarding for an order › Responses

ActivateDomainForwardServiceResponse

transactionId

string

Transaction identifier

status

string

Operation status

message

string

Status message

POST/orders/{orderId}/domain-forward

curl https://api.sandbox.resellerclub.com/v2/orders/:orderId/domain-forward \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --header 'X-User-Id: <api-key>' \
  --data '{
  "forwardTo": "forwardTo",
  "subDomainPrefix": "subDomainPrefix",
  "urlMasking": true,
  "metaTags": "metaTags",
  "noframes": "noframes",
  "subDomainForwarding": true,
  "pathForwarding": true
}'

Example Request Body

{
  "forwardTo": "forwardTo",
  "subDomainPrefix": "subDomainPrefix",
  "urlMasking": true,
  "metaTags": "metaTags",
  "noframes": "noframes",
  "subDomainForwarding": true,
  "pathForwarding": true
}

json

Example Responses

{
  "transactionId": "transactionId",
  "status": "status",
  "message": "message"
}

json

application/json

Delete domain forwarding for a domain

DELETE

https://api.sandbox.resellerclub.com/v2

/domain-forward/zones/{domainName}

Authorization (header)

+X-User-Id (header)

Turns off domain forwarding for the domain entirely.

Delete domain forwarding for a domain › path Parameters

domainName

string · required

Domain name for which you want to disable domain forwarding.

Delete domain forwarding for a domain › Responses

DeleteDomainForwardResponse

status

string

Operation status

Delete sub-domain forwarding

DELETE

https://api.sandbox.resellerclub.com/v2

/orders/{orderId}/domain-forward/subdomains/{subDomainPrefix}

Authorization (header)

+X-User-Id (header)

Turns off forwarding for a specific sub-domain, without affecting forwarding on the main domain.

Delete sub-domain forwarding › path Parameters

orderId

integer · int32 · required

The Order ID of the Order for which is forwarding is to be disabled

subDomainPrefix

string · required

The prefix of the sub-domain for which you want to disable domain forwarding.

Delete sub-domain forwarding › Responses

DeleteSubDomainForwardResponse

status

string

Operation status

Get domain forwarding configuration

GET

https://api.sandbox.resellerclub.com/v2

/orders/{orderId}/domain-forward

Authorization (header)

+X-User-Id (header)

Returns the domain forwarding setup currently configured for an order, including the destination URL.

Get domain forwarding configuration › path Parameters

orderId

integer · int32 · required

Order Id for which details of the Domain Forwarding service need to be fetched

Get domain forwarding configuration › query Parameters

includeSubdomain

boolean

The sub-domain for which details of the Domain Forwarding service need to be fetched

Get domain forwarding configuration › Responses

GetDomainForwardServiceResponse

DomainForwardServiceDetailsDto

Domain forwarding configuration

status

string

Operation status

message

string

Status message

List DNS records for domain forwarding

GET

https://api.sandbox.resellerclub.com/v2

/domain-forward/zones/{domainName}/dns-records

Authorization (header)

+X-User-Id (header)

Returns the DNS records that must be set at the domain's nameserver provider for forwarding to work.

List DNS records for domain forwarding › path Parameters

domainName

string · required

Domain Name (required).

List DNS records for domain forwarding › Responses

ListDomainForwardDnsRecordsResponse

DomainForwardDnsRecordDto[]

DNS records for domain forwarding

transactionId

string

Transaction identifier

status

string

Operation status

message

string

Status message

Update domain forwarding settings

PUT

https://api.sandbox.resellerclub.com/v2

/orders/{orderId}/domain-forward

Authorization (header)

+X-User-Id (header)

Changes an order's domain forwarding setup, such as the destination URL it forwards to.

Update domain forwarding settings › path Parameters

orderId

integer · int32 · required

Order Id for which settings of the Domain Forwarding service needs to be updated

Update domain forwarding settings › Request Body

UpdateDomainForwardRequest

forwardTo

string · minLength: 1 · required

URL where you want to forward your request.

urlMasking

boolean

Possible values are true or false . If true passed, visitors will see the source URL and not the destination URL.

metaTags

string

Sets META Tags and Page Title for the frames page which is sent to the visitor. eg.

noframes

string

Sets alternate tags to set alternate page content.

subDomainForwarding

boolean

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

pathForwarding

boolean

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

Update domain forwarding settings › Responses

UpdateDomainForwardServiceResponse

transactionId

string

Transaction identifier

status

string

Operation status

message

string

Status message

PUT/orders/{orderId}/domain-forward

curl https://api.sandbox.resellerclub.com/v2/orders/:orderId/domain-forward \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --header 'X-User-Id: <api-key>' \
  --data '{
  "forwardTo": "forwardTo",
  "urlMasking": true,
  "metaTags": "metaTags",
  "noframes": "noframes",
  "subDomainForwarding": true,
  "pathForwarding": true
}'

Example Request Body

{
  "forwardTo": "forwardTo",
  "urlMasking": true,
  "metaTags": "metaTags",
  "noframes": "noframes",
  "subDomainForwarding": true,
  "pathForwarding": true
}

json

Example Responses

{
  "transactionId": "transactionId",
  "status": "status",
  "message": "message"
}

json

application/json

Domain Forward Domains