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

# Analyse einer E-Mail-Security-Domain abrufen

> Wie `GET /email-security/analyze`, aber für eine bereits hinzugefügte Domain: Die Optionen enthalten die konkreten Werte mit deiner Berichtsadresse (`reportAddress`), z. B. den vollständigen DMARC-Eintrag für `manual`.



## OpenAPI

````yaml /api-reference/openapi.json get /email-security/domains/{id}/analysis
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-21-4c0ba7f0
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-Labels
  - 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: Webhooks
  - 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
  - name: DnsZoneTemplate
  - name: DnsZoneTemplateRun
  - name: DnsZoneTemplateSettings
paths:
  /email-security/domains/{id}/analysis:
    get:
      tags:
        - E-Mail-Security
      summary: Analyse einer E-Mail-Security-Domain abrufen
      description: >-
        Wie `GET /email-security/analyze`, aber für eine bereits hinzugefügte
        Domain: Die Optionen enthalten die konkreten Werte mit deiner
        Berichtsadresse (`reportAddress`), z. B. den vollständigen DMARC-Eintrag
        für `manual`.
      operationId: getEmailSecurityDomainAnalysis
      parameters:
        - name: id
          in: path
          description: EmailSecurityAnalysis identifier
          required: true
          deprecated: false
          schema:
            type: string
          style: simple
          explode: false
        - $ref: '#/components/parameters/CustomerId'
      responses:
        '200':
          description: EmailSecurityAnalysis resource
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/EmailSecurityAnalysis-email-security-analysis.read
        '404':
          description: Not found
          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:
    EmailSecurityAnalysis-email-security-analysis.read:
      type: object
      description: >-
        Onboarding-Analyse (ARC-215): Wer betreibt DMARC/SPF/MTA-STS heute,
        liegt die Zone bei uns und

        welche Wege (parallel / verwaltet / manuell) stehen offen? Vertrag mit
        Beispielen:

        docs/api/email-security-onboarding.md.
      properties:
        id:
          description: >-
            ID des E-Mail-Security-Eintrags; null bei der Voranalyse
            (`/email-security/analyze`).
          example: A1B2C3D4E5F6G7H8I9J0
          type:
            - string
            - 'null'
        domain:
          default: ''
          example: durst.shop
          type: string
        checkedAt:
          default: ''
          example: '2026-11-20T10:00:00+00:00'
          type: string
        dns:
          additionalProperties: {}
          type: object
          properties:
            hostedWithUs:
              type: boolean
            zoneId:
              type:
                - string
                - 'null'
            nameservers:
              type: array
              items:
                type: string
            provider:
              type:
                - object
                - 'null'
              properties:
                key:
                  type: string
                  example: suped
                name:
                  type: string
                  example: Suped
              description: >-
                key:
                netzfabrik|dbs|cloudflare|ionos|strato|hetzner|godaddy|other
        dmarc:
          additionalProperties: {}
          type: object
          properties:
            present:
              type: boolean
            source:
              type:
                - string
                - 'null'
              enum:
                - cname
                - txt
            cnameTarget:
              type:
                - string
                - 'null'
            record:
              type:
                - string
                - 'null'
            policy:
              type:
                - string
                - 'null'
              enum:
                - none
                - quarantine
                - reject
            subdomainPolicy:
              type:
                - string
                - 'null'
              enum:
                - none
                - quarantine
                - reject
            pct:
              type:
                - integer
                - 'null'
            rua:
              type: array
              items:
                type: string
            ruf:
              type: array
              items:
                type: string
            provider:
              type:
                - object
                - 'null'
              properties:
                key:
                  type: string
                  example: suped
                name:
                  type: string
                  example: Suped
              description: >-
                key:
                suped|dmarcian|valimail|easydmarc|postmark|cloudflare|google|netzfabrik|other
            ourAddressIncluded:
              type: boolean
            multipleRecords:
              type: boolean
        spf:
          additionalProperties: {}
          type: object
          properties:
            present:
              type: boolean
            record:
              type:
                - string
                - 'null'
            multipleRecords:
              type: boolean
            includes:
              type: array
              items:
                type: string
            senders:
              type: array
              items:
                type:
                  - object
                  - 'null'
                properties:
                  key:
                    type: string
                    example: suped
                  name:
                    type: string
                    example: Suped
            dnsLookupCount:
              type:
                - integer
                - 'null'
            lookupLimitExceeded:
              type: boolean
            allQualifier:
              type:
                - string
                - 'null'
              enum:
                - '~'
                - '-'
                - '?'
                - +
        mtaSts:
          additionalProperties: {}
          type: object
          properties:
            present:
              type: boolean
            provider:
              type:
                - object
                - 'null'
              properties:
                key:
                  type: string
                  example: suped
                name:
                  type: string
                  example: Suped
            policyCnameTarget:
              type:
                - string
                - 'null'
        tlsRpt:
          additionalProperties: {}
          type: object
          properties:
            present:
              type: boolean
            rua:
              type: array
              items:
                type: string
        findings:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                example: dmarc_external_provider
              severity:
                type: string
                enum:
                  - info
                  - warning
                  - critical
              message:
                type: string
        options:
          additionalProperties: {}
          type: object
          properties:
            parallel:
              type: object
              properties:
                available:
                  type: boolean
                how:
                  type:
                    - string
                    - 'null'
                  enum:
                    - provider
                    - zone
                    - manual
                reason:
                  type:
                    - string
                    - 'null'
                instructions:
                  type:
                    - string
                    - 'null'
            managed:
              type: object
              properties:
                available:
                  type: boolean
                reason:
                  type:
                    - string
                    - 'null'
                consequences:
                  type: array
                  items:
                    type: string
            manual:
              type: object
              properties:
                available:
                  type: boolean
                record:
                  type:
                    - object
                    - 'null'
                  properties:
                    type:
                      type: string
                      example: TXT
                    name:
                      type: string
                      example: _dmarc.example.com
                    value:
                      type: string
        reportAddress:
          example: a1b2c3d4e5f60708@dmarc-reports.netzfabrik.eu
          type:
            - string
            - 'null'
    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
  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.