immich_server
Retrieves Immich server information, configuration, features, statistics, storage, media types, version, and license status; can set or delete the product key with confirm-gated writes.
Instructions
immich_server covers the server toolset (16 operations). Auth header x-api-key. Writes need confirm:true and IMMICH_ALLOW_WRITES=true. Omit confirm for a dry-run preview. Actions: delete_server_license: DELETE /server/license. Delete server product key get_about_info: GET /server/about. Get server information get_apk_links: GET /server/apk-links. Get APK links get_public_config: GET /public/config. Get the public configuration get_public_config_defaults: GET /public/config/defaults. Get the public configuration defaults get_server_config: GET /server/config. Get config get_server_features: GET /server/features. Get features get_server_license: GET /server/license. Get product key get_server_statistics: GET /server/statistics. Get statistics get_server_version: GET /server/version. Get server version get_storage: GET /server/storage. Get storage get_supported_media_types: GET /server/media-types. Get supported media types get_version_check: GET /server/version-check. Get version check status get_version_history: GET /server/version-history. Get version history ping_server: GET /server/ping. Ping set_server_license: PUT /server/license. Set server product key
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"action": "<action>"
},
"name": "immich_server"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | JSON body for the Immich operation. Secrets are redacted in output. | |
| query | No | OpenAPI query parameters. | |
| action | Yes | Immich operation to call. | |
| params | No | OpenAPI path parameters, such as id. | |
| confirm | No | Set to the boolean true to execute the write. Omit this field for a dry-run preview. false and the string true are rejected. | |
| checksum | No | Optional x-immich-checksum header for asset upload. | |
| file_path | No | Local file to upload as multipart assetData. Confirm-gated. The path is omitted from output. | |
| save_path | No | Local path to save a binary download. If omitted, only metadata is returned. The path is omitted from output. | |
| sidecar_path | No | Optional local XMP sidecar for asset upload. The path is omitted from output. |