Schemas

Download schema

GenericResponse

message

string

path

string

status

integer · int32

customLogMessage

UpdateDomainForwardRequest

Returns the result of updating domain forwarding settings.

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

ActivateDomainForwardRequest

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

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

DomainForwardServiceDetailsDto

Domain forwarding configuration details.

forwardTo

string

Destination URL for forwarding

urlMasking

boolean

Whether URL masking is enabled

metaTags

string

Custom meta tags

noframes

string

Noframes content

subDomainForwarding

boolean

Whether sub-domain forwarding is enabled

pathForwarding

boolean

Whether path forwarding is enabled

subDomainPrefix

string

Sub-domain prefix

DomainForwardDnsRecordDto

DNS record entry for domain forwarding.

host

string

Record hostname

value

string

Record value

ttl

integer · int32

Time to live in seconds

recordType

string

DNS record type

ActivateDomainForwardServiceResponse

Returns domain forwarding activation status for the order.

transactionId

string

Transaction identifier

status

string

Operation status

message

string

Status message

DeleteDomainForwardResponse

Indicates whether domain forwarding was removed successfully.

status

string

Operation status

DeleteSubDomainForwardResponse

Indicates whether sub-domain forwarding was removed successfully.

status

string

Operation status

GetDomainForwardServiceResponse

Returns domain forwarding configuration for the order.

DomainForwardServiceDetailsDto

Domain forwarding configuration

status

string

Operation status

message

string

Status message

ListDomainForwardDnsRecordsResponse

Returns DNS records required for domain forwarding.

DomainForwardDnsRecordDto[]

DNS records for domain forwarding

transactionId

string

Transaction identifier

status

string

Operation status

message

string

Status message

UpdateDomainForwardServiceResponse

Returns the result of updating domain forwarding settings.

transactionId

string

Transaction identifier

status

string

Operation status

message

string

Status message

UpdateDomainForwardRequest

Returns the result of updating domain forwarding settings.

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

ActivateDomainForwardRequest

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

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

DomainForwardServiceDetailsDto

Domain forwarding configuration details.

forwardTo

string

Destination URL for forwarding

urlMasking

boolean

Whether URL masking is enabled

metaTags

string

Custom meta tags

noframes

string

Noframes content

subDomainForwarding

boolean

Whether sub-domain forwarding is enabled

pathForwarding

boolean

Whether path forwarding is enabled

subDomainPrefix

string

Sub-domain prefix