Skip to main content
Documentation

Index API

The Index API controls the search index that powers project and entity lookups in the Diafunc platform. It exposes operations for triggering a full rebuild of the index, either for a single project or for the entire platform. Day-to-day search is consumed through the platform's search endpoints; the Index API is used to recover from index drift, for example after a bulk import, a restored backup, or a schema change.

Base path

All Index API endpoints are served under /api/v1/index.

Authentication

Rebuilding the index of a single project requires edit permission on that project. Rebuilding the full platform index is restricted to administrators.
See Authentication for the shared token and error model.

Capabilities

Project reindex — trigger a rebuild of the search index for a single project. Useful after a bulk import, a large-scale edit, or a schema change that would otherwise require time to propagate.
Full reindex — trigger a rebuild of the search index across all projects. Reserved for administrators and intended for operational recovery scenarios.

Typical workflows

Reindexing after a bulk import — once the Storage API has finished importing, trigger a project reindex to make the imported content immediately discoverable through search.
Operational recovery — after restoring a backup or performing a migration, an administrator triggers a full reindex to rebuild the search index from scratch.

Reference

See also