Dedicated Bare Metal
Last updated
Last updated
The procedure is documented in
Create an API Key and don’t forget to add IP whitelisting to access the API.
API Key is to be used in HTTP Header as Key = PRIVATE-TOKEN and Value = your_api_key
The host endpoint provides details on dedicated bare metal servers in your account.
To list all Hosts with full detail on hardware configuration including IP addresses:
To list details of a specific Host:
Basic action for power On/Off/Restart can be performed on each server using below endpoints:
Turn the server On:
Turn the server Off:
This endpoint allows to install a new operating system onto a server in the customer account.
You will need to know which Operating System id to use by using below endpoint:
hostname
string
Optional
Default is Server{ID}
with Unique identifier. NOTE: when installing Talos, the machine name will be derived from the hostname, taking the first part of the hostname.
os.id
int
Required
os.kernelParams
string
Optional
An advanced option, currently only applies when installing Talos (See talos OS section)
postInstallScript
string
Optional
Optional bash script to be performed after OS installation. Does not apply to Talos.
sshKeyId
UUid
Required
quickFormat
bool
Optional
Optional parameter indicating whether you want the disks to first be quick-formatted prior to OS installation. We recommend to always perform a quick-format, unless you have a specific case where it is not needed to clear the disk partitions prior to installing a new OS.
Table 1: Install OS element structure
Request Body
Talos can be installed using two methods
Talos install vanilla: provide required siderolink.api
link
Talos install via Factory image: provide required factoryhash
In both cases, additional kernel parameters are required. These will override any defaults injected. Talos default kernel parameters are:
More information about Talos kernel parameters you can find here: https://www.talos.dev/v1.7/reference/kernel/
Network configuration for your server will be automatically injected by our systems.
Request body
Request body
Restart the server:
The {hostId} parameter can be found in which lists all the servers in your account.
Trigger an OS installation:
Check the current status of the installation process:
Desired os.id look up in
Manage your SSH keys via . The public key will be installed for the root user.