latestOpenAPI 3.0.02026-08-2045003.8 MB

72813baf8d47

Elastigroup GCP

Detach Instances

Detach instances from an Elastigroup

put/gcp/gce/group/{groupId}/deatchInstances

Parameters

#/paths/~1azure~1costs/get/parameters/0 — unresolved $ref
#/paths/~1gcp~1gce~1group~1%7BgroupId%7D/get/parameters/1 — unresolved $ref

Request body

instancesToDetachstring[]

The names of the instances to detach from the group.

shouldTerminateInstancesboolean

Indicates whether to terminate the instances or not.

shouldDecrementTargetCapacityboolean

Indicates whether to decrement the capacity of the group, so no new instance will be launched instead of the detached one.

drainingTimeoutinteger

(Applies only if shouldTerminateInstances is on) The draining timeout (in seconds) before terminating the instance. If no draining timeout is defined, the group's draining timeout applies.

Example request

{
  "instancesToDetach": [
    "sin-44c02836",
    "sin-ddf71dfa"
  ]
}