Coolify Octri Demo
PATCH/services/{uuid}/applications/{app_uuid}

Update a service application

Updates configurable fields for a compose service application. Use url to set comma-separated public URLs, and set force_domain_override to allow duplicate URLs and proceed despite domain conflicts.

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

3 parameters · 14 body fields
uuidstringrequired
The unique identifier of the service containing the application.
app_uuidstringrequired
The unique identifier of the compose service application to update.
force_domain_overridebooleanoptional
Set to true to allow duplicate URLs and proceed despite domain conflicts. Defaults to false when omitted.
Default:false

The fields to update on the compose service application; fields you omit remain unchanged.

descriptionstringoptional
A description of the service application.
exclude_from_statusbooleanoptional
Whether to exclude the application from service status checks.
human_namestringoptional
A human-readable name for the service application.
imagestringoptional
The container image to use for the service application.
is_force_https_enabledbooleanoptional
Whether to force HTTPS for the service application's domains.
is_gzip_enabledbooleanoptional
Whether to enable gzip compression.
is_log_drain_enabledbooleanoptional
Whether to enable log draining.
is_permanent_redirect_enabledbooleanoptional
Use permanent redirects (301/308) instead of temporary (302/307) for the HTTP to HTTPS and www redirects. Defaults to false.
is_stripprefix_enabledbooleanoptional
Whether to strip the configured URL prefix from requests.
max_restart_countintegeroptional
Maximum Docker restart count before Coolify stops the container. Set to 0 to disable the limit.
noindex_domainsarrayoptional
The subset of the service application domains served with an X-Robots-Tag: noindex, nofollow response header, keeping them out of search engines. Entries that are not among the domains are ignored.
redirectstringoptional
How to handle www and non-www domains. "www" redirects non-www to www, "non-www" redirects www to non-www. Both need a www and a non-www domain in url.
Allowed:bothwwwnon-www
traefik_certificate_resolverstringoptional
Traefik certificate resolver for this service application. Null uses the server setting, "none" uses no resolver.
urlstringoptional
Comma-separated list of URLs (e.g. "http://app.example.com:8080,https://app2.example.com"). Stored as fqdn.

5 status codes
200Returns the updated service application object.
401Returned when the request is unauthenticated.
messagestringoptional
404Returned when the service or service application cannot be found.
messagestringoptional
409Returned when the requested domains conflict and the `force_domain_override` query parameter is not true.
422Returned when the request fails validation.
errorsobjectoptional
messagestringoptional

Error handling

A 401 is returned when the request is unauthenticated; a 404 when the service or application is not found; a 409 for domain conflicts unless the force_domain_override query parameter is true; and a 422 for validation errors. redirect must be both, www, or non-www, and max_restart_count must be 0 or greater.