Servers

Update

Update Server.

patch/servers/{uuid}

Request

  • Base URL: https://app.coolify.io/api/v1
  • URL: https://app.coolify.io/api/v1/servers/{uuid}
  • Auth: HTTP bearer

Path parameters

uuidstring required

Server UUID

Request body

namestring

The name of the server.

descriptionstring

The description of the server.

ipstring

The IP of the server.

portinteger

The port of the server.

userstring

The user of the server.

private_key_uuidstring

The UUID of the private key.

server_role'deployment' | 'build' | 'both'

Server role.

is_build_serverboolean

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.

instant_validateboolean

Instant validate.

proxy_type'traefik' | 'caddy' | 'none'

The proxy type.

concurrent_buildsinteger

Number of concurrent builds.

dynamic_timeoutinteger

Deployment timeout in seconds.

deployment_queue_limitinteger

Maximum number of queued deployments.

server_disk_usage_notification_thresholdinteger

Server disk usage notification threshold (%).

server_disk_usage_check_frequencystring

Cron expression for disk usage check frequency.

server_disk_usage_notification_interval_hoursinteger

Minimum hours between high disk usage notifications (1-720). Default: 24.

connection_timeoutinteger

SSH connection timeout in seconds (1-300). Default: 10.

Response

Server updated.

idinteger

The server ID.

uuidstring

The server UUID.

namestring

The server name.

descriptionstring

The server description.

ipstring

The IP address.

userstring

The user.

portinteger

The port number.

proxyobject

The proxy configuration.

proxy_type'traefik' | 'caddy' | 'none'

The proxy type.

high_disk_usage_notification_sentboolean

The flag to indicate if the high disk usage notification has been sent.

unreachable_notification_sentboolean

The flag to indicate if the unreachable notification has been sent.

unreachable_countinteger

The unreachable count for your server.

validation_logsstring

The validation logs.

log_drain_notification_sentboolean

The flag to indicate if the log drain notification has been sent.

swarm_clusterstring

The swarm cluster configuration.

Changes