Skip to main content
GET
Get domain forwarding

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

domain
string
required

The domain to manage forwarding for

Minimum string length: 1
Pattern: ^\s*\S+\.[a-zA-Z]{2,}\s*$
Example:

"example.com"

Response

The requested Domain Forwarding

Web forwarding configuration for a domain ordered through Instantly

domain
string
required
read-only

The domain the forwarding configuration applies to

Example:

"example.com"

forwarding_domain
null | string

Destination domain visitors are forwarded to. Null when no forwarding is configured.

Example:

"mycompany.com"

forwarding_mode
null | enum<string>

How the forwarding domain is applied. Null when no forwarding is configured.

Available options:
redirect,
stealth,
null
Example:

"redirect"