Create an Instance Group for an Instance
post
/api/v2/instances/{id}/instance_groups/
Make a POST request to this resource with the following instance group fields to create a new instance group associated with this instance.
-
name
: Name of this instance group. (string, required) -
is_container_group
: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. (boolean, default=``) credential
: (id, default=``)policy_instance_percentage
: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. (integer, default=0
)policy_instance_minimum
: Static minimum number of Instances that will be automatically assign to this group when new instances come online. (integer, default=0
)policy_instance_list
: List of exact-match Instances that will be assigned to this group (json, default=``)pod_spec_override
: (string, default=""
)
Add Instance Groups for an Instance:
Make a POST request to this resource with only an id
field to associate an
existing instance group with this instance.
Remove Instance Groups from this Instance:
Make a POST request to this resource with id
and disassociate
fields to
remove the instance group from this instance
without deleting the instance group.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : schema
Example:
{
"disassociate":true,
"id":"1"
}
Response
Supported Media Types
- application/json
201 Response
400 Response
Example Response (application/json)
{
"msg":"Cannot change instance group membership of control-only node: control."
}