v41

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011035599.5 KB

Indexing

🛡️ Start an indexing run.

Creates a new Run in the database and starts the indexing operation for that Run. This endpoint can only be used if there is not currently a run running.

The indexing operation will continue to run on the server after this endpoint has returned a response.

<br /><hr /><h3>🛡️ Requires Capabilities: <code>Indexing.Operate</code></h3>

post/api/v1/index/run

Request body

indexMusicboolean required

indexPhotosboolean required

indexMoviesboolean required

indexTVboolean required

type'quick' | 'full' required

Response

runIdstring required

statusstring required

completedAtstring date-time required

typestring required

idnumber required

createdAtstring date-time required

updatedAtstring date-time required

deletedAtstring date-time required