Skip to main content
GET
Cloud-Server abrufen

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"

Path Parameters

id
string
required

VirtualMachine identifier

Response

VirtualMachine resource

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.

createdAt
string<date-time>
updatedAt
string<date-time>
region
object
read-only

Availability zone of the cloud server