fess Admin API is a RESTful API for programmatic access to administrative functions.
Overview
Crawl Configuration
- Overview
- Base URL
- Endpoint List
- List Web Crawl Configurations
- Get Web Crawl Configuration
- Create Web Crawl Configuration
- Update Web Crawl Configuration
- Delete Web Crawl Configuration
- URL Pattern Examples
- Usage Examples
- Reference
- Overview
- Base URL
- Endpoint List
- List File Crawl Configurations
- Get File Crawl Configuration
- Create File Crawl Configuration
- Update File Crawl Configuration
- Delete File Crawl Configuration
- Path Formats
- Usage Examples
- Reference
WebConfig API
FileConfig API
DataConfig API
Index Management
- Overview
- Base URL
- Endpoint List
- Delete Documents by Query
- Delete Document by ID
- Query Syntax
- Cautions
- Usage Examples
- Reference
- Overview
- Base URL
- Endpoint List
- List Crawl Information
- Get Crawl Session Details
- Delete Crawl Session
- Usage Examples
- Reference
- Overview
- Base URL
- Endpoint List
- List Failure URLs
- Delete Failure URL
- Delete All Failure URLs
- Error Types
- Usage Examples
- Reference
Documents API
CrawlingInfo API
FailureUrl API
Backup API
Scheduler
User & Permission Management
- Overview
- Base URL
- Endpoint List
- List Users
- Get User
- Create User
- Update User
- Delete User
- Usage Examples
- Reference
- Overview
- Base URL
- Endpoint List
- List Roles
- Get Role
- Create Role
- Update Role
- Delete Role
- Usage Examples
- Reference
- Overview
- Base URL
- Endpoint List
- List Groups
- Get Group
- Create Group
- Update Group
- Delete Group
- Usage Examples
- Reference
User API
Role API
Group API
AccessToken API
Search Tuning
- Overview
- Base URL
- Endpoint List
- List Label Types
- Get Label Type
- Create Label Type
- Update Label Type
- Delete Label Type
- Usage Examples
- Reference
- Overview
- Base URL
- Endpoint List
- List Key Matches
- Get Key Match
- Create Key Match
- Update Key Match
- Delete Key Match
- Usage Examples
- Reference
- Overview
- Base URL
- Endpoint List
- List Document Boosts
- Get Document Boost
- Create Document Boost
- Update Document Boost
- Delete Document Boost
- Boost Expression Examples
- Usage Examples
- Reference
- Overview
- Base URL
- Endpoint List
- List Elevate Words
- Get Elevate Word
- Create Elevate Word
- Update Elevate Word
- Delete Elevate Word
- Usage Examples
- Reference
- Overview
- Base URL
- Endpoint List
- List Bad Words
- Get Bad Word
- Create Bad Word
- Update Bad Word
- Delete Bad Word
- Usage Examples
- Reference
- Overview
- Base URL
- Endpoint List
- List Related Content
- Get Related Content
- Create Related Content
- Update Related Content
- Delete Related Content
- Usage Examples
- Reference
- Overview
- Base URL
- Endpoint List
- List Related Queries
- Get Related Query
- Create Related Query
- Update Related Query
- Delete Related Query
- Usage Examples
- Reference
LabelType API
KeyMatch API
BoostDoc API
ElevateWord API
BadWord API
RelatedContent API
RelatedQuery API
Suggest API
System
- Overview
- Base URL
- Endpoint List
- Get General Settings
- Update General Settings
- Usage Examples
- Reference
- Overview
- Base URL
- Endpoint List
- Get Statistics Information
- Search Query Statistics
- Click Statistics
- Usage Examples
- Reference
- Overview
- Base URL
- Endpoint List
- Get Search Logs
- Get Click Logs
- Get Favorite Logs
- Delete Search Logs
- Usage Examples
- Reference
- Overview
- Base URL
- Endpoint List
- Get Storage Information
- Optimize Index
- Flush Index
- Usage Examples
- Reference
General API
SystemInfo API
Stats API
Log API
Storage API
Plugin API
Dictionary