Sign in
clusters

Modify a cluster resource

Select properties of a cluster resource can be modified using this call.

patch/clusters/{id}

Path parameters

idstring required

Cluster id.

Request body

namestring
minimum_sizeinteger

An integer of value 0 or more.

maximum_sizeinteger

An integer of value 0 or more.

instance_type'micro' | 'small' | 'medium' | 'large' | 'xlarge'

Specifies the type (size) of instances to be created.

minimum_incrementinteger

An integer of value 1 or more.

server_failure_timeoutinteger

An integer of value 0 or more.

servers_update_webhookstring uri

An HTTP URL address.

verify_timeoutinteger

The time to wait for a new server to verify. If a server does not respond to a GET / with a non-5xx status code after this many seconds, then it fails verification and will be replaced or destroyed

failed_server_disposition'destroy' | 'detach'

If set to detach, failed servers won't be deleted from cloud provider after deletion.

allocate_public_addressboolean

When set to true, server will have a public address associated with it. If set to false, the server will not have public address. Before making this change, please make sure that the proxy and servers with private addresses are in the same network. NOTE: As of now, this functionality is only supported for Centurylink cloud.

measurement_type'none' | 'lg-status' | 'self-reporting'

When self-reporting, server will post its measurements to /v2/servers/metrics periodically. When lg-status, server needs to be installed with lg_mod_status and Webscale will pull the measurements from the server periodically. When none, Webscale will not monitor the cluster

Response

The call was successful.

hrefstring nullable required

The endpoint for the cluster resource.

automatic_sizeinteger required

The size that the cluster is currently auto scaled to.

activeboolean required

Indicates if the cluster is active. Active clusters may auto scale and are monitored.

createdstring

An iso8601 formatted timestamp

delete_pendingboolean

Indicates that the cluster is about to be deleted.

namestring
minimum_sizeinteger

An integer of value 0 or more.

maximum_sizeinteger

An integer of value 0 or more.

instance_type'micro' | 'small' | 'medium' | 'large' | 'xlarge'

Specifies the type (size) of instances to be created.

minimum_incrementinteger

An integer of value 1 or more.

server_failure_timeoutinteger

An integer of value 0 or more.

servers_update_webhookstring uri

An HTTP URL address.

verify_timeoutinteger

The time to wait for a new server to verify. If a server does not respond to a GET / with a non-5xx status code after this many seconds, then it fails verification and will be replaced or destroyed

failed_server_disposition'destroy' | 'detach'

If set to detach, failed servers won't be deleted from cloud provider after deletion.

allocate_public_addressboolean

When set to true, server will have a public address associated with it. If set to false, the server will not have public address. Before making this change, please make sure that the proxy and servers with private addresses are in the same network. NOTE: As of now, this functionality is only supported for Centurylink cloud.

measurement_type'none' | 'lg-status' | 'self-reporting'

When self-reporting, server will post its measurements to /v2/servers/metrics periodically. When lg-status, server needs to be installed with lg_mod_status and Webscale will pull the measurements from the server periodically. When none, Webscale will not monitor the cluster

Changes

No recorded changes to this endpoint across all 1 revision of this API.