CAcardinalapps
Indexing

🛡️ Start an indexing run.

Changed on

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.

<!-- Leave this line empty -->

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

post/api/v1/index/run

Request

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

Changes

  • d2689383f172Revision changes
    • breaking

      the //////// response's property type changed from string to object for status

  • 2a174f35c7d2Revision changes
    • breaking

      the //////// response's property type changed from object to string for status