REST API
API endpoints, see API reference for general API-guidance. Full OpenAPI spec is available at /openapi.yaml.
API keys
Creates, lists, and revokes the API keys of the deployment.
Documents
Reads, creates, updates, and deletes documents in an index.
- GETRead documents
/v1alpha1/indexes/{name}/documents - POSTIndex documents
/v1alpha1/indexes/{name}/documents - POSTDelete documents by keys, query, or all
/v1alpha1/indexes/{name}/documents/actions/delete - POSTUpdate fields of existing documents
/v1alpha1/indexes/{name}/documents/actions/update - GETRead a document by key
/v1alpha1/indexes/{name}/documents/{key} - PUTIndex a document under a key
/v1alpha1/indexes/{name}/documents/{key} - PATCHUpdate fields of one document
/v1alpha1/indexes/{name}/documents/{key} - DELETEDelete a document by key
/v1alpha1/indexes/{name}/documents/{key}
Indexers
Which node writes which index.
Indexes
Defines, reads, and deletes indexes and their generations.
- GETList indexes
/v1alpha1/admin/indexes - PUTCreate or replace an index definition
/v1alpha1/admin/indexes/{name} - GETGet an index
/v1alpha1/admin/indexes/{name} - DELETEDelete an index or a generation
/v1alpha1/admin/indexes/{name} - POSTCommit pending changes
/v1alpha1/admin/indexes/{name}/actions/commit - POSTPromote a generation
/v1alpha1/admin/indexes/{name}/actions/promote - POSTPull the latest state
/v1alpha1/admin/indexes/{name}/actions/pull
Registry
Compares the index registry with what storage holds, and repairs it.
Reindexes
Populates a new generation by copying documents from an existing generation inside the engine.
Search
Finds documents in an index.
Search settings
Per-index search configuration, managed separately from index definitions.
Types
- AnalyzerDefinition
- AndClause
- BoostClause
- Clause
- CreatedKey
- DocumentFailure
- ErrorDetail
- ErrorResponse
- ExplainDetail
- FacetOrder
- FacetUsage
- FacetValue
- FieldDefinition
- FieldSettings
- FilterUsage
- Freshness
- FuseClause
- FuseRanking
- GenerationSummary
- IndexDefinition
- IndexInfo
- Interpret
- Interpreted
- InterpretMode
- InterpretTarget
- InterpretTargets
- Join
- KeyInfo
- KnnClause
- Locales
- Match
- Matcher
- NestedClause
- NotClause
- ObjectFieldDefinition
- OrClause
- Prefix
- QuerySynonyms
- Ranking
- ReindexInfo
- Relax
- Relaxed
- Role
- Rule
- SearchRequest
- SearchSettingsInfo
- Signal
- SignalUsage
- Sort
- SortOrder
- SortUsage
- TextClause
- TypoExclusions
- TyposMode
Exofind is built by Level Four AB and is available under the Apache License 2.0.