Skip to content

Update

PATCH
/servers/{uuid}

Update Server.

Authorizations

Request Body required

Server updated.

object
name

The name of the server.

string
description

The description of the server.

string
ip

The IP of the server.

string
port

The port of the server.

integer
user

The user of the server.

string
private_key_uuid

The UUID of the private key.

string
is_build_server

Is build server.

boolean
instant_validate

Instant validate.

boolean
proxy_type

The proxy type.

string
Allowed values: traefik caddy none

Responses

201

Server updated.

Array<object>

Server model

object
id

The server ID.

integer
uuid

The server UUID.

string
name

The server name.

string
description

The server description.

string
ip

The IP address.

string
user

The user.

string
port

The port number.

integer
proxy

The proxy configuration.

object
proxy_type

The proxy type.

string
Allowed values: traefik caddy none
high_disk_usage_notification_sent

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

boolean
unreachable_notification_sent

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

boolean
unreachable_count

The unreachable count for your server.

integer
validation_logs

The validation logs.

string
log_drain_notification_sent

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

boolean
swarm_cluster

The swarm cluster configuration.

string
delete_unused_volumes

The flag to indicate if the unused volumes should be deleted.

boolean
delete_unused_networks

The flag to indicate if the unused networks should be deleted.

boolean

400

Invalid token.

object
message
string
Invalid token.

401

Unauthenticated.

object
message
string
Unauthenticated.

404

Resource not found.

object
message
string
Resource not found.