Sign in

v1

latestSwagger 2.02026-07-136573327.3 KB
Domains

Modify the forwarding information for the given fqdn

<strong>Notes:</strong><ul><li>shopperId is not the same as customerId. shopperId is a number of max length 10 digits (ex: 1234567890) whereas customerId is a UUIDv4 (ex: 295e3bc3-b3b9-4d95-aae5-ede41a994d13)</li></ul>

put/v2/customers/{customerId}/domains/forwards/{fqdn}

Path parameters

customerIdstring required

The Customer identifier<br/> Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id.

fqdnstring required

The fully qualified domain name whose forwarding details are to be modified.

Request body

type'MASKED' | 'REDIRECT_PERMANENT' | 'REDIRECT_TEMPORARY' required

The type of fowarding to implement<br/><ul><li><strong style='margin-left: 12px;'>MASKED</strong> - Prevents the forwarded domain or subdomain URL from displaying in the browser's address bar.</li><li><strong style='margin-left: 12px;'>REDIRECT_PERMANENT*</strong> - Redirects to the url you specified in the forwardTo field using a 301 Moved Permanently HTTP response. The HTTP 301 response code tells user-agents (including search engines) that the location has permanently moved.</li><li><strong style='margin-left: 12px;'>REDIRECT_TEMPORARY</strong> - Redirects to the url you specified in the forwardTo field using a 302 Found HTTP response. The HTTP 302 response code tells user-agents (including search engines) that the location has temporarily moved.</li></ul>

urlstring url required

Forwards http(s) traffic to this destination url (ex. http://www.somedomain.com/)

Response

Request was successful