deployment_domain_redirect_set

Tool

deployment_domain_redirect_set

Put a domain into Redirect mode — answer a 301/302 to another domain of the same service, path and query preserved.

Put a domain into Redirect mode — answer a 301/302 to another domain of the same service, path and query preserved. Pass a null target to clear it and go back to serving.

Behavior

HTTP: PATCH /deployment/domains/:id/redirect

Arguments

Name	Type	Required	Description
id	string	•	No description in the catalog.
status	number	—	No description in the catalog.
redirectToDomainId	string	•	No description in the catalog.

Response

Field	Type	Always
id	string	•
kind	string	•
aliases	array	•
hostname	string	•
createdAt	string	•
tlsStatus	string	•
updatedAt	string	•
lastProbeAt	string	•
redirectWww	boolean	•
wwwTlsStatus	string	•
environmentId	string	•
routingStatus	string	•
lastProbeError	string	•
redirectStatus	number	•
dnsInstructions	object	•
routingRecordType	string	•
verificationToken	string	•
advertisedHostname	string	•
redirectToDomainId	string	•
verificationStatus	string	•
lastVerificationError	object	•
lastVerificationCheckAt	string	•
tlsCertificateExpiresAt	string	•

Try it

Put a domain into Redirect mode — answer a 301/302 to another domain of the same service, path and query preserved.

When to use

Put a domain into Redirect mode — answer a 301/302 to another domain of the same service, path and query preserved. Pass a null target to clear it and go back to serving.

Example

Ask your agent something like this:

Put a domain into Redirect mode — answer a 301/302 to another domain of the same service, path and query preserved.

The agent will invoke deployment_domain_redirect_set with these arguments:

{
  "id": "<id>",
  "redirectToDomainId": "<redirectToDomainId>"
}