Fess Admin API is a RESTful API for programmatic access to administrative functions.
Overview
Admin API Overview
Crawl Configuration
WebConfig API
- 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
FileConfig API
- 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
DataConfig API
Index Management
Documents API
CrawlingInfo API
- Overview
- Base URL
- Endpoint List
- List Crawl Information
- Get Crawl Information
- Delete Crawl Information
- Bulk Delete Crawl Sessions
- Usage Examples
- Reference
FailureUrl API
- Overview
- Base URL
- Endpoint List
- List Failure URLs
- Get Failure URL
- Delete Failure URL
- Delete All Failure URLs
- Error Types
- Usage Examples
- Reference
Backup API
Scheduler
Scheduler API
- Overview
- Base URL
- Endpoint List
- List Scheduled Jobs
- Get Scheduled Job
- Create Scheduled Job
- Update Scheduled Job
- Delete Scheduled Job
- Start Job
- Stop Job
- Usage Examples
- Reference
JobLog API
User & Permission Management
User API
- Overview
- Base URL
- Endpoint List
- List Users
- Get User
- Create User
- Update User
- Delete User
- Usage Examples
- Reference
Role API
- Overview
- Base URL
- Endpoint List
- List Roles
- Get Role
- Create Role
- Update Role
- Delete Role
- Usage Examples
- Reference
Group API
- Overview
- Base URL
- Endpoint List
- List Groups
- Get Group
- Create Group
- Update Group
- Delete Group
- Usage Examples
- Reference
AccessToken API
Search Tuning
LabelType API
- Overview
- Base URL
- Endpoint List
- List Label Types
- Get Label Type
- Create Label Type
- Update Label Type
- Delete Label Type
- Usage Examples
- See Also
TagType API
- Overview
- Base URL
- Endpoint List
- List Tags
- Get a Tag
- Create a Tag
- Update a Tag
- Delete a Tag
- How Changes Reach Documents
- Usage Examples
- See Also
KeyMatch API
- Overview
- Base URL
- Endpoint List
- List Key Matches
- Get Key Match
- Create Key Match
- Update Key Match
- Delete Key Match
- Usage Examples
- Reference
BoostDoc API
- Overview
- Base URL
- Authentication
- Endpoint List
- List Document Boosts
- Get Document Boost
- Create Document Boost
- Update Document Boost
- Delete Document Boost
- Condition and Boost Expressions
- Usage Examples
- Reference
Elevateword API
- Overview
- Base URL
- Endpoint List
- List Elevate words
- Get Elevate word
- Create Elevate word
- Update Elevate word
- Delete Elevate word
- Upload Elevate word CSV
- Download Elevate word CSV
- Usage Examples
- Reference
Badword API
- Overview
- Base URL
- Endpoint List
- List Bad words
- Get Bad word
- Create Bad word
- Update Bad word
- Delete Bad word
- Upload Bad word CSV
- Download Bad word CSV
- Usage Examples
- Reference
RelatedContent API
- Overview
- Base URL
- Endpoint List
- List Related Content
- Get Related Content
- Create Related Content
- Update Related Content
- Delete Related Content
- Usage Examples
- Reference
RelatedQuery API
- Overview
- Base URL
- Endpoint List
- List Related Queries
- Get Related Query
- Create Related Query
- Update Related Query
- Delete Related Query
- Error Response
- Usage Examples
- Reference
Admin Suggest API
System
General API
SystemInfo API
Stats API
Log API
- Overview
- Base URL
- Authentication
- Endpoint List
- Retrieve Log File List
- Download Log File
- Usage Examples
- Reference
SearchList API
- Overview
- Base URL
- Authentication
- Endpoint List
- Search Documents
- Get Document
- Create Document
- Update Document
- Delete Document (by ID)
- Delete Documents (by query)
- Status Codes
- Usage Examples
- Reference
Storage API
- Overview
- Base URL
- Authentication
- Endpoint List
- List Files and Directories
- Download a File
- Delete a File
- Upload a File
- Errors
- Usage Examples
- Reference