Overview
This guide provides instructions on managing requests forwarded from your users' custom domains to your upstream services.
Understanding Headers in Forwarded Requests
When a request is forwarded from a custom domain, it will include additional headers to aid in processing the request accurately:
X-Served-For Header
Purpose: Identifies the custom domain from which the request was forwarded.
Example Value: If a request is made to
https://app.mydomain.com, theX-Served-Forheader will containapp.mydomain.com.
X-SaaS-Domains-IP Header
Purpose: Shows the IP address of the client that initiated the request.
Example Value: If a client with IP
37.228.203.125makes a request, theX-SaaS-Domains-IPheader will carry37.228.203.125.
Host Header
Purpose: Indicates the final destination or host of the request.
Example Value: For a request forwarded to
https://app.example.com, theHostheader will be set toapp.example.com.
Additional Security with X-SaaS-Domains-Auth-Token
To ensure the integrity and authenticity of forwarded requests, the X-SaaS-Domains-Auth-Token header can be utilized. This token is auto-generated randomly for every upstream, but can also be changed later.
Purpose: Acts as an authentication token to confirm that requests are legitimately originating from SaaS Custom Domains.
Security Note: Always verify the
X-SaaS-Domains-Auth-Tokenin your upstream to confirm that the request is authorized.
You can copy the authentication token on the upstream page:
Alternatively, you can change the token by editing the upstream:
Example Scenario
Consider the following setup and request flow:
Your Upstream Service:
https://app.example.comYour Custom Domain:
https://app.mydomain.comClient IP:
37.228.203.125
When a client makes a request to https://app.mydomain.com, the request is forwarded to your upstream https://app.example.com. The following headers are added to the forwarded request:
X-Served-For:
app.mydomain.comX-SaaS-Domains-IP:
37.228.203.125Host:
app.example.comX-SaaS-Domains-Auth-Token: [Token Value] (ensure to verify this token for security)
That's it! You can now effectively manage and secure forwarded requests to provide a reliable service to your users through their custom domains.
Until next time, keep building!
Need more help? Reach out via the Intercom chat widget and we'll be right with you!