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.

  • hostname: (string, required)

  • capacity_adjustment: (decimal, default=1)

  • enabled: (boolean, default=True)

  • managed_by_policy: (boolean, default=True)
  • node_type: Role that this node plays in the mesh. (choice)
    • control: Control plane node
    • execution: Execution plane node (default)
    • hybrid: Controller and execution
    • hop: Message-passing node, no execution capability
  • node_state: Indicates the current life cycle stage of this instance. (choice)

    • provisioning: Provisioning
    • provision-fail: Provisioning Failure
    • installed: Installed (default)
    • ready: Ready
    • unavailable: Unavailable
    • deprovisioning: De-provisioning
    • deprovision-fail: De-provisioning Failure
  • listener_port: Port that Receptor will listen for incoming connections on. (integer, default=None)

  • peers: (field, default=None)
  • peers_from_control_nodes: If True, control plane cluster nodes should automatically peer to it. (boolean, default=False)

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
Path Parameters
Body ()
Root Schema : Instance
Type: object
Show Source
Nested Schema : peers
Type: array
Unique Items Required: true
Show Source
Back to Top

Response

Supported Media Types

201 Response

Body ()
Root Schema : Instance
Type: object
Show Source
Nested Schema : peers
Type: array
Unique Items Required: true
Show Source
Back to Top