Coolify Octri Demo
PATCH/servers/{uuid}

Update

Update Server. Changing proxy_type needs a token with the write and deploy permissions.

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

1 parameter · 20 body fields
uuidstringrequired
Server UUID

Server updated.

backup_compression_cpu_percentageintegeroptional
Maximum CPU percentage that backup compression can use. Default: 25.
Allowed:255075100
concurrent_buildsintegeroptional
Number of concurrent builds.
connection_timeoutintegeroptional
SSH connection timeout in seconds (1-300). Default: 10.
deployment_queue_limitintegeroptional
Maximum number of queued deployments.
descriptionstringoptional
The description of the server.
dynamic_timeoutintegeroptional
Deployment timeout in seconds.
instant_validatebooleanoptional
Instant validate.
ipstringoptional
The IP of the server.
is_build_serverbooleandeprecatedoptional
Deprecated: use server_role instead. true sets server_role to build, false changes a build server to both and leaves other roles unchanged. Must not conflict with server_role.
namestringoptional
The name of the server. Must not contain control characters such as new lines.
portintegeroptional
The port of the server.
private_key_uuidstringoptional
The UUID of the private key.
proxy_typestringoptional
The proxy type. Changing it starts the new proxy on the server and needs the deploy permission.
Allowed:traefikcaddynone
server_disk_usage_check_frequencystringoptional
Cron expression for disk usage check frequency.
server_disk_usage_notification_interval_hoursintegeroptional
Minimum hours between high disk usage notifications (1-720). Default: 24.
server_disk_usage_notification_thresholdintegeroptional
Server disk usage notification threshold (%).
server_rolestringoptional
Server role.
Allowed:deploymentbuildboth
server_timezonestringoptional
Timezone of the server, for example Europe/Berlin. Scheduled tasks and backups use it.
userstringoptional
The user of the server.
wildcard_domainstringoptional
Wildcard domain (URL) used to generate domains for new resources on this server. Null removes it.

6 status codes
201Server updated.
descriptionstringoptional
The server description.
high_disk_usage_notification_sentbooleanoptional
The flag to indicate if the high disk usage notification has been sent.
idintegeroptional
The server ID.
ipstringoptional
The IP address.
log_drain_notification_sentbooleanoptional
The flag to indicate if the log drain notification has been sent.
namestringoptional
The server name.
portintegeroptional
The port number.
proxyobjectoptional
The proxy configuration.
proxy_typestringoptional
The proxy type.
Allowed:traefikcaddynone
settingsobjectoptional
Server Settings model
swarm_clusterstringoptional
The swarm cluster configuration.
unreachable_countintegeroptional
The unreachable count for your server.
unreachable_notification_sentbooleanoptional
The flag to indicate if the unreachable notification has been sent.
userstringoptional
The user.
uuidstringoptional
The server UUID.
validation_logsstringoptional
The validation logs.
400Invalid token.
messagestringoptional
401Unauthenticated.
messagestringoptional
403The token needs the deploy permission to change the proxy type.
404Resource not found.
messagestringoptional
422Validation error.
errorsobjectoptional
messagestringoptional

Error handling

A 400 is returned: Invalid token. A 401 is returned: Unauthenticated. A 403 is returned: The token needs the deploy permission to change the proxy type. A 404 is returned: Resource not found. A 422 is returned: Validation error.