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

# API-Token erstellen

> Erstellt einen persönlichen API-Token für Skripte und Server-Integrationen. Der Klartext steht nur in dieser Antwort im Feld `token`; speichere ihn sicher. Anschließend authentifizierst du Anfragen mit dem Header `X-API-TOKEN: <token>`.

Ohne `expiresAt` läuft der Token nicht ab. Er handelt mit den Rechten des Benutzers, der ihn erstellt. Ist für den Benutzer ein zweiter Faktor aktiv, muss er zuvor mit `POST /auth/2fa/step-up` bestätigt werden, sonst antwortet der Endpunkt mit `403 mfa_step_up_required`.

Tokens lassen sich auch im Kundenpanel unter **Einstellungen → Sicherheit** anlegen.



## OpenAPI

````yaml /api-reference/openapi.json post /user/api-tokens
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:
  /user/api-tokens:
    post:
      tags:
        - Benutzer
      summary: API-Token erstellen
      description: >-
        Erstellt einen persönlichen API-Token für Skripte und
        Server-Integrationen. Der Klartext steht nur in dieser Antwort im Feld
        `token`; speichere ihn sicher. Anschließend authentifizierst du Anfragen
        mit dem Header `X-API-TOKEN: <token>`.


        Ohne `expiresAt` läuft der Token nicht ab. Er handelt mit den Rechten
        des Benutzers, der ihn erstellt. Ist für den Benutzer ein zweiter Faktor
        aktiv, muss er zuvor mit `POST /auth/2fa/step-up` bestätigt werden,
        sonst antwortet der Endpunkt mit `403 mfa_step_up_required`.


        Tokens lassen sich auch im Kundenpanel unter **Einstellungen →
        Sicherheit** anlegen.
      operationId: createApiToken
      parameters:
        - $ref: '#/components/parameters/CustomerId'
      requestBody:
        description: The new ApiToken resource
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiToken.CreateApiTokenRequest'
            example:
              description: Deploy-Pipeline
              expiresAt: '2027-12-31T23:59:59+00:00'
        required: true
      responses:
        '201':
          description: ApiToken resource created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiToken.ApiTokenCreatedResponse'
          links: {}
        '400':
          description: Invalid input
          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:
    ApiToken.CreateApiTokenRequest:
      type: object
      properties:
        description:
          minLength: 3
          maxLength: 255
          description: Description of the API token
          example: My API token
          type:
            - string
            - 'null'
        expiresAt:
          description: >-
            Date and time when the API token expires (at most 365 days in the
            future). If null, the token never expires.
          example: '2021-01-01T00:00:00+00:00'
          type:
            - string
            - 'null'
          format: date-time
        scope:
          description: >-
            Scope of the token: "read" allows only GET/HEAD/OPTIONS, "write"
            additionally allows modifying requests. Defaults to "read".
          example: read
          type: string
          enum:
            - read
            - write
    ApiToken.ApiTokenCreatedResponse:
      type: object
      properties:
        id:
          example: A1B2C3D4E5F6G7H8I9J0
          type: string
        token:
          description: >-
            The secret. Shown only once; store it securely. Send it in the
            X-API-TOKEN header.
          example: api_1a2b3c4d…
          type: string
        tokenPrefix:
          description: First characters of the secret, shown in token lists.
          example: api_1a2b3c4d
          type: string
        scope:
          description: 'Scope of the token: read or write.'
          example: read
          type: string
        customerId:
          description: Customer the token is bound to.
          type: string
        customerName:
          example: Acme GmbH
          type: string
        description:
          example: My API token
          type:
            - string
            - 'null'
        expiresAt:
          example: '2021-01-01T00:00:00+00:00'
          type:
            - string
            - 'null'
          format: date-time
    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'
  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.