Jump to

• Request
• Response

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)

• 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

• id: string

Body ()

Root Schema : schema

Type: object

Show Source

• credential(optional): integer
• name: string
• pod_spec_override(optional): string
• policy_instance_list(optional): array policy_instance_list
  List of exact-match Instances that will be assigned to this group
• policy_instance_minimum(optional): integer
  Static minimum number of Instances that will be automatically assign to this group when new instances come online.
• policy_instance_percentage(optional): integer
  Minimum percentage of all instances that will be automatically assigned to this group when new instances come online.

{
    "properties":{
        "credential":{
            "description":"",
            "type":"integer"
        },
        "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

201 Response

Back to Top