Sign in
Maintenance (admin)

Set maintenance mode

Put Immich into or take it out of maintenance mode

post/admin/maintenance

Request

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

Request body

action'start' | 'end' | 'select_database_restore' | 'restore_database' required

Maintenance action

restoreBackupFilenamestring

Restore backup filename

Changes

No recorded changes to this operation across all 50 revisions of this API.