Sign in
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.

<!-- Leave this line empty -->

<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

Changes

Changed in 12 of the 176 revisions of this API.41315

  • d2689383f1721See the full diff
    • ▲

      the file/items/musicTrack/items/history/items/queueItem/queue/seedMediaType response's property type/format changed from string/ to object/ for status 201

      response-property-type-changed

  • 0c30e5146acd1See the full diff
    • ○

      added the required property completedAt to the response with the 201 status

      response-required-property-added

  • ae7d637d180311See the full diff
    • ●

      added the new generate_waveforms enum value to the file/items/jobTasks/items/job/type response property for the response status 201

      response-property-enum-value-added

    • ○

      removed the generate_waveform enum value from the file/items/jobTasks/items/job/type response property for the response status 201

      response-property-enum-value-removed

  • 5265ec620aa112See the full diff
    • ▲

      the file/items/musicTrack/items/history/items/queueItem/queue/dynamicType response's property type/format changed from string/ to object/ for status 201

      response-property-type-changed

    • ○

      added the optional property file/items/musicTrack/items/history/items/queueItem/queue/seedMediaId to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property file/items/musicTrack/items/history/items/queueItem/queue/seedMediaType to the response with the 201 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 404b6308c09a21See the full diff
    • ●

      added the new generate_track_waveform enum value to the file/items/jobTasks/items/type response property for the response status 201

      response-property-enum-value-added

    • ●

      added the new generate_waveform enum value to the file/items/jobTasks/items/job/type response property for the response status 201

      response-property-enum-value-added

    • ○

      added the optional property file/items/musicTrack/items/waveform to the response with the 201 status

      response-optional-property-added

  • 19d3a24b6d0711See the full diff
    • ▲

      added the new required request property type

      new-required-request-property

    • ○

      added the required property type to the response with the 201 status

      response-required-property-added

  • b2c32b0b84d62See the full diff
    • ○

      added the optional property file/items/musicTrack/items/artists/items/releases/items/releaseType to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property file/items/musicTrack/items/release/releaseType to the response with the 201 status

      response-optional-property-added

  • 71bda9bfce4c1See the full diff
    • ●

      removed the optional property file/items/musicTrack/items/ratings from the response with the 201 status

      response-optional-property-removed

  • 43cbfa2e8b431See the full diff
    • ○

      added the optional property file/items/musicTrack/items/ratings to the response with the 201 status

      response-optional-property-added

  • eaf62ef2fb7741See the full diff
    • ●

      removed the optional property moviesIndexed from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property musicIndexed from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property photosIndexed from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property tvIndexed from the response with the 201 status

      response-optional-property-removed

    • ○

      added the optional property file/items/mtime to the response with the 201 status

      response-optional-property-added