Jump to

• Request
• Response

Create an Instance for an Instance Group

post

/api/v2/instance_groups/{id}/instances/

Make a POST request to this resource with the following instance fields to create a new instance associated with this instance group.

• capacity_adjustment: (decimal, default=1)

• enabled: (boolean, default=True)

• managed_by_policy: (boolean, default=True)

Add Instances for an Instance Group:

Make a POST request to this resource with only an id field to associate an existing instance with this instance group.

Remove Instances from this Instance Group:

Make a POST request to this resource with id and disassociate fields to remove the instance from this instance group without deleting the instance.

Request

Supported Media Types

• application/json

Path Parameters

• id: string

Body ()

Root Schema : schema

Type: object

Show Source

• capacity_adjustment(optional): number
• enabled(optional): boolean
• managed_by_policy(optional): boolean

{
    "properties":{
        "capacity_adjustment":{
            "description":"",
            "type":"number"
        },
        "enabled":{
            "description":"",
            "type":"boolean"
        },
        "managed_by_policy":{
            "description":"",
            "type":"boolean"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

400 Response

Body

Example Response (application/json)

{
    "error":"Isolated instance group membership may not be managed via the API."
}

Back to Top