> ## 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 auflisten



## OpenAPI

````yaml /api-reference/openapi.json get /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:
    get:
      tags:
        - Cloud-Server
      summary: Cloud-Server auflisten
      operationId: getServers
      parameters:
        - name: page
          in: query
          description: The collection page number
          required: false
          deprecated: false
          schema:
            type: integer
            default: 1
          style: form
          explode: true
        - name: exists[application]
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: boolean
          style: form
          explode: false
        - name: exists[serviceLevelAgreement]
          in: query
          description: ''
          required: false
          deprecated: false
          schema:
            type: boolean
          style: form
          explode: false
        - $ref: '#/components/parameters/CustomerId'
      responses:
        '200':
          description: VirtualMachine collection
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/VirtualMachine-cloud-server.list_region.read_timestampable.created_at.read_timestampable.updated_at.read_cloud-server-template.read
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          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-cloud-server.list_region.read_timestampable.created_at.read_timestampable.updated_at.read_cloud-server-template.read:
      type: object
      properties:
        id:
          readOnly: true
          example: 01F9Z3ZJXZQZJZJZJZJZJZJZJZ
          type: string
        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.list_region.read_timestampable.created_at.read_timestampable.updated_at.read_cloud-server-template.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.list_region.read_timestampable.created_at.read_timestampable.updated_at.read_cloud-server-template.read
            - type: 'null'
        ipV6:
          anyOf:
            - $ref: >-
                #/components/schemas/IpAddress-cloud-server.list_region.read_timestampable.created_at.read_timestampable.updated_at.read_cloud-server-template.read
            - type: 'null'
        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'
        image:
          readOnly: true
          description: Das Image, aus dem der Server aufgesetzt wurde.
          anyOf:
            - $ref: >-
                #/components/schemas/IsoImage-cloud-server.list_region.read_timestampable.created_at.read_timestampable.updated_at.read_cloud-server-template.read
            - type: 'null'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        region:
          $ref: >-
            #/components/schemas/Region-cloud-server.list_region.read_timestampable.created_at.read_timestampable.updated_at.read_cloud-server-template.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
    CloudServerTemplate-cloud-server.list_region.read_timestampable.created_at.read_timestampable.updated_at.read_cloud-server-template.read:
      type: object
      properties:
        id:
          readOnly: true
          type: string
        name:
          readOnly: true
          type: string
        cpuName:
          readOnly: true
          type: string
        cpuArchitecture:
          readOnly: true
          type: string
        cpuGhz:
          readOnly: true
          description: >-
            In der Datenbank steht `cpu_ghz` als `varchar` — deshalb ist die
            Spalte hier `string`

            abgebildet und die Eigenschaft ebenfalls `string`. Nach aussen
            (Konstruktor, Getter,

            API-Feld `cpuGhz`) bleibt es eine Fliesskommazahl; die Umwandlung
            liegt an genau

            zwei Stellen. Vorher war die Eigenschaft `float` bei Spaltentyp
            `string` — ORM 2.20

            meldet genau diese Unstimmigkeit in `doctrine:schema:validate`
            (ARC-132).
          type: string
        cpuCores:
          readOnly: true
          type: integer
        ramMb:
          readOnly: true
          type: integer
        diskGb:
          readOnly: true
          type: integer
        bandwidthGb:
          readOnly: true
          type: integer
        isAvailable:
          readOnly: true
          type: boolean
        priceNetCents:
          readOnly: true
          type: integer
        pricePerHourNetCents:
          readOnly: true
          default: 0
          type: integer
    IpAddress-cloud-server.list_region.read_timestampable.created_at.read_timestampable.updated_at.read_cloud-server-template.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'
    IsoImage-cloud-server.list_region.read_timestampable.created_at.read_timestampable.updated_at.read_cloud-server-template.read:
      type: object
    Region-cloud-server.list_region.read_timestampable.created_at.read_timestampable.updated_at.read_cloud-server-template.read:
      type: object
      properties:
        code:
          description: The region code, e.g. FRA1
          example: FRA1
          type: string
        name:
          description: The region name, e.g. Frankfurt 1
          example: Frankfurt 1
          type: string
        flags:
          description: A list of flags, e.g. compliance, power that apply to this region.
          example:
            - ISO 27001
            - PCI DSS
            - Power Feed A/B
          type: array
          items:
            type:
              - string
              - 'null'
  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.