Create an Instance
post
/api/v2/instances/
Make a POST request to this resource with the following instance fields to create a new instance:
-
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
)
Request
Supported Media Types
- application/json
Root Schema : Instance
Type:
Show Source
object
-
capacity:
integer
Title:
Capacity
Read Only:true
Minimum Value:0
-
capacity_adjustment:
string(decimal)
Title:
Capacity adjustment
Default Value:1.00
-
consumed_capacity:
string
Title:
Consumed capacity
Read Only:true
-
cpu:
string(decimal)
Title:
Cpu
Read Only:true
-
cpu_capacity:
integer
Title:
Cpu capacity
Read Only:true
-
created:
string
Title:
Created
Read Only:true
-
enabled:
boolean
Title:
Enabled
Default Value:true
-
errors:
string
Title:
Errors
Read Only:true
Minimum Length:1
Any error details from the last health check. -
health_check_pending:
string
Title:
Health check pending
Read Only:true
-
health_check_started:
string(date-time)
Title:
Health check started
Read Only:true
The last time a health check was initiated on this instance. -
hostname(required):
string
Title:
Hostname
Minimum Length:1
Maximum Length:250
-
id:
integer
Title:
ID
Read Only:true
-
ip_address:
string
Title:
Ip address
Read Only:true
Minimum Length:1
-
jobs_running:
integer
Title:
Jobs running
Read Only:true
Count of jobs in the running or waiting state that are targeted for this instance -
jobs_total:
integer
Title:
Jobs total
Read Only:true
Count of all jobs that target this instance -
last_health_check:
string(date-time)
Title:
Last health check
Read Only:true
Last time a health check was ran on this instance to refresh cpu, memory, and capacity. -
last_seen:
string(date-time)
Title:
Last seen
Read Only:true
Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. -
listener_port:
integer
Title:
Listener port
Minimum Value:0
Maximum Value:65535
Port that Receptor will listen for incoming connections on. -
managed_by_policy:
boolean
Title:
Managed by policy
Default Value:true
-
mem_capacity:
integer
Title:
Mem capacity
Read Only:true
-
memory:
integer
Title:
Memory
Read Only:true
Total system memory of this instance in bytes. -
modified:
string
Title:
Modified
Read Only:true
-
node_state:
string
Title:
Node state
Default Value:installed
Allowed Values:[ "provisioning", "provision-fail", "installed", "ready", "unavailable", "deprovisioning", "deprovision-fail" ]
Indicates the current life cycle stage of this instance. -
node_type:
string
Title:
Node type
Default Value:execution
Allowed 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 nodes
If True, control plane cluster nodes should automatically peer to it. -
percent_capacity_remaining:
string
Title:
Percent capacity remaining
Read Only:true
- related: string
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
-
uuid:
string
Title:
Uuid
Read Only:true
Minimum Length:1
-
version:
string
Title:
Version
Read Only:true
Minimum Length:1
Response
Supported Media Types
- application/json
201 Response
Root Schema : Instance
Type:
Show Source
object
-
capacity:
integer
Title:
Capacity
Read Only:true
Minimum Value:0
-
capacity_adjustment:
string(decimal)
Title:
Capacity adjustment
Default Value:1.00
-
consumed_capacity:
string
Title:
Consumed capacity
Read Only:true
-
cpu:
string(decimal)
Title:
Cpu
Read Only:true
-
cpu_capacity:
integer
Title:
Cpu capacity
Read Only:true
-
created:
string
Title:
Created
Read Only:true
-
enabled:
boolean
Title:
Enabled
Default Value:true
-
errors:
string
Title:
Errors
Read Only:true
Minimum Length:1
Any error details from the last health check. -
health_check_pending:
string
Title:
Health check pending
Read Only:true
-
health_check_started:
string(date-time)
Title:
Health check started
Read Only:true
The last time a health check was initiated on this instance. -
hostname(required):
string
Title:
Hostname
Minimum Length:1
Maximum Length:250
-
id:
integer
Title:
ID
Read Only:true
-
ip_address:
string
Title:
Ip address
Read Only:true
Minimum Length:1
-
jobs_running:
integer
Title:
Jobs running
Read Only:true
Count of jobs in the running or waiting state that are targeted for this instance -
jobs_total:
integer
Title:
Jobs total
Read Only:true
Count of all jobs that target this instance -
last_health_check:
string(date-time)
Title:
Last health check
Read Only:true
Last time a health check was ran on this instance to refresh cpu, memory, and capacity. -
last_seen:
string(date-time)
Title:
Last seen
Read Only:true
Last time instance ran its heartbeat task for main cluster nodes. Last known connection to receptor mesh for execution nodes. -
listener_port:
integer
Title:
Listener port
Minimum Value:0
Maximum Value:65535
Port that Receptor will listen for incoming connections on. -
managed_by_policy:
boolean
Title:
Managed by policy
Default Value:true
-
mem_capacity:
integer
Title:
Mem capacity
Read Only:true
-
memory:
integer
Title:
Memory
Read Only:true
Total system memory of this instance in bytes. -
modified:
string
Title:
Modified
Read Only:true
-
node_state:
string
Title:
Node state
Default Value:installed
Allowed Values:[ "provisioning", "provision-fail", "installed", "ready", "unavailable", "deprovisioning", "deprovision-fail" ]
Indicates the current life cycle stage of this instance. -
node_type:
string
Title:
Node type
Default Value:execution
Allowed 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 nodes
If True, control plane cluster nodes should automatically peer to it. -
percent_capacity_remaining:
string
Title:
Percent capacity remaining
Read Only:true
- related: string
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
-
uuid:
string
Title:
Uuid
Read Only:true
Minimum Length:1
-
version:
string
Title:
Version
Read Only:true
Minimum Length:1