API Endpoint Documentation
The API has two ways of authentication using Cookie Authentication via the /api/account/login endpoint and Basic Authentication
This document is auto generated
| Path | Type | Description |
|---|---|---|
| /api/account/status | GET | Check the account status of the current logged-in user |
| /account/login | GET | Login form page (HTML) |
| /api/account/login | POST | Login the current HttpContext in |
| /api/account/logout | POST | Logout the current HttpContext out |
| /account/logout | GET | Logout the current HttpContext and redirect to login |
| /api/account/change-secret | POST | Update password for current user |
| /api/account/register | POST | Create a new user (you need a AF-token first) |
| /api/account/register/status | GET | Is the register form open |
| /api/account/permissions | GET | List of current permissions |
| /api/allowed-types/mimetype/sync | GET | A (string) list of allowed MIME-types ExtensionSyncSupportedList |
| /api/allowed-types/mimetype/thumb | GET | A (string) list of allowed ExtensionThumbSupportedList MimeTypes |
| /api/allowed-types/thumb | GET | Check if IsExtensionThumbnailSupported |
| /api/env | GET | Show the runtime settings (dont allow AllowAnonymous) |
| /api/env | POST | Show the runtime settings (dont allow AllowAnonymous) |
| _Parameters: Verbose, StorageFolder, UseSystemTrash, UseLocalDesktop, DefaultDesktopEditor, DesktopCollectionsOpen _ | ||
| /api/env/features | GET | Show features that used in the frontend app / menu |
| /api/cache/list | GET | Get Database Cache (only the cache) |
| /api/remove-cache | GET | Delete Database Cache (only the cache) |
| /api/remove-cache | POST | Delete Database Cache (only the cache) |
| /api/delete | DELETE | Remove files from the disk, but the file must contain the !delete!(TrashKeywo... |
| _Parameters: f (subPaths, separated by dot comma), collections (true is to update files with the same name before _ | ||
| _ the extenstion) _ | ||
| /api/desktop-editor/open | POST | Open a file in the default editor or a specific editor on the desktop |
| _Parameters: f (single or multiple subPaths), collections (to combine files with the same name before the extension) _ | ||
| /api/desktop-editor/amount-confirmation | POST | Check the amount of files to open before |
| /api/disk/mkdir | POST | Make a directory (-p) |
| /api/disk/rename | POST | Rename file/folder and update it in the database |
| _Parameters: f (from subPath), to (to subPath), collections (is collections bool), currentStatus (default is to not _ | ||
| _ included files that are removed in result) _ | ||
| /api/download-sidecar | GET | Download sidecar file for example image.xmp |
| /api/download-photo | GET | Select manually the original or thumbnail |
| _Parameters: f (string, 'sub path' to find the file), isThumbnail (true = 1000px thumb (if supported)), cache (true _ | ||
| _ = send client headers to cache) _ | ||
| /error | GET | Return Error page (HTML) |
| /api/export/create-zip | POST | Export source files to an zip archive |
| _Parameters: f (subPath to files), collections (enable files with the same name (before the extension)), thumbnail _ | ||
| _ (export thumbnails) _ | ||
| /api/export/zip/{f}.zip | GET | Get the exported zip, but first call 'createZip'use for example this url: /ex... |
| /api/geo/status | GET | Get Geo sync status |
| /api/geo/sync | POST | Reverse lookup for Geo Information and/or add Geo location based on a GPX fil... |
| /api/geo-reverse-lookup | GET | Reverse geo lookup |
| /api/health | GET | Check if the service has any known errors and return only a stringPublic API |
| /api/health/details | GET | Check if the service has any known errorsFor Authorized Users only |
| /api/health/version | POST | Check if Client/App version has a match with the API-versionthe parameter 've... |
| /api/health/check-for-updates | GET | Check if Client/App version has a match with the API-version |
| /api/health/release-info | GET | Get more info to show about the release |
| /search | POST | Redirect to search GET page (HTML) |
| /search | GET | Search GET page (HTML) |
| /trash | GET | Trash page (HTML) |
| /import | GET | Import page (HTML) |
| /preferences | GET | Preferences page (HTML) |
| /account/register | GET | View the Register form (HTML) |
| /api/import | POST | Import a file using the structure format |
| /api/import/fromUrl | POST | Import file from web-url (only whitelisted domains) and import this file into... |
| _Parameters: fileUrl (the url), filename (the filename (optional, random used if empty)), structure (use structure _ | ||
| _ (optional)) _ | ||
| /api/import/history | GET | Today's imported files |
| /api/import/thumbnail | POST | Upload thumbnail to ThumbnailTempFolderMake sure that the filename is correct... |
| /api/index | GET | The database-view of a directory |
| _Parameters: f (subPath), colorClass (filter on colorClass (use int)), collections (to combine files with the same _ | ||
| _ name before the extension), hideDelete (ignore deleted files), sort (how to orderBy, defaults to fileName) _ | ||
| /api/memory-cache-debug | GET | View data from the memory cache - use to debug |
| /api/info | GET | Get realtime (cached a few minutes) about the file |
| _Parameters: f (subPaths split by dot comma), collections (true is to update files with the same name before the _ | ||
| _ extenstion) _ | ||
| /api/replace | POST | Search and Replace text in meta information |
| _Parameters: f (subPath filepath to file, split by dot comma (;)), fieldName (name of fileIndexItem field e.g. Tags), _ | ||
| _ search (text to search for), replace (replace [search] with this text), collections (enable collections) _ | ||
| /api/update | POST | Update Exif and Rotation API |
| _Parameters: Id, FilePath, FileName, FileHash, FileCollectionName, ParentDirectory, IsDirectory, Tags, Status, Description, _ | ||
| _Title, DateTime, AddToDatabase, LastEdited, Latitude, Longitude, LocationAltitude, LocationCity, LocationState, _ | ||
| _LocationCountry, LocationCountryCode, ColorClass, Orientation, ImageWidth, ImageHeight, ImageFormat, CollectionPaths, _ | ||
| _SidecarExtensions, SidecarExtensionsList, Aperture, ShutterSpeed, IsoSpeed, Software, MakeModel, Make, Model, LensModel, _ | ||
| _FocalLength, Size, ImageStabilisation, LastChanged, f (subPath filepath to file, split by dot comma (;)), append _ | ||
| _(only for stings, add update to existing items), collections (StackCollections bool, default true), rotateClock _ | ||
| _ (relative orientation -1 or 1) _ | ||
| /api/notification/notification | GET | Get recent notificationsUse dateTime 2022-04-16T17:33:10.323974Z to get the l... |
| /api/publish | GET | Get all publish profilesTo see the entire config check appSettings |
| /api/publish/create | POST | Publish |
| _Parameters: f (subPath filepath to file, split by dot comma (;)), itemName (itemName), publishProfileName (publishProfileName), _ | ||
| _ force _ | ||
| /api/publish/exist | GET | To give the user UI feedback when submitting the itemNameTrue is not to conti... |
| /redirect/sub-path-relative | GET | Redirect or view path to relative paths using the structure-config (see /api/... |
| /api/search | GET | Gets the list of search results (cached) |
| /api/search/relative-objects | GET | Get relative paths in a search queryDoes not cover multiple pages (so it ends... |
| /api/search/trash | GET | List of files with the tag: !delete! (TrashKeyword.TrashKeywordString)Caching... |
| /api/search/remove-cache | POST | Clear search cache to show the correct results |
| /api/suggest | GET | Gets the list of search results (cached) |
| /api/suggest/all | GET | Show all items in the search suggest cache |
| /api/suggest/inflate | GET | To fill the cache with the data (only if cache is not already filled) |
| /api/synchronize | POST | Faster API to Check if directory is changed (not recursive) |
| /api/synchronize | GET | Faster API to Check if directory is changed (not recursive) |
| /api/thumbnail/small/{f} | GET | Get thumbnail for index pages (300 px or 150px or 1000px (based on what's the... |
| /api/thumbnail/list-sizes/{f} | GET | Get overview of what exists by name |
| /api/thumbnail/{f} | GET | Get thumbnail with fallback to original source image.Return source image when... |
| _Parameters: f (one single fileHash (NOT path)), filePath (fallback FilePath), isSingleItem (true = load original), _ | ||
| _ json (text as output), extraLarge (give preference to extraLarge over large image) _ | ||
| /api/thumbnail/zoom/{f}@{z} | GET | Get zoomed in image by fileHash.At the moment this is the source image |
| /api/thumbnail-generation | POST | Create thumbnails for a folder in the background |
| /api/trash/move-to-trash | POST | Move a file to the trash |
| /api/trash/detect-to-use-system-trash | GET | Is the system trash supportedUsed in End2End tests to enable or disable the t... |
| /api/upload | POST | Upload to specific folder (does not check if already has been imported)Use th... |
| /api/upload-sidecar | POST | Upload sidecar file to specific folder (does not check if already has been im... |