Sign in
Plugins

List all plugins

Changed on

Retrieve a list of plugins available to the authenticated user.

get/plugins

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/plugins
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Query parameters

descriptionstring
enabledboolean

Whether the plugin is enabled

idstring uuid

Plugin ID

namestring
titlestring
versionstring

Response

authorstring required

Plugin author

createdAtstring required

Creation date

descriptionstring required

Plugin description

idstring uuid required

Plugin ID

namestring required

Plugin name

titlestring required

Plugin title

updatedAtstring required

Last update date

versionstring required

Plugin version

Changes

  • 2cd7bd44a940Revision changes
    • info

      the / response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status

  • f5e391d20316Revision changes
    • info

      removed the AssetPersonV1 enum value from the //// response property for the response status