Skip to main content

UpdatePluginRequest

Request to update a plugin

argsstring[]nullable

Updated command arguments

autoMatchConditions

Auto-match conditions (JSON object with mode and rules)

commandstring | nullnullable

Updated command

config

Updated configuration

credentialDeliverystring | nullnullable

Updated credential delivery method

credentials

Updated credentials (set to null to clear)

descriptionstring | nullnullable

Updated description

displayNamestring | nullnullable

Updated display name

Example: MangaBaka v2
env object[]

Updated environment variables

  • Array [
  • keystringrequired
    valuestringrequired
  • ]
  • internalConfig

    Internal server-side configuration (not sent to plugin) Validated as InternalPluginConfig on the server

    libraryIdsstring<uuid>[]nullable

    Updated library IDs (empty = all libraries)

    metadataTargets

    Metadata targets: which resource types this plugin auto-matches against null = clear to auto-detect from plugin capabilities

    permissionsstring[]nullable

    Updated permissions

    rateLimitRequestsPerMinuteinteger,null<int32>nullable

    Updated rate limit in requests per minute (Some(None) = remove limit)

    Example: 60
    scopesstring[]nullable

    Updated scopes

    searchPreprocessingRules

    Preprocessing rules for search queries (JSON array of regex rules)

    searchQueryTemplate

    Handlebars template for customizing search queries (null = clear template)

    useExistingExternalIdboolean | nullnullable

    Whether to skip search when external ID exists for this plugin

    workingDirectorystring | nullnullable

    Updated working directory

    UpdatePluginRequest
    {
    "args": "Unknown Type: array,null",
    "command": "string",
    "credentialDelivery": "string",
    "description": "string",
    "displayName": "MangaBaka v2",
    "env": "Unknown Type: array,null",
    "libraryIds": "Unknown Type: array,null",
    "permissions": "Unknown Type: array,null",
    "rateLimitRequestsPerMinute": 60,
    "scopes": "Unknown Type: array,null",
    "useExistingExternalId": true,
    "workingDirectory": "string"
    }