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 nodeexecution: Execution plane node (default)hybrid: Controller and executionhop: Message-passing node, no execution capability
-
node_state: Indicates the current life cycle stage of this instance. (choice)provisioning: Provisioningprovision-fail: Provisioning Failureinstalled: Installed (default)ready: Readyunavailable: Unavailabledeprovisioning: De-provisioningdeprovision-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
- application/json
Path Parameters
Root Schema : Instance
Type:
Show Source
object-
capacity:
integer
Title:
CapacityRead Only:trueMinimum Value:0 -
capacity_adjustment:
string(decimal)
Title:
Capacity adjustmentDefault Value:1.00 -
consumed_capacity:
string
Title:
Consumed capacityRead Only:true -
cpu:
string(decimal)
Title:
CpuRead Only:true -
cpu_capacity:
integer
Title:
Cpu capacityRead Only:true -
created:
string
Title:
CreatedRead Only:true -
enabled:
boolean
Title:
EnabledDefault Value:true -
errors:
string
Title:
ErrorsRead Only:trueMinimum Length:1Any error details from the last health check. -
health_check_pending:
string
Title:
Health check pendingRead Only:true -
health_check_started:
string(date-time)
Title:
Health check startedRead Only:trueThe last time a health check was initiated on this instance. -
hostname(required):
string
Title:
HostnameMinimum Length:1Maximum Length:250 -
id:
integer
Title:
IDRead Only:true -
ip_address:
string
Title:
Ip addressRead Only:trueMinimum Length:1 -
jobs_running:
integer
Title:
Jobs runningRead Only:trueCount of jobs in the running or waiting state that are targeted for this instance -
jobs_total:
integer
Title:
Jobs totalRead Only:trueCount of all jobs that target this instance -
last_health_check:
string(date-time)
Title:
Last health checkRead Only:trueLast time a health check was ran on this instance to refresh cpu, memory, and capacity. -
last_seen:
string(date-time)
Title:
Last seenRead Only:trueLast time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. -
listener_port:
integer
Title:
Listener portMinimum Value:0Maximum Value:65535Port that Receptor will listen for incoming connections on. -
managed_by_policy:
boolean
Title:
Managed by policyDefault Value:true -
mem_capacity:
integer
Title:
Mem capacityRead Only:true -
memory:
integer
Title:
MemoryRead Only:trueTotal system memory of this instance in bytes. -
modified:
string
Title:
ModifiedRead Only:true -
node_state:
string
Title:
Node stateDefault Value:installedAllowed Values:[ "provisioning", "provision-fail", "installed", "ready", "unavailable", "deprovisioning", "deprovision-fail" ]Indicates the current life cycle stage of this instance. -
node_type:
string
Title:
Node typeDefault Value:executionAllowed Values:[ "control", "execution", "hybrid", "hop" ]Role that this node plays in the mesh. -
peers:
array peers
Unique Items Required:
true -
peers_from_control_nodes:
boolean
Title:
Peers from control nodesIf True, control plane cluster nodes should automatically peer to it. -
percent_capacity_remaining:
string
Title:
Percent capacity remainingRead Only:true - related: string
-
summary_fields:
string
Title:
Summary fieldsRead Only:true -
type:
string
Title:
TypeRead Only:true -
url:
string
Title:
UrlRead Only:true -
uuid:
string
Title:
UuidRead Only:trueMinimum Length:1 -
version:
string
Title:
VersionRead Only:trueMinimum Length:1
Response
Supported Media Types
- application/json
200 Response
Root Schema : Instance
Type:
Show Source
object-
capacity:
integer
Title:
CapacityRead Only:trueMinimum Value:0 -
capacity_adjustment:
string(decimal)
Title:
Capacity adjustmentDefault Value:1.00 -
consumed_capacity:
string
Title:
Consumed capacityRead Only:true -
cpu:
string(decimal)
Title:
CpuRead Only:true -
cpu_capacity:
integer
Title:
Cpu capacityRead Only:true -
created:
string
Title:
CreatedRead Only:true -
enabled:
boolean
Title:
EnabledDefault Value:true -
errors:
string
Title:
ErrorsRead Only:trueMinimum Length:1Any error details from the last health check. -
health_check_pending:
string
Title:
Health check pendingRead Only:true -
health_check_started:
string(date-time)
Title:
Health check startedRead Only:trueThe last time a health check was initiated on this instance. -
hostname(required):
string
Title:
HostnameMinimum Length:1Maximum Length:250 -
id:
integer
Title:
IDRead Only:true -
ip_address:
string
Title:
Ip addressRead Only:trueMinimum Length:1 -
jobs_running:
integer
Title:
Jobs runningRead Only:trueCount of jobs in the running or waiting state that are targeted for this instance -
jobs_total:
integer
Title:
Jobs totalRead Only:trueCount of all jobs that target this instance -
last_health_check:
string(date-time)
Title:
Last health checkRead Only:trueLast time a health check was ran on this instance to refresh cpu, memory, and capacity. -
last_seen:
string(date-time)
Title:
Last seenRead Only:trueLast time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. -
listener_port:
integer
Title:
Listener portMinimum Value:0Maximum Value:65535Port that Receptor will listen for incoming connections on. -
managed_by_policy:
boolean
Title:
Managed by policyDefault Value:true -
mem_capacity:
integer
Title:
Mem capacityRead Only:true -
memory:
integer
Title:
MemoryRead Only:trueTotal system memory of this instance in bytes. -
modified:
string
Title:
ModifiedRead Only:true -
node_state:
string
Title:
Node stateDefault Value:installedAllowed Values:[ "provisioning", "provision-fail", "installed", "ready", "unavailable", "deprovisioning", "deprovision-fail" ]Indicates the current life cycle stage of this instance. -
node_type:
string
Title:
Node typeDefault Value:executionAllowed Values:[ "control", "execution", "hybrid", "hop" ]Role that this node plays in the mesh. -
peers:
array peers
Unique Items Required:
true -
peers_from_control_nodes:
boolean
Title:
Peers from control nodesIf True, control plane cluster nodes should automatically peer to it. -
percent_capacity_remaining:
string
Title:
Percent capacity remainingRead Only:true - related: string
-
summary_fields:
string
Title:
Summary fieldsRead Only:true -
type:
string
Title:
TypeRead Only:true -
url:
string
Title:
UrlRead Only:true -
uuid:
string
Title:
UuidRead Only:trueMinimum Length:1 -
version:
string
Title:
VersionRead Only:trueMinimum Length:1