Create Host
POST/v1/armada/host
Create a host
Request
Query Parameters
- application/json
Body
required
Possible values: non-empty and <= 253 characters
The internal hostname of the host. Should only be addressable internally.
Possible values: non-empty and <= 253 characters
The public hostname of the host. Should be addressable from the internet.
The internal IPv4 address of the host. Should only be addressable internally.
The public IPv4 address of the host. Should be addressable from the internet.
Possible values: non-empty and <= 128 characters
The internal IPv6 address of the host. Should only be addressable internally.
Possible values: non-empty and <= 128 characters
The public IPv6 address of the host. Should be addressable from the internet.
geographic_location
object
Possible values: non-empty
Where exactly is this in the physical world.
datacenter_provider
object
Possible values: non-empty and <= 64 characters
Name of the provider of this sort. Could be things like Amazon, AWS EC2, Internap.
datacenter_location
object
Possible values: non-empty
Which datacenter region this is in using the language of the provider. Could be things like us-east-1, us-west-2, etc.
machine_class
object
A description of a type of performance characteristics either real or virtual. At DigitalOcean and Azure this is called VM Size. At AWS this is called Instance type. At Google this is called machine type or machine configuration.
datacenter_provider
object
required
The provider this machine class is associated with
Possible values: non-empty and <= 64 characters
Name of the provider of this sort. Could be things like Amazon, AWS EC2, Internap.
Possible values: non-empty and <= 64 characters
The name of the machine class used by the provider
Possible values: non-empty and <= 64 characters
The type of machine class used by the provider. General Purpose, CPU Optimized, etc.
Possible values: non-empty and <= 64 characters
Labels that can be applied to the machine class for organizational purposes
The monthly price of this machine class
The hourly price of this machine class
The number of CPUs
Possible values: non-empty
A description of the CPU including type, family, model, and stepping
Possible values: non-empty and <= 64 characters
The short description of the CPU type. e.g. Intel Xeon E5-2673 v4 @ 2.30GHz
The number of populated CPU sockets
The number of CPU cores
The number of CPU threads. Will be more than cores if hyperthreading is enabled.
The amount of memory in gigabytes
Possible values: non-empty and <= 32 characters
The type of memory. e.g. DDR4
The speed rating of the memory in MHz
Possible values: non-empty and <= 32 characters
The memory timings. e.g. 15-15-15-36
Possible values: non-empty and <= 64 characters
The type of disk. e.g. SSD
The size of the disk in gigabytes
Possible values: non-empty and <= 64 characters
The sequential read speed of the disk
Possible values: non-empty and <= 64 characters
The sequential write speed of the disk
Possible values: non-empty and <= 64 characters
The random read speed of the disk
Possible values: non-empty and <= 64 characters
The random write speed of the disk
The number of IOPS the disk can handle
The latency of the disk in milliseconds
The network speed in gigabits per second
Possible values: non-empty and <= 64 characters
The type of GPU. e.g. NVIDIA Tesla V100
The number of GPUs
The amount of GPU memory in gigabytes. Should be the lowest available memory if there are multiple GPUs.
machine_class_overrides
object
A description of a type of performance characteristics either real or virtual. At DigitalOcean and Azure this is called VM Size. At AWS this is called Instance type. At Google this is called machine type or machine configuration.
datacenter_provider
object
required
The provider this machine class is associated with
Possible values: non-empty and <= 64 characters
Name of the provider of this sort. Could be things like Amazon, AWS EC2, Internap.
Possible values: non-empty and <= 64 characters
The name of the machine class used by the provider
Possible values: non-empty and <= 64 characters
The type of machine class used by the provider. General Purpose, CPU Optimized, etc.
Possible values: non-empty and <= 64 characters
Labels that can be applied to the machine class for organizational purposes
The monthly price of this machine class
The hourly price of this machine class
The number of CPUs
Possible values: non-empty
A description of the CPU including type, family, model, and stepping
Possible values: non-empty and <= 64 characters
The short description of the CPU type. e.g. Intel Xeon E5-2673 v4 @ 2.30GHz
The number of populated CPU sockets
The number of CPU cores
The number of CPU threads. Will be more than cores if hyperthreading is enabled.
The amount of memory in gigabytes
Possible values: non-empty and <= 32 characters
The type of memory. e.g. DDR4
The speed rating of the memory in MHz
Possible values: non-empty and <= 32 characters
The memory timings. e.g. 15-15-15-36
Possible values: non-empty and <= 64 characters
The type of disk. e.g. SSD
The size of the disk in gigabytes
Possible values: non-empty and <= 64 characters
The sequential read speed of the disk
Possible values: non-empty and <= 64 characters
The sequential write speed of the disk
Possible values: non-empty and <= 64 characters
The random read speed of the disk
Possible values: non-empty and <= 64 characters
The random write speed of the disk
The number of IOPS the disk can handle
The latency of the disk in milliseconds
The network speed in gigabits per second
Possible values: non-empty and <= 64 characters
The type of GPU. e.g. NVIDIA Tesla V100
The number of GPUs
The amount of GPU memory in gigabytes. Should be the lowest available memory if there are multiple GPUs.
machine_image
object
Possible values: non-empty and <= 256 characters
The name within the context of the provider. This could be a registry path or an AWS image name.
A long form description of the image that will only be used for documentation purposes
The monthly price of this host. If set, this value will supersede any monthly_price value set by the machine_class or contract
The hourly price of this host. If set, this value will supersede any hourly_price value set by the machine_class or contract
Notes about the host. Used for extra information that doesn't fit in other fields.
Possible values: non-empty and <= 64 characters
Labels that can be applied to the host for organizational purposes
datacenter_contract
object
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone
The number of days in the contract period
The service extend period in days
The number of days notice required to cancel the contract
Possible values: non-empty
The purchase order number or description for the contract
The number of days after the invoice is sent that payment is due
The IDs of the hosts this contract is associated with
The ID of the host this host replaced
Boolean to declare if the host is a virtual machine
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone
The id of datacenter provider of the host
The id of the geographic location of the host
The id of the datacenter location of the host
The id of the machine class of the host
The id of the machine class overrides of the host
The id of the machine image of the host
The id of the datacenter contract of the host
Responses
- 200
- 422
Successful Response
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Possible values: non-empty and <= 253 characters
The internal hostname of the host. Should only be addressable internally.
Possible values: non-empty and <= 253 characters
The public hostname of the host. Should be addressable from the internet.
The internal IPv4 address of the host. Should only be addressable internally.
The public IPv4 address of the host. Should be addressable from the internet.
Possible values: non-empty and <= 128 characters
The internal IPv6 address of the host. Should only be addressable internally.
Possible values: non-empty and <= 128 characters
The public IPv6 address of the host. Should be addressable from the internet.
geographic_location
object
Possible values: non-empty
Where exactly is this in the physical world.
datacenter_provider
object
Possible values: non-empty and <= 64 characters
Name of the provider of this sort. Could be things like Amazon, AWS EC2, Internap.
datacenter_location
object
Possible values: non-empty
Which datacenter region this is in using the language of the provider. Could be things like us-east-1, us-west-2, etc.
machine_class
object
A description of a type of performance characteristics either real or virtual. At DigitalOcean and Azure this is called VM Size. At AWS this is called Instance type. At Google this is called machine type or machine configuration.
datacenter_provider
object
required
The provider this machine class is associated with
Possible values: non-empty and <= 64 characters
Name of the provider of this sort. Could be things like Amazon, AWS EC2, Internap.
Possible values: non-empty and <= 64 characters
The name of the machine class used by the provider
Possible values: non-empty and <= 64 characters
The type of machine class used by the provider. General Purpose, CPU Optimized, etc.
Possible values: non-empty and <= 64 characters
Labels that can be applied to the machine class for organizational purposes
The monthly price of this machine class
The hourly price of this machine class
The number of CPUs
Possible values: non-empty
A description of the CPU including type, family, model, and stepping
Possible values: non-empty and <= 64 characters
The short description of the CPU type. e.g. Intel Xeon E5-2673 v4 @ 2.30GHz
The number of populated CPU sockets
The number of CPU cores
The number of CPU threads. Will be more than cores if hyperthreading is enabled.
The amount of memory in gigabytes
Possible values: non-empty and <= 32 characters
The type of memory. e.g. DDR4
The speed rating of the memory in MHz
Possible values: non-empty and <= 32 characters
The memory timings. e.g. 15-15-15-36
Possible values: non-empty and <= 64 characters
The type of disk. e.g. SSD
The size of the disk in gigabytes
Possible values: non-empty and <= 64 characters
The sequential read speed of the disk
Possible values: non-empty and <= 64 characters
The sequential write speed of the disk
Possible values: non-empty and <= 64 characters
The random read speed of the disk
Possible values: non-empty and <= 64 characters
The random write speed of the disk
The number of IOPS the disk can handle
The latency of the disk in milliseconds
The network speed in gigabits per second
Possible values: non-empty and <= 64 characters
The type of GPU. e.g. NVIDIA Tesla V100
The number of GPUs
The amount of GPU memory in gigabytes. Should be the lowest available memory if there are multiple GPUs.
machine_class_overrides
object
A description of a type of performance characteristics either real or virtual. At DigitalOcean and Azure this is called VM Size. At AWS this is called Instance type. At Google this is called machine type or machine configuration.
datacenter_provider
object
required
The provider this machine class is associated with
Possible values: non-empty and <= 64 characters
Name of the provider of this sort. Could be things like Amazon, AWS EC2, Internap.
Possible values: non-empty and <= 64 characters
The name of the machine class used by the provider
Possible values: non-empty and <= 64 characters
The type of machine class used by the provider. General Purpose, CPU Optimized, etc.
Possible values: non-empty and <= 64 characters
Labels that can be applied to the machine class for organizational purposes
The monthly price of this machine class
The hourly price of this machine class
The number of CPUs
Possible values: non-empty
A description of the CPU including type, family, model, and stepping
Possible values: non-empty and <= 64 characters
The short description of the CPU type. e.g. Intel Xeon E5-2673 v4 @ 2.30GHz
The number of populated CPU sockets
The number of CPU cores
The number of CPU threads. Will be more than cores if hyperthreading is enabled.
The amount of memory in gigabytes
Possible values: non-empty and <= 32 characters
The type of memory. e.g. DDR4
The speed rating of the memory in MHz
Possible values: non-empty and <= 32 characters
The memory timings. e.g. 15-15-15-36
Possible values: non-empty and <= 64 characters
The type of disk. e.g. SSD
The size of the disk in gigabytes
Possible values: non-empty and <= 64 characters
The sequential read speed of the disk
Possible values: non-empty and <= 64 characters
The sequential write speed of the disk
Possible values: non-empty and <= 64 characters
The random read speed of the disk
Possible values: non-empty and <= 64 characters
The random write speed of the disk
The number of IOPS the disk can handle
The latency of the disk in milliseconds
The network speed in gigabits per second
Possible values: non-empty and <= 64 characters
The type of GPU. e.g. NVIDIA Tesla V100
The number of GPUs
The amount of GPU memory in gigabytes. Should be the lowest available memory if there are multiple GPUs.
machine_image
object
Possible values: non-empty and <= 256 characters
The name within the context of the provider. This could be a registry path or an AWS image name.
A long form description of the image that will only be used for documentation purposes
The monthly price of this host. If set, this value will supersede any monthly_price value set by the machine_class or contract
The hourly price of this host. If set, this value will supersede any hourly_price value set by the machine_class or contract
Notes about the host. Used for extra information that doesn't fit in other fields.
Possible values: non-empty and <= 64 characters
Labels that can be applied to the host for organizational purposes
datacenter_contract
object
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone
The number of days in the contract period
The service extend period in days
The number of days notice required to cancel the contract
Possible values: non-empty
The purchase order number or description for the contract
The number of days after the invoice is sent that payment is due
The IDs of the hosts this contract is associated with
The ID of the host this host replaced
Boolean to declare if the host is a virtual machine
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone
Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone
simple_product_assignments
object[]
Assignments for this host
Possible values: non-empty and <= 256 characters
The name of the product that will be used directly by the deployment system. e.g., paladins, roco
The number of instances of the product that will be used directly by the deployment system.
The ID of the host this assignment is associated with
{
"internal_hostname": "string",
"public_hostname": "string",
"internal_ipv4": "198.51.100.42",
"public_ipv4": "198.51.100.42",
"internal_ipv6": "string",
"public_ipv6": "string",
"geographic_location": {
"description": "string",
"geographic_location_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"datacenter_provider": {
"name": "string",
"datacenter_provider_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"datacenter_location": {
"description": "string",
"datacenter_location_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"machine_class": {
"datacenter_provider": {
"name": "string",
"datacenter_provider_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"name": "string",
"type": "string",
"labels": [
"string"
],
"monthly_price": 0,
"hourly_price": 0,
"cpu_count": 0,
"cpu_info": "string",
"cpu_type": "string",
"cpu_sockets": 0,
"cpu_cores": 0,
"cpu_threads": 0,
"memory_size_gigabytes": 0,
"memory_type": "string",
"memory_speed_rating": 0,
"memory_timings": "string",
"disk_type": "string",
"disk_size_gigabytes": 0,
"disk_sequential_read": "string",
"disk_sequential_write": "string",
"disk_random_read": "string",
"disk_random_write": "string",
"disk_iops": 0,
"disk_latency_ms": 0,
"network_gbps": 0,
"gpu_type": "string",
"gpu_count": 0,
"gpu_memory_gigabytes": 0,
"machine_class_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"machine_class_overrides": {
"datacenter_provider": {
"name": "string",
"datacenter_provider_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"name": "string",
"type": "string",
"labels": [
"string"
],
"monthly_price": 0,
"hourly_price": 0,
"cpu_count": 0,
"cpu_info": "string",
"cpu_type": "string",
"cpu_sockets": 0,
"cpu_cores": 0,
"cpu_threads": 0,
"memory_size_gigabytes": 0,
"memory_type": "string",
"memory_speed_rating": 0,
"memory_timings": "string",
"disk_type": "string",
"disk_size_gigabytes": 0,
"disk_sequential_read": "string",
"disk_sequential_write": "string",
"disk_random_read": "string",
"disk_random_write": "string",
"disk_iops": 0,
"disk_latency_ms": 0,
"network_gbps": 0,
"gpu_type": "string",
"gpu_count": 0,
"gpu_memory_gigabytes": 0,
"machine_class_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"machine_image": {
"name": "string",
"description": "string",
"machine_image_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"monthly_price": 0,
"hourly_price": 0,
"notes": "string",
"labels": [
"string"
],
"datacenter_contract": {
"start_date": "2024-07-29T15:51:28.071Z",
"end_date": "2024-07-29T15:51:28.071Z",
"cancel_date": "2024-07-29T15:51:28.071Z",
"period_days": 0,
"extend_period_days": 0,
"notice_days": 0,
"purchase_order": "string",
"payment_term_days": 0,
"hosts": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"datacenter_contract_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"prior_host_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"virtual_machine": true,
"created_datetime": "2024-07-29T15:51:28.071Z",
"key_accepted_datetime": "2024-07-29T15:51:28.071Z",
"host_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"simple_product_assignments": [
{
"name": "string",
"count": 0,
"host_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"simple_product_assignment_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
]
}
Validation Error
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
- MOD1
- MOD2
]
]
detail
object[]
loc
object[]
required
anyOf
string
integer
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}