Admin API Referenz

Fess Admin API ist eine RESTful API für den programmatischen Zugriff auf Verwaltungsfunktionen.

Übersicht

Admin API Übersicht

• Übersicht
• Basis-URL
• Authentifizierung
• Gemeinsame Muster
• Response-Format
• Verfügbare APIs
• Verwendungsbeispiele
• Referenzinformationen

Crawl-Konfiguration

WebConfig API

• Übersicht
• Basis-URL
• Endpunktliste
• Web-Crawl-Konfigurationsliste abrufen
• Web-Crawl-Konfiguration abrufen
• Web-Crawl-Konfiguration erstellen
• Web-Crawl-Konfiguration aktualisieren
• Web-Crawl-Konfiguration löschen
• URL-Muster-Beispiele
• Verwendungsbeispiele
• Referenzinformationen

FileConfig API

• Übersicht
• Basis-URL
• Endpunktliste
• Datei-Crawl-Konfigurationsliste abrufen
• Datei-Crawl-Konfiguration abrufen
• Datei-Crawl-Konfiguration erstellen
• Datei-Crawl-Konfiguration aktualisieren
• Datei-Crawl-Konfiguration löschen
• Pfadformate
• Verwendungsbeispiele
• Referenzinformationen

DataConfig API

• Übersicht
• Basis-URL
• Endpunktliste
• Datenspeicher-Konfigurationsliste abrufen
• Datenspeicher-Konfiguration abrufen
• Datenspeicher-Konfiguration erstellen
• Datenspeicher-Konfiguration aktualisieren
• Datenspeicher-Konfiguration löschen
• Handler-Typen
• Verwendungsbeispiele
• Referenzinformationen

Index-Verwaltung

Documents API

• Übersicht
• Basis-URL
• Endpunktliste
• Dokumente per Query löschen
• Dokument per ID löschen
• Query-Syntax
• Hinweise
• Verwendungsbeispiele
• Referenzinformationen

CrawlingInfo API

• Übersicht
• Basis-URL
• Endpunktliste
• Crawl-Informationsliste abrufen
• Crawl-Sitzungsdetails abrufen
• Crawl-Sitzung löschen
• Verwendungsbeispiele
• Referenzinformationen

FailureUrl API

• Übersicht
• Basis-URL
• Endpunktliste
• Liste der fehlgeschlagenen URLs abrufen
• Fehlgeschlagene URL löschen
• Alle fehlgeschlagenen URLs löschen
• Fehlertypen
• Verwendungsbeispiele
• Referenzinformationen

Backup API

• Übersicht
• Basis-URL
• Endpunktliste
• Konfigurationsdaten exportieren
• Konfigurationsdaten importieren
• Verwendungsbeispiele
• Hinweise
• Referenzinformationen

Scheduler

Scheduler API

• Übersicht
• Basis-URL
• Endpunktliste
• Geplante Jobs auflisten
• Geplanten Job abrufen
• Geplanten Job erstellen
• Geplanten Job aktualisieren
• Geplanten Job löschen
• Job starten
• Job stoppen
• Verwendungsbeispiele
• Referenzinformationen

JobLog API

• Übersicht
• Basis-URL
• Endpunktliste
• Job-Protokollliste abrufen
• Job-Protokolldetails abrufen
• Job-Protokoll löschen
• Alle Job-Protokolle löschen
• Verwendungsbeispiele
• Referenzinformationen

Benutzer- und Rechteverwaltung

User API

• Übersicht
• Basis-URL
• Endpunktliste
• Benutzerliste abrufen
• Benutzer abrufen
• Benutzer erstellen
• Benutzer aktualisieren
• Benutzer löschen
• Verwendungsbeispiele
• Referenzinformationen

Role API

• Übersicht
• Basis-URL
• Endpunktliste
• Rollenliste abrufen
• Rolle abrufen
• Rolle erstellen
• Rolle aktualisieren
• Rolle löschen
• Verwendungsbeispiele
• Referenzinformationen

Group API

• Übersicht
• Basis-URL
• Endpunktliste
• Gruppenliste abrufen
• Gruppe abrufen
• Gruppe erstellen
• Gruppe aktualisieren
• Gruppe löschen
• Verwendungsbeispiele
• Referenzinformationen

AccessToken API

• Übersicht
• Basis-URL
• Endpunktliste
• Access Token Liste abrufen
• Access Token abrufen
• Access Token erstellen
• Access Token aktualisieren
• Access Token löschen
• Verwendungsbeispiele
• Referenzinformationen

Such-Tuning

LabelType API

• Übersicht
• Basis-URL
• Endpunktliste
• Label-Typ-Liste abrufen
• Label-Typ erstellen
• Verwendungsbeispiele
• Referenzinformationen

KeyMatch API

• Übersicht
• Basis-URL
• Endpunktliste
• KeyMatch-Liste abrufen
• KeyMatch erstellen
• Verwendungsbeispiele
• Referenzinformationen

BoostDoc API

• Übersicht
• Basis-URL
• Endpunktliste
• Boost-Dokument erstellen
• Verwendungsbeispiele
• Referenzinformationen

ElevateWord API

• Übersicht
• Basis-URL
• Endpunktliste
• Elevate Word erstellen
• Verwendungsbeispiele
• Referenzinformationen

BadWord API

• Übersicht
• Basis-URL
• Endpunktliste
• Bad Word erstellen
• Verwendungsbeispiele
• Referenzinformationen

RelatedContent API

• Übersicht
• Basis-URL
• Endpunktliste
• Verwandten Inhalt erstellen
• Verwendungsbeispiele
• Referenzinformationen

RelatedQuery API

• Übersicht
• Basis-URL
• Endpunktliste
• Verwandte Abfrage erstellen
• Verwendungsbeispiele
• Referenzinformationen

Suggest API

• Übersicht
• Basis-URL
• Endpunktliste
• Suggest-Status abrufen
• Suggest-Index neu erstellen
• Verwendungsbeispiele
• Referenzinformationen

System

General API

• Übersicht
• Basis-URL
• Endpunktliste
• Allgemeine Einstellungen abrufen
• Allgemeine Einstellungen aktualisieren
• Verwendungsbeispiele
• Referenzinformationen

SystemInfo API

• Übersicht
• Basis-URL
• Endpunktliste
• Systeminformationen abrufen
• Verwendungsbeispiele
• Referenzinformationen

Stats API

• Übersicht
• Basis-URL
• Endpunktliste
• Statistiken abrufen
• Verwendungsbeispiele
• Referenzinformationen

Log API

• Übersicht
• Basis-URL
• Endpunktliste
• Protokolldateien auflisten
• Protokolldatei-Inhalt abrufen
• Verwendungsbeispiele
• Referenzinformationen

Storage API

• Übersicht
• Basis-URL
• Endpunktliste
• Speicherinhalt auflisten
• Datei hochladen
• Verwendungsbeispiele
• Referenzinformationen

Plugin API

• Übersicht
• Basis-URL
• Endpunktliste
• Installierte Plugins auflisten
• Verfügbare Plugins auflisten
• Plugin installieren
• Plugin deinstallieren
• Verwendungsbeispiele
• Referenzinformationen

Wörterbuch

Dict API

• Übersicht
• Basis-URL
• Endpunktliste
• Wörterbücher auflisten
• Wörterbucheinträge auflisten
• Wörterbucheintrag erstellen
• Verwendungsbeispiele
• Referenzinformationen

Protokolle

SearchLog API

• Übersicht
• Basis-URL
• Endpunktliste
• Suchprotokolle auflisten
• Suchstatistiken abrufen
• Suchprotokolle löschen
• Verwendungsbeispiele
• Referenzinformationen