Deploy Server

Authorizations

Authorization

string

header

required

Body

data

object

Show child attributes

data.type

enum<string>

required

Available options:

servers

data.attributes

object

Show child attributes

data.attributes.project

string

The project (ID or Slug) to deploy the server

data.attributes.plan

enum<string>

The plan slug to choose server from, defining the specs the server will have

Available options:

c2-large-x86,

c2-medium-x86,

c2-small-x86,

c3-large-x86,

c3-medium-x86,

c3-small-x86,

c3-xlarge-x86,

g3-large-x86,

g3-medium-x86,

g3-small-x86,

g3-xlarge-x86,

m3-large-x86,

s2-small-x86,

s3-large-x86

data.attributes.site

enum<string>

The site slug to deploy the server

Available options:

ASH,

BGT,

BUE,

CHI,

DAL,

FRA,

LAX,

LON,

MEX,

MEX2,

MIA,

MIA2,

NYC,

SAN,

SAO,

SAO2,

SYD,

TYO,

TYO2

data.attributes.operating_system

enum<string>

The operating system slug for the new server

Available options:

ipxe,

windows_server_2019_std_v1,

ubuntu_22_04_x64_lts,

debian_11,

debian_10,

rhel8,

windows_server_2012_r2_std_v28,

windows_server_2012_r2_dc_v5,

esxi_6_7,

debian_9_4_x64,

centos_7_4_x64,

centos_8_x64,

ubuntu_16_04_x64_lts,

ubuntu_20_04_x64_lts,

windows_server_2016_std_v1,

windows_server_2016_dc_v1,

windows_server_2019_dc_v1,

debian_12,

ubuntu22_ml_in_a_box,

ubuntu_18_04_x64_lts,

windows_server_2019_std_uefi,

windows_2022_std_uefi,

windows_2022_std,

ubuntu_24_04_x64_lts,

rockylinux_8

data.attributes.hostname

string

The server hostname

data.attributes.ssh_keys

string[]

SSH Keys to set on the server

data.attributes.user_data

string

User data ID to set on the server. This is a custom script that will run after the deploy

data.attributes.raid

enum<string>

RAID mode for the server

Available options:

raid-0,

raid-1

data.attributes.ipxe

string

URL where iPXE script is stored on, OR the iPXE script encoded in base64. This attribute is required when iPXE is selected as operating system.

data.attributes.billing

enum<string>

The server billing type. Accepts hourly and monthly for on demand projects and yearly for reserved projects.

Available options:

hourly,

monthly,

yearly

Response

201 - application/vnd.api+json

Created

data

object

Show child attributes

data.id

string

data.type

string

data.attributes

object

Show child attributes

data.attributes.hostname

string

data.attributes.label

string

The server label

data.attributes.status

enum<string>

on - The server is powered ON off - The server is powered OFF unknown - The server power status is unknown ready - The server is in reinstalling state ready and should start disk_erasing shortly disk_erasing - The server is in reinstalling state disk_erasing failed_disk_erasing - The server has failed disk erasing in reinstall deploying - The server is in the last reinstalling stage and is deploying failed_deployment - The server has failed deployment in reinstall

Available options:

on,

off,

unknown,

ready,

disk_erasing,

failed_disk_erasing,

deploying,

failed_deployment

data.attributes.ipmi_status

enum<string>

Available options:

Unavailable,

Intermittent,

Normal

data.attributes.role

string

The server role (e.g. Bare Metal)

data.attributes.site

string

data.attributes.locked

boolean

data.attributes.rescue

boolean

data.attributes.primary_ipv4

string

data.attributes.primary_ipv6

string

data.attributes.created_at

string

data.attributes.scheduled_deletion_at

string

data.attributes.plan

object

Show child attributes

data.attributes.plan.id

string

The plan ID

data.attributes.plan.name

string

The plan name

data.attributes.plan.slug

string

The plan slug

data.attributes.plan.billing

string

hourly/monthly pricing. Defaults to hourly. Appliable for on_demand projects only.

data.attributes.operating_system

object

Show child attributes

data.attributes.operating_system.name

string

The OS name

data.attributes.operating_system.slug

string

The OS slug

data.attributes.operating_system.version

string

The OS description

data.attributes.operating_system.features

object

Show child attributes

data.attributes.operating_system.features.raid

boolean

data.attributes.operating_system.features.ssh_keys

boolean

data.attributes.operating_system.features.user_data

boolean

data.attributes.operating_system.distro

object

Show child attributes

data.attributes.operating_system.distro.name

string

The OS Distro name

data.attributes.operating_system.distro.slug

string

The OS Distro slug

data.attributes.operating_system.distro.series

string

The OS Distro Series

data.attributes.region

object

Show child attributes

data.attributes.region.city

string

data.attributes.region.country

string

data.attributes.region.site

object

Show child attributes

data.attributes.region.site.id

string

data.attributes.region.site.name

string

data.attributes.region.site.slug

string

data.attributes.region.site.facility

string

data.attributes.region.site.rack_id

string

data.attributes.specs

object

Show child attributes

data.attributes.specs.cpu

string

CPU model

data.attributes.specs.disk

string

Disk quantity and size in GB (e.g. 2 x 500GB)

data.attributes.specs.ram

string

RAM size in GB

data.attributes.specs.nic

string

NIC quantity and speed

data.attributes.specs.gpu

string

GPU model and quantity, if present

data.attributes.interfaces

object[]

Show child attributes

data.attributes.interfaces.role

enum<string>

Available options:

external,

internal,

ipmi,

unknown

data.attributes.interfaces.name

string

data.attributes.interfaces.mac_address

string

data.attributes.interfaces.description

string

data.attributes.project

object

Show child attributes

data.attributes.project.id

string

data.attributes.project.name

string

data.attributes.project.slug

string

data.attributes.project.description

string

data.attributes.project.billing_type

string

data.attributes.project.provisioning_type

string

data.attributes.project.billing_method

string

data.attributes.project.bandwidth_alert

boolean

data.attributes.project.environment

string

data.attributes.project.billing

object

Show child attributes

data.attributes.project.billing.subscription_id

string

data.attributes.project.billing.type

string

data.attributes.project.billing.method

string

data.attributes.project.stats

object

Show child attributes

data.attributes.project.stats.ip_addresses

integer

data.attributes.project.stats.prefixes

integer

data.attributes.project.stats.servers

integer

data.attributes.project.stats.vlans

integer

data.attributes.team

object

Show child attributes

data.attributes.team.id

string

data.attributes.team.name

string

data.attributes.team.slug

string

data.attributes.team.description

string

data.attributes.team.address

string

data.attributes.team.currency

object

data.attributes.team.status

string

data.attributes.team.feature_flags

string[]

Introduction

Endpoints

Authorizations

Body

Response