MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

action=immichupload

(main | immichupload)
  • This module requires read rights.
  • This module requires write rights.
  • This module only accepts POST requests.
  • Source: ImmichUpload
  • License: GPL-2.0-or-later

Upload an image from the configured Immich server.

Specific parameters:
Other general parameters are available.
asset

Immich asset ID, or an Immich URL containing it.

This parameter is required.
filename

Destination filename. Defaults to the original filename in Immich. If its extension differs from the Immich file type, the image is converted with ImageMagick.

description

Description wikitext for the generated file page.

license

Licensing wikitext for the generated file page. Defaults to $wgImmichDefaultLicense.

text

Full file page wikitext. Overrides description and license.

comment

Upload summary.

watch

Watch the file page.

Type: boolean (details)
overwrite

Upload as a new version if a file with this name already exists. Other warnings still apply.

Type: boolean (details)
ignorewarnings

Ignore any warnings.

Type: boolean (details)
token

A "csrf" token retrieved from action=query&meta=tokens

This parameter is required.