Jump to

• Request
• Response

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)

• 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

• application/json

Path Parameters

• id(required): string

Query Parameters

• search: string
  A search term.

Body ()

Root Schema : schema

Type: object

Show Source

• credential: integer
• is_container_group: boolean
  Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster.
• name(required): string
• pod_spec_override: string
• policy_instance_list: array policy_instance_list
  List of exact-match Instances that will be assigned to this group
• policy_instance_minimum: integer
  Static minimum number of Instances that will be automatically assign to this group when new instances come online.
• policy_instance_percentage: integer
  Minimum percentage of all instances that will be automatically assigned to this group when new instances come online.

{
    "properties":{
        "credential":{
            "description":"",
            "type":"integer"
        },
        "is_container_group":{
            "description":"Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster.",
            "type":"boolean"
        },
        "name":{
            "description":"",
            "type":"string"
        },
        "pod_spec_override":{
            "description":"",
            "type":"string"
        },
        "policy_instance_list":{
            "description":"List of exact-match Instances that will be assigned to this group",
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "policy_instance_minimum":{
            "description":"Static minimum number of Instances that will be automatically assign to this group when new instances come online.",
            "type":"integer"
        },
        "policy_instance_percentage":{
            "description":"Minimum percentage of all instances that will be automatically assigned to this group when new instances come online.",
            "type":"integer"
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

Nested Schema : policy_instance_list

Type: array

List of exact-match Instances that will be assigned to this group

Show Source

• Array of: string

{
    "description":"List of exact-match Instances that will be assigned to this group",
    "items":{
        "type":"string"
    },
    "type":"array"
}

Back to Top

Response

200 Response

Back to Top