Allocate Server

Time	Status	User Agent
Retrieving recent requests…

hostname

string

Hostname assigned to the server. This value is applied to the operating system during provisioning. If using Custom iPXE, this will serve as a human-readable identifier for the server.

locationId

number

required

Identifier of the data center location where the server is provisioned.

osId

number

required

Identifier of the operating system template to install on the server during provisioning. The selected OS determines the base image applied at deployment time.

planId

number

required

Identifier of the service plan assigned to this server. The plan determines the server’s hardware configuration.

sshKeyId

string

This is an SSH key passed to cloud-init on provision (deprecated).

customIpxe

string

Raw iPXE script content to execute during provisioning.

This value is only used when the selected OS ID is Custom iPXE. When provided, the provisioning environment will execute the supplied script directly within iPXE instead of chainloading a URL.

customIpxeUrl

string

A fully qualified URL pointing to an iPXE script to chainload during provisioning.

This value is only used when the selected OS ID is Custom iPXE. When set, the provisioning environment will boot into iPXE and execute:

alwaysIpxe

boolean

Defaults to false

When true, the server will boot into iPXE on every reboot (persistent network boot) rather than booting from the installed OS.

raid

number

Defaults to -1

RAID configuration to apply to the server’s storage during provisioning. This option is only available on plans that support RAID.

sshPwauth

boolean

Defaults to false

Toggles password authentication upon allocating the server. Only toggles if an SSH key was provided.

sshKeyIds

array of strings

Allows for a list of SSH keys to add to cloud-init. This is an array of the SSH key UUIDs. Will default to empty.

sshKeyIds

200Allocate Server