Coolify Octri Demo
PATCH/servers/{uuid}/proxy

Update server proxy settings

Updates proxy settings for a server owned by the authenticated team. Set redirect behaviour, exact-label generation, the certificate resolver, or the proxy type; proxy_type must be traefik, caddy, nginx, or none. Changing proxy_type requires a token with the write and deploy permissions.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 6 body fields
uuidstringrequired
The UUID of the server whose proxy settings you want to update.

Proxy settings to update. The schema does not designate any fields as required.

generate_exact_labelsbooleanoptional
Whether to generate exact proxy labels.
proxy_error_pagestringoptional
Custom HTML error page that the proxy shows for unknown hosts (when redirect_url is empty) and for resources in maintenance mode. Null restores the default page.
proxy_typestringoptional
Proxy type (case-insensitive). Changing it starts the new proxy on the server and needs the deploy permission.
Allowed:traefikcaddynginxnone
redirect_enabledbooleanoptional
Whether to enable redirects.
redirect_urlstringoptional
Public http(s) redirect URL, or null to clear.
traefik_certificate_resolverstringoptional
Traefik certificate resolver for generated HTTPS routers (letters, digits, _ and -). Null or empty to use your own certificates. Redeploy resources to apply.

6 status codes
200Returns the updated proxy settings, including configuration, proxy type, status, redirect settings, exact-label generation, error page, and certificate resolver.
configurationstringoptional
generate_exact_labelsbooleanoptional
proxy_error_pagestringoptional
proxy_typestringoptional
redirect_enabledbooleanoptional
redirect_urlstringoptional
statusstringoptional
traefik_certificate_resolverstringoptional
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
403Returned when the token lacks the deploy permission needed to change the proxy type.
404Returned when the server resource is not found.
messagestringoptional
422Returned when a proxy setting fails validation.
errorsobjectoptional
messagestringoptional

Error handling

A 400 is returned for an invalid token, and a 401 is returned when the request is unauthenticated. A 403 is returned when changing proxy_type without the deploy permission; a 404 is returned when the server is not found. A 422 is returned when a value fails validation. The uuid path parameter must identify a server, and proxy_type must be one of traefik, caddy, nginx, or none when provided.