set_forward
Forward (HTTP-redirect) a subdomain to another URL. Claims the label first if you do not own it yet, in which case an email may be required exactly as for claim_domain. Defaults to a 302 temporary redirect that preserves the request path and query. HTTPS at the edge is handled for you. A forward TAKES OVER the hostname: any A/AAAA/CNAME record on the label itself is deleted as part of this call and returned in 'replaced_records' — report those to the user, since the name no longer points where it did. Records on a sub-label (www.myapp.makes.fyi) and TXT records are untouched. If the forward fails to come up the replaced records are restored, with new ids.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cloak | No | Keep the AgentDomains hostname in the address bar and load the target inside a frame. Discouraged — breaks many sites. | |
| No | Email, if this call also claims a new name on an account without one. | ||
| label | Yes | The subdomain label, without the domain suffix (e.g. 'myapp' for myapp.makes.fyi). | |
| domain | No | Which domain to act under: 'makes.fyi' (the default) or 'agentdomains.co'. The same label can exist under each, so pass this whenever you are not using the default. | |
| target | Yes | Destination URL, including scheme (e.g. https://example.com/docs). | |
| permanent | No | Use a 301 permanent redirect instead of the default 302 temporary one. | |
| preserve_path | No | Append the incoming path and query to the target. Defaults to true; set false to always land on the target root. |