> ## Documentation Index
> Fetch the complete documentation index at: https://docs.netzfabrik.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Cloud-Server erstellen



## OpenAPI

````yaml /api-reference/openapi.json post /cloud-servers
openapi: 3.1.0
info:
  title: NETZFABRIK API
  description: >-
    REST-API der NETZFABRIK-Plattform für Domains, DNS, Cloud-Server, Webspaces,
    E-Mail-Dienste und Konto. Authentifizierung per JWT (Authorization: Bearer)
    oder API-Token (X-API-TOKEN).
  termsOfService: https://www.netzfabrik.com/tos
  contact:
    name: NETZFABRIK GmbH
    url: https://www.netzfabrik.com
    email: info@netzfabrik.com
  license:
    name: Proprietary
    url: https://www.netzfabrik.com/license
  version: 2026-11-19-9237c1a3
servers:
  - url: https://api.netzfabrik.com
security:
  - JWT: []
  - ApiToken: []
tags:
  - name: Login
  - name: Zwei-Faktor-Authentifizierung
  - name: Passkeys
  - name: Benutzer
  - name: Konten
  - name: Kunden
  - name: Verträge
  - name: Rechnungen
  - name: Support-Tickets
  - name: Domains
  - name: Domain-Bestellungen
  - name: Premium-Domains
  - name: Inhaberwechsel
  - name: Handles (Kontakte)
  - name: Handle-Verifizierung
  - name: TLD-Daten
  - name: Domain-Preise
  - name: Preislisten-Vorlagen
  - name: Preislisten-Versionen
  - name: Preis-Überschreibungen
  - name: Preisänderungen
  - name: Domain-Aktionen
  - name: Öffentliche Preislisten
  - name: Domain-Reseller
  - name: DNS-Zonen
  - name: DNS-Records
  - name: Weiterleitungen
  - name: Cloud-Server
  - name: Cloud-Server-Vorlagen
  - name: Regionen
  - name: SSH-Keys
  - name: ISO-Images
  - name: Anwendungen
  - name: Webspaces
  - name: Webspace-Tarife
  - name: Object Storage
  - name: E-Mail-Protection
  - name: E-Mail-Security
  - name: E-Mail-Archiv
  - name: Colocation
  - name: Racks
  - name: Stromzuführungen
  - name: Interconnections
  - name: VLANs
  - name: Traffic
paths:
  /cloud-servers:
    post:
      tags:
        - Cloud-Server
      summary: Cloud-Server erstellen
      operationId: createServer
      parameters:
        - $ref: '#/components/parameters/CustomerId'
      requestBody:
        description: The new VirtualMachine resource
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VirtualMachine.CreateCloudServerRequest'
        required: true
      responses:
        '201':
          description: VirtualMachine resource created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VirtualMachine-cloud-server.read'
          links: {}
        '400':
          description: Invalid input
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          links: {}
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          links: {}
        '422':
          description: An error occurred
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ConstraintViolation'
            application/json:
              schema:
                $ref: '#/components/schemas/ConstraintViolation'
          links: {}
components:
  parameters:
    CustomerId:
      name: X-Customer-Id
      in: header
      required: false
      description: >-
        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`.
      schema:
        type: string
        example: 01JD4Q8W3N6Y2K5T7R9V0B1C2D
  schemas:
    VirtualMachine.CreateCloudServerRequest:
      type: object
      properties:
        backups:
          description: >-
            Create incremental backups. This feature will be charged by used
            backup storage.
          default: false
          type: boolean
        ipv4:
          description: Attach a IPv4 address to the server.
          default: true
          type: boolean
        ipv6:
          description: Attach a IPv6 address to the server.
          default: true
          type: boolean
        customer:
          description: Defines the customer id which will own the server.
          default: ''
          example: 01HDYBF5QCEPANXFYDGK99J0QY
          type: string
        region:
          description: Defines the region where the server will be created.
          default: ''
          example: FRA1
          type: string
        osImage:
          description: Defines the server template.
          default: ''
          example: ubuntu-20.04
          type: string
        sshKeys:
          description: >-
            Defines the ssh key ids which will be added to the server. The ssh
            keys needs to be created before.
          example:
            - 01HDYBF5QCEPANXFYDGK99J0QY
            - 01HDYBF5QCEPANXFYDGK99J0QZ
          type: array
          items:
            type:
              - string
              - 'null'
        vmType:
          description: Defines the server type id which will be created.
          default: ''
          example: 01HDYBF5QCEPANXFYDGK99J0QY
          type: string
        hostname:
          minLength: 3
          maxLength: 64
          description: Defines the hostname of the server.
          example: my-server
          type: string
        userData:
          maxLength: 32768
          description: >-
            cloud-init user-data (max. 32 KiB). Requires a snippet storage in
            the region.
          example: |
            #cloud-config
            packages:
              - nginx
          type:
            - string
            - 'null'
        startAfterCreate:
          description: Start the server once it has been provisioned.
          default: true
          example: true
          type: boolean
      required:
        - customer
        - region
        - osImage
        - vmType
        - hostname
    VirtualMachine-cloud-server.read:
      type: object
      properties:
        id:
          readOnly: true
          example: 01F9Z3ZJXZQZJZJZJZJZJZJZJZ
          type: string
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/VirtualMachineTask-cloud-server.read'
        status:
          readOnly: true
          example: running
          type: string
          enum:
            - pending
            - starting
            - creating
            - running
            - rebooting
            - stopping
            - stopped
            - deleting
            - shutting-down
            - deleted
            - deleted-pending-cleanup
            - reinstalling
            - error
        template:
          readOnly: true
          anyOf:
            - $ref: '#/components/schemas/CloudServerTemplate-cloud-server.read'
            - type: 'null'
        name:
          example: My server
          type: string
        cpu:
          example: 4
          type: integer
        ramMb:
          example: 1024
          type: integer
        diskMb:
          example: 200000
          type: integer
        ipV4:
          anyOf:
            - $ref: '#/components/schemas/IpAddress-cloud-server.read'
            - type: 'null'
        ipV6:
          anyOf:
            - $ref: '#/components/schemas/IpAddress-cloud-server.read'
            - type: 'null'
        additionalIpV4:
          type: array
          items:
            $ref: '#/components/schemas/IpAddress-cloud-server.read'
        additionalIpV6:
          type: array
          items:
            $ref: '#/components/schemas/IpAddress-cloud-server.read'
        architecture:
          example: x86_64
          type: string
          enum:
            - x86_64
            - aarch64
        vmUuid:
          readOnly: true
          description: UUID of the virtual machine
          example: ad8f8d8f-8d8d-8d8d-8d8d-8d8d8d8d8d8d
          type:
            - string
            - 'null'
        serviceLevelAgreement:
          readOnly: true
          anyOf:
            - $ref: '#/components/schemas/ServiceLevelAgreement-cloud-server.read'
            - type: 'null'
        image:
          readOnly: true
          description: Das Image, aus dem der Server aufgesetzt wurde.
          anyOf:
            - $ref: '#/components/schemas/IsoImage-cloud-server.read'
            - type: 'null'
        userDataHash:
          readOnly: true
          description: SHA-256 der hinterlegten cloud-init-Nutzerdaten (hex).
          type:
            - string
            - 'null'
        rootPassword:
          description: >-
            Root-Passwort, wenn kein SSH-Key hinterlegt wurde. Nur in der
            Antwort auf das Anlegen gesetzt.
          type:
            - string
            - 'null'
        region:
          $ref: '#/components/schemas/Region-cloud-server.read'
          readOnly: true
          description: Availability zone of the cloud server
    Error:
      type: object
      description: A representation of common errors.
      properties:
        title:
          readOnly: true
          description: A short, human-readable summary of the problem.
          type:
            - string
            - 'null'
        detail:
          readOnly: true
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          type:
            - string
            - 'null'
        status:
          type:
            - integer
            - 'null'
          examples:
            - 404
          default: 400
        instance:
          readOnly: true
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem. It may or may not yield further information if
            dereferenced.
          type:
            - string
            - 'null'
        type:
          readOnly: true
          description: A URI reference that identifies the problem type
          type: string
    ConstraintViolation:
      type: object
      description: Unprocessable entity
      properties:
        status:
          default: 422
          type: integer
        violations:
          type: array
          items:
            type: object
            properties:
              propertyPath:
                type: string
                description: The property path of the violation
              message:
                type: string
                description: The message associated with the violation
              code:
                type: string
                description: The code of the violation
              hint:
                type: string
                description: An extra hint to understand the violation
              payload:
                type: object
                additionalProperties: true
                description: The serialized payload of the violation
            required:
              - propertyPath
              - message
        detail:
          readOnly: true
          type: string
        type:
          readOnly: true
          type: string
        title:
          readOnly: true
          type:
            - string
            - 'null'
        instance:
          readOnly: true
          type:
            - string
            - 'null'
    VirtualMachineTask-cloud-server.read:
      type: object
    CloudServerTemplate-cloud-server.read:
      type: object
    IpAddress-cloud-server.read:
      type: object
      properties:
        id:
          readOnly: true
          example: 01F9Z1ZJXZJQZJQVQZJXZJQVQZ
          type: string
        ipAddress:
          example: 127.0.0.1 (IPv4) or 2001:0db8:85a3:0000:0000:8a2e:0370:7334 (IPv6)
          type: string
        ptrRecord:
          description: The reverse DNS PTR record
          example: 1-0-0-127.rev.example.com
          type:
            - string
            - 'null'
    ServiceLevelAgreement-cloud-server.read:
      type: object
    IsoImage-cloud-server.read:
      type: object
    Region-cloud-server.read:
      type: object
  securitySchemes:
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        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.
    ApiToken:
      type: apiKey
      in: header
      name: X-API-TOKEN
      description: >-
        Persönlicher API-Token für Skripte, CI/CD und
        Server-zu-Server-Integrationen, gesendet im Header `X-API-TOKEN:
        <token>`.


        Tokens werden im Kundenpanel unter **Einstellungen → Sicherheit**
        angelegt oder per `POST /user/api-tokens` mit einem gültigen JWT. Der
        Klartext erscheint nur einmal in der Antwort beim Anlegen. Ein Token
        handelt mit den Rechten des Benutzers, der ihn erstellt hat, kann ein
        Ablaufdatum haben und wird mit `DELETE /user/api-tokens/{id}` sofort
        widerrufen.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.