Sign in
servers

Update a server

Update one or more attributes of a server object

patch/servers/{id}

Path parameters

idstring required

Server id.

Request body

state'leaving' | 'failed'

The state to update the server to. Only servers that are currently in the 'active' state can be updated. Updating a server to the 'leaving' state causes it to leave the cluster as though it were being scaled in. Updating the server to the 'failed' state causes a replacement server to be created for it and the server to be destroyed once a replacement becomes active. If updating a server to 'leaving' would make the cluster smaller than its 'minimum_size' attribute, the operation will fail. Once a 'failed' server is successfully replaced, the server will be destroyed or detached based on the clusters 'failed_server_disposition' attribute.

Response

The call was successful.

public_addressstring required

The public address of the server

active_sincestring

An iso8601 formatted timestamp

createdstring

An iso8601 formatted timestamp

hrefstring required

The endpoint for the server resource

is_failedboolean

This will be true for a server that has been unreachable for longer than the server failure timeout for its cluster. Once a server has failed, it is not recoverable and will be replaced or destroyed

namestring required

The name of the server

private_addressstring

The private address of the server

replacement_forstring

A reference to a server being replaced by this one

state'creating' | 'joining' | 'active' | 'verifying' | 'leaving' | 'failed' | 'destroying' required

The current state of the server. The state 'creating' indicates that the virtual machine instance is getting created in the cloud but it is not ready to accept connections. The state 'verifying' indicates that the server was created successfully and it is being verified to check if the web service is responding on that server. The state 'joining' indicates that the server verification was successful and the system is being reconfigured so that the server will begin receiving traffic. The state 'active' indicates that the server is either serving the traffic or ready to accept connections. The state 'failed' indicates that the server has been unreachable for longer than the server failure timeout for its cluster and it is not recoverable and will be replaced or destroyed. The state 'leaving' indicates that the server is about to leave the cluster and the system is being reconfigured so that the server will stop receiving the traffic. The state 'destroying' indicates that the server has stopped receiving the traffic and the instance is getting deleted from the cloud

unreachable_sincestring

An iso8601 formatted timestamp

Changes