Coolify Octri Demo
PATCH/services/{uuid}

Update a service

Updates a service's configuration and the URLs applied to its containers. Use fields such as name, docker_compose_raw, and urls to change the service; setting include_coolify_default_variables requires team admin permissions and a redeploy to take effect.

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

1 parameter · 10 body fields
uuidstringrequired
The UUID of the service to update.

Service configuration fields to update; send the fields you want to change.

connect_to_docker_networkbooleanoptional
Connect the service to the predefined docker network.
Default:false
descriptionstringoptional
The service description.
docker_compose_rawstringoptional
The base64 encoded Docker Compose content.
force_domain_overridebooleanoptional
Force domain override even if conflicts are detected.
Default:false
include_coolify_default_variablesbooleanoptional
Add the predefined COOLIFY_* variables (COOLIFY_URL, COOLIFY_FQDN, ...) to the environment. Requires team admin permissions. Redeploy to apply it.
Default:true
instant_deploybooleanoptional
The flag to indicate if the service should be deployed instantly.
is_container_label_escape_enabledbooleanoptional
Escape special characters in labels. By default, $ (and other chars) is escaped. If you want to use env variables inside the labels, turn this off.
Default:true
namestringoptional
The service name.
redact_all_env_values_in_logsbooleanoptional
Redact all environment variable values in logs. When false, only locked (shown once) values are redacted. Requires team admin permissions.
Default:true
urlsarray<object>optional
Array of URLs to be applied to containers of a service.

6 status codes
200Returns the updated service's UUID and the domains applied to it.
domainsarray<string>optional
Service domains.
uuidstringoptional
Service UUID.
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
404Returned when the service resource is not found.
messagestringoptional
409Returned when domain conflicts are detected.
conflictsarray<object>optional
messagestringoptional
warningstringoptional
422Returned when the request fails validation.
errorsobjectoptional
messagestringoptional

Error handling

A 400 indicates an invalid token, and a 401 indicates an unauthenticated request. A 404 indicates the service was not found; the uuid path parameter must identify an existing service, and a 409 indicates domain conflicts. A 422 indicates validation errors; check the reported field errors.