Skip to main content
POST
Cloud-Server erstellen

Authorizations

Authorization
string
header
required

Access-Token aus POST /auth/login (E-Mail und Passwort), gesendet als Authorization: Bearer <token>.

Das Token ist zeitlich begrenzt gültig. Mit dem refresh_token aus derselben Antwort holt POST /auth/token/refresh ein neues Token-Paar, ohne das Passwort erneut zu senden; POST /auth/token/invalidate macht den Refresh-Token beim Abmelden ungültig.

Ist für das Konto ein zweiter Faktor aktiv oder vorgeschrieben, liefert der Login statt des Token-Paars mfaRequired: true bzw. mfaEnrollmentRequired: true und ein kurzlebiges preAuthToken. Mit diesem Token (ebenfalls als Bearer) wird der zweite Faktor über POST /auth/2fa/verify bestätigt; erst danach gibt es das volle Token-Paar.

Headers

X-Customer-Id
string

Optionaler Kundenkontext. Ohne Header arbeitet die Anfrage im Standard-Kunden des angemeldeten Benutzers. Mit der ID eines anderen Kunden handelt die Anfrage in dessen Kontext: Listen, Lese- und Schreibzugriffe beziehen sich dann auf diesen Kunden.

Erlaubt sind der eigene Kunde, jeder Unterkunde im eigenen Teilbaum (Reseller handelt für seinen Endkunden) sowie Kunden, in denen der Benutzer selbst Mitglied ist. Übergeordnete oder fremde Kunden werden mit 403 Forbidden abgewiesen, eine unbekannte ID ebenfalls.

Die IDs der erreichbaren Kunden liefern GET /user/customers und GET /customers/{id}/children.

Example:

"01JD4Q8W3N6Y2K5T7R9V0B1C2D"

Body

application/json

The new VirtualMachine resource

customer
string
default:""
required

Defines the customer id which will own the server.

Example:

"01HDYBF5QCEPANXFYDGK99J0QY"

region
string
default:""
required

Defines the region where the server will be created.

Example:

"FRA1"

osImage
string
default:""
required

Defines the server template.

Example:

"ubuntu-20.04"

vmType
string
default:""
required

Defines the server type id which will be created.

Example:

"01HDYBF5QCEPANXFYDGK99J0QY"

hostname
string
required

Defines the hostname of the server.

Required string length: 3 - 64
Example:

"my-server"

backups
boolean
default:false

Create incremental backups. This feature will be charged by used backup storage.

ipv4
boolean
default:true

Attach a IPv4 address to the server.

ipv6
boolean
default:true

Attach a IPv6 address to the server.

sshKeys
(string | null)[]

Defines the ssh key ids which will be added to the server. The ssh keys needs to be created before.

Example:
userData
string | null

cloud-init user-data (max. 32 KiB). Requires a snippet storage in the region.

Maximum string length: 32768
Example:

"#cloud-config\npackages:\n - nginx\n"

startAfterCreate
boolean
default:true

Start the server once it has been provisioned.

Example:

true

Response

VirtualMachine resource created

id
string
read-only
Example:

"01F9Z3ZJXZQZJZJZJZJZJZJZJZ"

tasks
object[]
status
enum<string>
read-only
Available options:
pending,
starting,
creating,
running,
rebooting,
stopping,
stopped,
deleting,
shutting-down,
deleted,
deleted-pending-cleanup,
reinstalling,
error
Example:

"running"

template
object | null
name
string
Example:

"My server"

cpu
integer
Example:

4

ramMb
integer
Example:

1024

diskMb
integer
Example:

200000

ipV4
object | null
ipV6
object | null
additionalIpV4
object[]
additionalIpV6
object[]
architecture
enum<string>
Available options:
x86_64,
aarch64
Example:

"x86_64"

vmUuid
string | null
read-only

UUID of the virtual machine

Example:

"ad8f8d8f-8d8d-8d8d-8d8d-8d8d8d8d8d8d"

serviceLevelAgreement
object | null
image
object | null

Das Image, aus dem der Server aufgesetzt wurde.

userDataHash
string | null
read-only

SHA-256 der hinterlegten cloud-init-Nutzerdaten (hex).

rootPassword
string | null

Root-Passwort, wenn kein SSH-Key hinterlegt wurde. Nur in der Antwort auf das Anlegen gesetzt.

region
object
read-only

Availability zone of the cloud server