Update an Instance Group

put

/api/v2/instance_groups/{id}/

Make a PUT or PATCH request to this resource to update this instance group. The following fields may be modified:

  • name: Name of this instance group. (string, required)

  • max_concurrent_jobs: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. (integer, default=0)

  • max_forks: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. (integer, default=0)

  • 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="")

For a PUT request, include all fields in the request.

Request

Supported Media Types
Path Parameters
Body ()
Root Schema : InstanceGroup
Type: object
Show Source
Nested Schema : policy_instance_list
Type: array
List of exact-match Instances that will be assigned to this group
Show Source
Back to Top

Response

Supported Media Types

200 Response

Body ()
Root Schema : InstanceGroup
Type: object
Show Source
Nested Schema : policy_instance_list
Type: array
List of exact-match Instances that will be assigned to this group
Show Source
Back to Top