v1

latestOpenAPI 3.0.32026-07-1415028.7 KB

Ordering

Allocate Server

post/v1/ordering/allocate

Headers

x-rd-keystring

Example:{{key}}

Request body

hostnamestring

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.

locationIdnumber required

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

osIdnumber 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.

planIdnumber required

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

sshKeyIdstring

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

customIpxestring

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.

customIpxeUrlstring

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:

alwaysIpxeboolean

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

raidnumber

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

Example request

{
  "hostname": "webserver",
  "locationId": 1,
  "osId": 48,
  "planId": 1,
  "sshKeyId": "00000000-0000-0000-0000-000000000000"
}

Response

Allocate Server

messagestring

successboolean

Example response

{
  "data": {
    "hostname": "webserver",
    "id": "00000000-0000-0000-0000-000000000000",
    "ipAddress": "121.91.234.18",
    "password": "############"
  },
  "message": "Successfully allocated server!",
  "success": true
}

All 15 operations