Update an Instance

patch

/api/v2/instances/{id}/

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

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

For a PATCH request, include only the fields that are being modified.

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

200 Response

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