PATCH
/applications/{uuid}/previews/{pull_request_id}Update preview deployment domains
Updates the domains configured for a preview deployment. Use domains for regular applications or docker_compose_domains for Docker Compose applications; public domains remain portless while any port values are stored as internal overrides.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
uuidstringrequired
The UUID of the application that owns the preview.
pull_request_idintegerrequired
The pull request ID of the preview whose domains to update.
Replacement domain configuration for a preview deployment.
docker_compose_domainsarrayoptional
Domain configurations for a Docker Compose preview, including each domain name, optional domain value, and redirect setting.
domainsstringoptional
The replacement domain configuration for a regular application preview.
force_domain_overridebooleanoptional
Set to true to force the domain override. Defaults to false when omitted.
200Returns a confirmation that the preview domains were updated.
401Returned when the request is unauthenticated.
messagestringoptional
403Returned when access to the operation is forbidden.
404Returned when a required resource is not found.
messagestringoptional
409Returned when the requested domain configuration conflicts with another domain.
422Returned when request validation fails.
errorsobjectoptional
messagestringoptional
Error handling
A 401 is returned when the request is unauthenticated, and a 403 when access is forbidden. A 404 indicates a missing resource, a 409 indicates a domain conflict, and a 422 indicates validation failed. redirect, when provided, must be www, non-www, or both.