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

# Webspaces auflisten



## OpenAPI

````yaml /api-reference/openapi.json get /webspaces
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:
  /webspaces:
    get:
      tags:
        - Webspaces
      summary: Webspaces auflisten
      operationId: getWebspaces
      parameters:
        - name: page
          in: query
          description: The collection page number
          required: false
          deprecated: false
          schema:
            type: integer
            default: 1
          style: form
          explode: true
        - $ref: '#/components/parameters/CustomerId'
      responses:
        '200':
          description: Webspace collection
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Webspace-webspace.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:
    Webspace-webspace.read:
      type: object
      properties:
        createdAt:
          type: string
          format: date-time
        id:
          readOnly: true
          type: string
        username:
          type: string
        ftpPassword:
          readOnly: true
          description: The password of the ftp account
          type: string
        ftpUsername:
          readOnly: true
          description: The username of the ftp account
          type: string
        pleskHost:
          anyOf:
            - $ref: '#/components/schemas/PleskHost-webspace.read'
            - type: 'null'
        ipAddressV4:
          readOnly: true
          description: The IPv4 address of the webspace
          anyOf:
            - $ref: '#/components/schemas/IpAddress-webspace.read'
            - type: 'null'
        ipAddressV6:
          readOnly: true
          description: The IPv6 address of the webspace
          anyOf:
            - $ref: '#/components/schemas/IpAddress-webspace.read'
            - type: 'null'
        plan:
          $ref: '#/components/schemas/WebspacePlan-webspace.read'
          description: The webspace plan of the webspace
        ftpHost:
          readOnly: true
          example: ftp.example.com
          type: string
    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
    PleskHost-webspace.read:
      type: object
      properties:
        webmailUrl:
          type: string
        pmaUrl:
          type: string
        pgAdminUrl:
          type: string
    IpAddress-webspace.read:
      type: object
      properties:
        ipAddress:
          example: 127.0.0.1 (IPv4) or 2001:0db8:85a3:0000:0000:8a2e:0370:7334 (IPv6)
          type: string
        type:
          type: string
          enum:
            - ipv4
            - ipv6
    WebspacePlan-webspace.read:
      type: object
      properties:
        name:
          description: The name of the webspace plan
          example: Basic
          type: string
        specifications:
          description: The specifications of the webspace plan
          example:
            diskspace_gb: '1'
            traffic_gb: '10'
            domains: '1'
            cronjobs: '1'
            databases: '1'
          type: object
          additionalProperties:
            type: string
        priceInCents:
          description: The price of the webspace plan in cents
          example: 1000
          type: integer
  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.