Mutations

abandonLocationOperation

Type: AbandonLocationOperationPayload!

Give up on an operation nobody is running: mark it failed, close its Activity run, and release the titles and roots it owns.

Nothing on disk is touched. Finished titles stay where the operation put them, and the operation can be retried from its last verified checkpoint once the storage is back. An operation whose runner is still alive is refused; cancel it instead.

Arguments

Name	Description
id ID!	Location-operation identity to mark failed and release.

accountSecurityPasskeyComplete

Type: LoginPayload!

Completes a passkey reauthentication assertion and returns a fresh account-security session.

Arguments

Name	Description
input WebauthnCompleteInput!	Passkey assertion response for the current account-security challenge.

accountSecurityPasskeyStart

Type: WebauthnChallengePayload!

Starts a passkey assertion that reauthenticates the current interactive session.

accountSecurityPasswordVerify

Type: LoginPayload!

Verifies the current local password and returns a fresh account-security session.

Arguments

Name	Description
currentPassword String!	Current local password used to reauthenticate this interactive session.

acknowledgeAutoBackupDisabledMissingKeyNotice

Type: AutoBackupSettingsPayload!

Marks the missing auto-backup-key notice as acknowledged and returns refreshed backup status.

addTitle

Type: AddTitleResult!

Create or reuse a title in an accessible library and return its hydration state.

Arguments

Name	Description
input AddTitleInput!	Title metadata, library selection, and optional tri-state title settings.

addTitleAndQueueDownload

Type: AddTitleResult!

Create or reuse a title and enqueue a download using the supplied source metadata.

Arguments

Name	Description
input AddTitleInput!	Title metadata, library selection, title settings, and optional source release details.

applyMediaRename

Type: MediaRenameApplyPayload!

Deprecated: use renameTitles, which runs the work as a job

Apply a title rename plan after validating its preview fingerprint and optional idempotency key.

Arguments

Name	Description
input MediaRenameApplyInput!	Facet, title identity, preview fingerprint, and optional idempotency key.

applyMediaRenameBulk

Type: MediaRenameApplyPayload!

Deprecated: use renameTitles, which runs the work as a job

Apply a facet-wide rename plan after validating its preview fingerprint and optional idempotency key.

Arguments

Name	Description
input MediaRenameBulkApplyInput!	Facet, preview fingerprint, and optional idempotency key.

applyRestoreBundle

Type: RestoreApplyPayload!

Stage an inspected restore bundle for application on restart and schedule that restart.

Arguments

Name	Description
uploadId ID!	Temporary upload ID returned by inspectRestoreBundle.
password String	Bundle password; null or blank selects an unencrypted bundle.

applyTitleFolderChange

Type: ChangeTitleFolderPayload!

Correct which existing folder a title owns, rescanning it; never moves files.

Ownership of a folder another title holds is never taken silently: the default resolution is refused and the caller must choose SWAP or TAKE_OVER.

Arguments

Name	Description
input ApplyTitleFolderChangeInput!	Title, chosen folder inside its library roots, and how to settle ownership.

approveMediaRequest

Type: ApproveMediaRequestPayload!

Approve a request, create or update its title, and report any queued search attempt.

Arguments

Name	Description
input ApproveMediaRequestInput!	Request identity and optional quality and monitoring overrides.

assignTrackedDownloadTitle

Type: DownloadQueueActionPayload!

Attach a tracked download to a title and acquisition scope.

Arguments

Name	Description
input AssignTrackedDownloadTitleInput!	Download client identity, title identity, and target scope.

beginInstallPlugin

Type: PluginInstallProgressPayload!

Start background installation of a catalog plugin and return the initial progress snapshot.

Arguments

Name	Description
pluginId ID!	Catalog plugin ID to install.

beginManualImportSelection

Type: ManualImportSelectionPayload!

Inspect a tracked download and persist a server-owned selection of importable files.

Arguments

Name	Description
input BeginManualImportSelectionInput!	Download client identity and title used to build the manual-import preview.

beginUpgradePlugin

Type: PluginInstallProgressPayload!

Start background upgrade of an installed catalog plugin and return the initial progress snapshot.

Arguments

Name	Description
pluginId ID!	Installed plugin ID to upgrade.

bindPendingImport

Type: ResolvePendingImportPayload!

Bind a pending import to an existing collection and optional episodes.

Arguments

Name	Description
input BindPendingImportInput!	Pending-import identity, optional collection identity, and episode identities to bind.

blocklistExternalSubtitle

Type: BlocklistExternalSubtitlePayload!

Delete a provider-backed subtitle and add its provider result to the subtitle blocklist.

Arguments

Name	Description
input BlocklistExternalSubtitleInput!	External subtitle ID, optional reason, required preview fingerprint, and any confirmation text.

cancelAcquisitionSearch

Type: CancelAcquisitionSearchPayload!

Request cancellation of an acquisition-search job and report whether its state changed.

Arguments

Name	Description
id ID!	Acquisition-search job identity to cancel.

cancelActiveImport

Type: Boolean!

Cancel a queued or copying import operation by its server-issued stream identity.

Arguments

Name	Description
streamId ID!	Opaque identity of the queued or active import stream.

cancelExternalImportArrSourceWarmup

Type: CancelExternalImportMonitorWarmupPayload!

Request cancellation of an Arr source warmup and report whether cancellation was accepted.

Arguments

Name	Description
sessionId ID!	Warmup session identity to cancel.

cancelInteractiveReleaseSearch

Type: CancelInteractiveReleaseSearchPayload!

Cancel a running interactive release-search job.

Arguments

Name	Description
id ID!	Interactive release-search job identity to cancel.

cancelLibraryScan

Type: CancelLibraryScanPayload!

Request cancellation of a library scan and return the cancellation result.

Arguments

Name	Description
sessionId ID!	Library scan session identity to cancel.

cancelLocationOperation

Type: CancelLocationOperationPayload!

Request cancellation; the operation stops at its next title checkpoint.

Titles already finished stay where the operation put them: cancelling is a safe stop, never a rollback.

Arguments

Name	Description
id ID!	Location-operation identity to stop at its next title checkpoint.

cancelMyMediaRequest

Type: MediaRequestActionPayload!

Cancel the caller’s request without deleting an already-created title.

Arguments

Name	Description
requestId ID!	Request identity to cancel.

clearExternalImportSetupSecretDraft

Type: ClearExternalImportSetupSecretDraftPayload!

Clear the caller’s external-import secret draft; clearing an absent draft is harmless.

clearTitleImageCache

Type: ClearTitleImageCachePayload!

Requests title-image cache clearing and returns the request timestamp after authorization.

clearTitleReleaseBlocklistEntry

Type: ClearTitleReleaseBlocklistEntryPayload!

Clear one title release blocklist entry so it can be considered again.

Arguments

Name	Description
id ID!	Title release blocklist entry identity to clear.

completeLoginMfaEnrollment

Type: LoginMfaEnrollmentCompletePayload!

Completes required login MFA enrollment, returns one-time recovery codes, and issues the authenticated login payload.

Arguments

Name	Description
input TotpEnrollmentCompleteInput!	MFA-enrollment challenge ID and current TOTP code.

completeRequiredPasswordChange

Type: LoginPayload!

Replaces an administrator-provided temporary password and issues the full session.

Arguments

Name	Description
input CompleteRequiredPasswordChangeInput!	New password selected by the authenticated user.

completeSetup

Type: CompleteSetupPayload!

Mark the setup wizard as complete.

convertTitleClaimToPermanent

Type: TitleClaim!

Replace a live claim with a permanent operator keep.

The replacement is a new claim rather than a mutated one, so the original stays as history and the trail still says a request produced the hold and an administrator chose to make it permanent.

Arguments

Name	Description
input ConvertTitleClaimToPermanentInput!	Claim identity to convert.

copyTrackedRulePackRule

Type: RuleSetPayload!

Copy one tracked rule to an editable custom rule and disable the source binding.

Arguments

Name	Description
ruleSetId ID!	Tracked local rule-set ID to copy.
name String!	Name for the editable copy.
description String!	Description for the editable copy.
regoSource String!	Complete Rego source for the editable copy.
appliedFacets [String!]!	Facet scope for the editable copy.
priority Int!	Evaluation priority for the editable copy.

createBackup

Type: BackupInfoPayload!

Create a password-protected backup and return its stored backup metadata.

Arguments

Name	Description
input CreateBackupInput!	Password used to encrypt the new backup bundle.

createDownloadClientConfig

Type: DownloadClientConfigPayload!

Create a download-client configuration and seed supported routing defaults.

Arguments

Name	Description
input CreateDownloadClientConfigInput!	Download-client provider, configuration values, and enabled state.

createExternalAccountInvite

Type: LinkedAccountPayload!

Creates an external-account invite for a target user and connection without returning provider credentials.

Arguments

Name	Description
input CreateExternalAccountInviteInput!	Target user, media-server connection, provider, and provider account identifiers for the invite.

createIndexerConfig

Type: IndexerConfigPayload!

Create an indexer configuration with provider, routing, and search defaults.

Arguments

Name	Description
input CreateIndexerConfigInput!	Indexer provider configuration, optional proxy and download-client identities, and search defaults.

createLibrary

Type: LibraryPayload!

Create a media library with roots and optional acquisition or import settings.

Arguments

Name	Description
input CreateLibraryInput!	Library facet, name, root paths, and optional settings.

createMaintenanceRuleSet

Type: MaintenanceRuleSetDetail!

Create a maintenance rule set together with its first matcher revision.

Arguments

Name	Description
input CreateMaintenanceRuleSetInput!	Rule name, matcher source, action, and optional description, grace period, and library scope.

createMediaServerConnection

Type: MediaServerConnectionPayload!

Creates a media-server connection with defaults for omitted enablement flags and redacted secret fields in the result.

Arguments

Name	Description
input CreateMediaServerConnectionInput!	Connection details and optional credentials; omitted enabled defaults true while login and linking default false.

createMyApiKey

Type: CreateMyApiKeyPayload!

Creates an API key for the interactive actor and returns its secret once.

Arguments

Name	Description
input CreateMyApiKeyInput!	Label and expiration policy for the new API key.

createNotificationChannel

Type: NotificationChannelPayload!

Create an enabled notification channel with provider configuration.

Arguments

Name	Description
input CreateNotificationChannelInput!	Channel name, provider type, configuration values, optional media-server identity, and enabled state.

createNotificationSubscription

Type: NotificationSubscriptionPayload!

Create an enabled notification subscription for a target and event.

Arguments

Name	Description
input CreateNotificationSubscriptionInput!	Optional channel and target identities, event type, scope, and enabled state.

createOauthClientRegistration

Type: OauthClientRegistrationPayload!

Registers a public OAuth application with exact HTTPS callbacks and mandatory S256 PKCE.

Arguments

Name	Description
input CreateOAuthClientRegistrationInput!	Display name and exact HTTPS callback allowlist for the application.

createPostProcessingScript

Type: PostProcessingScriptPayload!

Create an enabled post-processing script after validating its type and content.

Arguments

Name	Description
input CreatePostProcessingScriptInput!	Script definition, execution settings, and required acknowledgement for inline shell code.

createProxyConfig

Type: ProxyConfigPayload!

Create a proxy configuration.

Arguments

Name	Description
input CreateProxyConfigInput!	Proxy provider, base URL, timeout, and enabled state.

createRequestRuleSet

Type: RequestRuleSetDetail!

Create a request rule set together with its first matcher revision.

The rule is created disabled. Arming it is a second, deliberate call, and the instance gate is a third.

Arguments

Name	Description
input CreateRequestRuleSetInput!	Rule name, matcher source, and optional description and library scope.

createRuleSet

Type: RuleSetPayload!

Create a catalog rule set with optional facet scope, priority, and enabled state.

Arguments

Name	Description
input CreateRuleSetInput!	Rule name, source, optional description and facet scope, priority, and enabled state.

createSeedingProfile

Type: SeedingProfilePayload!

Create a torrent seeding profile.

Arguments

Name	Description
input CreateSeedingProfileInput!	Seeding profile name, goals, and removal behavior.

createSubtitleProviderConfig

Type: SubtitleProviderConfigPayload!

Create a subtitle-provider configuration.

Arguments

Name	Description
input CreateSubtitleProviderConfigInput!	Subtitle provider, configuration values, enabled facets, and enabled state.

createTitleTagDefinition

Type: TitleTagDefinitionMutationPayload!

Defines a new title tag after checking the catalog-settings permission.

Deciding which tags exist is catalog configuration, exactly like a delay profile. Deciding which titles carry them is title management and is checked per library by updateTitleTags instead.

Arguments

Name	Description
input CreateTitleTagDefinitionInput!	Label to define and an optional note; the label is normalized before it is stored.

createUser

Type: UserPayload!

Creates a user with normalized app and library permissions after checking the manage-users permission.

Arguments

Name	Description
input CreateUserInput!	Username, password, and initial app and library permissions for the new user.

deleteBackup

Type: DeleteBackupPayload!

Delete a stored backup by filename and report whether it existed.

Arguments

Name	Description
input DeleteBackupInput!	Stored backup filename to delete.

deleteDelayProfile

Type: DelayProfileDeletionPayload!

Deletes the delay profile identified by id and returns the accepted ID.

Arguments

Name	Description
id ID!	ID of the delay profile to delete.

deleteDownload

Type: DownloadQueueActionPayload!

Delete a tracked download through its configured client and return its prior queue state.

Arguments

Name	Description
input DeleteDownloadInput!	Download client identity and whether the item should be treated as history.

deleteDownloadClientConfig

Type: DeleteDownloadClientConfigPayload!

Delete a download-client configuration and clear dependent indexer mappings.

Arguments

Name	Description
id ID!	Download-client configuration identity to delete.

deleteEpisodeFiles

Type: DeleteEpisodeFilesPayload!

Accept a background job deleting every media file linked to the supplied episodes of one title.

The aggregate preview from deleteEpisodeFilesPreview must still match when files are removed from disk. Per-file results land on the returned job run: a file that fails is recorded there while the rest still run.

Arguments

Name	Description
input DeleteEpisodeFilesInput!	Title and episode identities, disk-deletion choice, and the aggregate preview fingerprint with optional typed confirmation.

deleteExternalSubtitle

Type: DeleteExternalSubtitlePayload!

Delete an external subtitle file and its tracked record.

Arguments

Name	Description
input DeleteExternalSubtitleInput!	External subtitle ID plus the required preview fingerprint and any confirmation text.

deleteIndexerConfig

Type: DeleteIndexerConfigPayload!

Delete an indexer configuration.

Arguments

Name	Description
id ID!	Indexer configuration identity to delete.

deleteLibrary

Type: DeleteLibraryPayload!

Delete the library configuration identified by the supplied ID.

Arguments

Name	Description
id ID!	Library identity to delete.

deleteMaintenanceRuleSet

Type: DeleteMaintenanceRuleSetPayload!

Delete a maintenance rule set and every revision it owns.

Refused for a rule that has already run actions, because the delete cascades and would take the record of what it did with it, and for one that is still tracking subjects. Set the rule’s mode to DISABLED instead: it stops just as completely and keeps its history.

Arguments

Name	Description
id ID!	Maintenance rule-set identity to delete.

deleteMediaFile

Type: DeleteMediaFilePayload!

Accept a background job to delete a media file, optionally removing it from disk.

Arguments

Name	Description
input DeleteMediaFileInput!	Media-file identity, disk-deletion choice, and optional preview fingerprint and typed confirmation.

deleteMediaServerConnection

Type: DeleteMediaServerConnectionPayload!

Deletes the media-server connection identified by id after authorization.

Arguments

Name	Description
id ID!	ID of the media-server connection to delete.

deleteMyPasskey

Type: DeleteMyPasskeyPayload!

Deletes the authenticated actor’s passkey identified by id.

Arguments

Name	Description
id ID!	ID of the authenticated actor's passkey to delete.

deleteNotificationChannel

Type: DeleteNotificationChannelPayload!

Delete a notification channel.

Arguments

Name	Description
id ID!	Notification-channel identity to delete.

deleteNotificationSubscription

Type: DeleteNotificationSubscriptionPayload!

Delete a notification subscription.

Arguments

Name	Description
id ID!	Notification-subscription identity to delete.

deleteOauthClientRegistration

Type: DeleteOAuthClientRegistrationPayload!

Deletes a custom OAuth application and revokes every active grant issued to it.

Arguments

Name	Description
clientId String!	Immutable client identifier returned during registration.

deletePostProcessingScript

Type: DeletePostProcessingScriptPayload!

Delete a post-processing script; this requires catalog-settings permission.

Arguments

Name	Description
id ID!	Script identity to delete.

deleteProxyConfig

Type: DeleteProxyConfigPayload!

Delete a proxy configuration.

Arguments

Name	Description
id ID!	Proxy configuration identity to delete.

deleteQualityProfile

Type: QualityProfileSettingsPayload!

Deletes the quality profile identified by id and returns refreshed quality settings.

Arguments

Name	Description
id ID!	ID of the quality profile to delete.

deleteRecycledItem

Type: DeleteRecycledItemPayload!

Permanently delete a single recycled item and its retained file when applicable.

Arguments

Name	Description
id ID!	Recycled-item identity to permanently delete.

deleteRecycledItems

Type: DeleteRecycledItemsPayload!

Permanently delete selected recycled items using one background job.

Arguments

Name	Description
input DeleteRecycledItemsInput!	Recycled-item identities to permanently delete.

deleteRequestRuleSet

Type: DeleteRequestRuleSetPayload!

Delete a request rule set and every revision it owns.

The decisions it took part in are kept: a trace is the explanation of a decision already made, and it outlives the rule that produced it.

Arguments

Name	Description
id ID!	Request rule-set identity to delete.

deleteRuleSet

Type: DeleteRuleSetPayload!

Delete a rule set.

Arguments

Name	Description
id ID!	Rule-set identity to delete.

deleteSeedingProfile

Type: DeleteSeedingProfilePayload!

Delete a seeding profile that nothing references.

Arguments

Name	Description
id ID!	Seeding profile identity to delete.

deleteSubtitleProviderConfig

Type: DeleteSubtitleProviderConfigPayload!

Delete a subtitle-provider configuration.

Arguments

Name	Description
id ID!	Subtitle-provider configuration identity to delete.

deleteTitle

Type: DeleteTitlePayload!

Delete one title, optionally removing its files after preview confirmation.

Arguments

Name	Description
input DeleteTitleInput!	Title identity, disk-deletion choice, and optional preview fingerprint and typed confirmation.

deleteTitles

Type: DeleteTitlesPayload!

Accept a background job to delete selected titles and optionally their files.

Arguments

Name	Description
input DeleteTitlesInput!	Title deletion items, optional disk-deletion choice, and typed confirmation.

deleteTitleTagDefinition

Type: TitleTagDefinitionDeletionPayload!

Deletes a title tag and strips it from every title and delay profile.

Arguments

Name	Description
id ID!	ID of the title tag to delete.

deleteUser

Type: DeleteUserPayload!

Deletes the user identified by id after checking the manage-users permission.

Arguments

Name	Description
id ID!	ID of the user to delete.

diagnoseMediaFile

Type: MediaStructuralDiagnosticsPayload!

Opt-in bounded header diagnostics; this does not change import acceptance or stored analysis.

Arguments

Name	Description
fileId ID!	Registered physical media file ID to inspect.

discoverEmbyConnectServers

Type: [EmbyConnectServerPayload!]!

Discovers Emby Connect servers using credentials without saving a connection.

Arguments

Name	Description
input DiscoverEmbyConnectServersInput!	Emby Connect credentials used only for discovery.

discoverPlexMediaServers

Type: [PlexServerDiscoveryPayload!]!

Discovers Plex servers for the supplied token without saving a connection.

Arguments

Name	Description
plexAuthToken String!	Plex authentication token used for discovery and not returned by this field.

dismissMediaRequest

Type: MediaRequestActionPayload!

Dismiss a media request without creating a catalog title.

Arguments

Name	Description
requestId ID!	Request identity to dismiss.

dismissPendingRelease

Type: DismissPendingReleasePayload!

Dismiss a pending release so it is not considered for the current pending state.

Arguments

Name	Description
id ID!	Pending-release identity to dismiss.

downloadSubtitle

Type: DownloadSubtitlePayload!

Download a provider subtitle and save it beside the selected media file.

Arguments

Name	Description
input DownloadSubtitleInput!	Provider result, media file ID, language, and matching metadata to retain.

emptyRecycleBin

Type: EmptyRecycleBinPayload!

Empty recycle bins for the selected libraries using a background job.

Arguments

Name	Description
libraryIds [ID!]	Optional library identities to purge; null targets all accessible recycle bins.

excludeMaintenanceSubject

Type: MaintenanceExclusion!

Exclude a subject from one maintenance rule, or from every rule when no rule is named.

The exclusion takes effect at the next evaluation, which is also where an existing candidate for the subject moves to the excluded state.

Arguments

Name	Description
input ExcludeMaintenanceSubjectInput!	Subject to exclude, the optional rule to confine it to, and a reason.

executeExternalImport

Type: ExternalImportResultPayload!

Re-connect to Sonarr/Radarr, fetch configs, and create selected items in Scryer.

Arguments

Name	Description
input ExecuteExternalImportInput!	Selected imported clients and indexers plus any credentials needed to create them.

extendTitleClaim

Type: TitleClaim!

Push a live claim’s window out. Requires title management on the claim’s own library.

Arguments

Name	Description
input ExtendTitleClaimInput!	Claim identity and its new expiry.

finalizeExternalImport

Type: FinalizeExternalImportPayload!

Apply selected source mappings, imported monitoring state, scan hints, and safe settings. The operation consumes completed warmup sessions after successful reconciliation.

Arguments

Name	Description
input FinalizeExternalImportInput!	Warmup sessions and validated library root mappings to reconcile into the catalog.

fixTitleMatch

Type: FixTitleMatchPayload!

Associate a title with a metadata identity and return any hydration or scan result.

Arguments

Name	Description
input FixTitleMatchInput!	Title identity and metadata identity used for the rematch.

forceGrabPendingRelease

Type: ForceGrabPendingReleasePayload!

Force a pending release to be grabbed and report whether the grab was accepted.

Arguments

Name	Description
id ID!	Pending-release identity to grab.

ignorePendingImport

Type: IgnorePendingImportPayload!

Mark a pending import ignored without importing its files.

Arguments

Name	Description
pendingImportId ID!	Pending-import identity to ignore.

ignoreTrackedDownload

Type: DownloadQueueActionPayload!

Mark a tracked download ignored without deleting it from the download client.

Arguments

Name	Description
input IgnoreTrackedDownloadInput!	Download client identity used to locate the tracked item.

inspectManualPluginRepo

Type: ManualPluginPreviewPayload!

Inspect a GitHub plugin repository without installing its artifact.

Arguments

Name	Description
input ManualPluginRepoInput!	GitHub repository URL containing the plugin manifest and artifact.

inspectRestoreBundle

Type: RestoreInspectPayload!

Inspect and stage an uploaded restore bundle while setup mode is active. The returned upload ID remains temporary and must be supplied to the apply operation.

Arguments

Name	Description
bundleUpload Upload!	Backup bundle supplied through GraphQL multipart upload.
password String	Bundle password; null or blank selects an unencrypted bundle.

installManualPlugin

Type: PluginInstallationPayload!

Install a plugin directly from an inspected GitHub repository.

Arguments

Name	Description
input ManualPluginRepoInput!	GitHub repository URL containing the plugin manifest and artifact.

installTrackedRulePack

Type: TrackedRulePackPayload!

Install the whole verified pack with selected templates enabled.

Arguments

Name	Description
packId String!	Immutable registry rule-pack ID.
templateIds [String!]!	Template IDs to enable. An empty list installs every rule disabled.

installUploadedPlugin

Type: PluginInstallationPayload!

Install a base64-encoded WebAssembly plugin after explicit risk acknowledgement.

Arguments

Name	Description
input ManualPluginUploadInput!	Plugin filename, base64-encoded WebAssembly bytes, and required risk acknowledgement.

issueInteractiveReleaseCandidateToken

Type: IndexerSearchResultPayload!

Mint a candidate token for one release of an interactive search, bound to the chosen title and season/episode target, so it can be queued with the existing download mutations.

Arguments

Name	Description
input IssueInteractiveReleaseCandidateTokenInput!	Search job, release download URL, and the title (with optional season and episode) the release is assigned to.

linkCurrentOAuthJellyfinAccount

Type: LinkedAccountPayload!

Links the current OAuth caller to the Jellyfin user bound to the plugin’s approved OAuth grant. Neither a Scryer user nor a connection may be selected by the caller.

Arguments

Name	Description
jellyfinUserId String!	Canonical Jellyfin user GUID reported by the Jellyfin client.

linkEmbyAccount

Type: LinkedAccountPayload!

Links the authenticated actor to Emby using the selected connection mode and credentials.

Arguments

Name	Description
input LinkEmbyAccountInput!	Emby connection ID, local or Connect mode, and credentials used for linking.

linkJellyfinAccount

Type: LinkedAccountPayload!

Links the authenticated actor to Jellyfin using a connection ID and credentials.

Arguments

Name	Description
input LinkJellyfinAccountInput!	Jellyfin connection ID, username, and password used for linking.

linkPlexAccount

Type: LinkedAccountPayload!

Links the authenticated actor to Plex using a connection ID and token.

Arguments

Name	Description
input LinkPlexAccountInput!	Plex connection ID and authentication token used for linking.

login

Type: LoginPayload!

Authenticates local credentials, optionally verifies required TOTP, and issues a session or MFA-enrollment token.

Arguments

Name	Description
input LoginInput!	Username, password, and optional TOTP code for local authentication.

loginVerificationPasskeyComplete

Type: LoginPayload!

Completes the passkey assertion required after primary credentials succeed.

Arguments

Name	Description
input LoginVerificationPasskeyCompleteInput!	Pending login verification and browser assertion response.

loginVerificationPasskeyStart

Type: WebauthnChallengePayload!

Starts the user-bound passkey assertion required after primary credentials succeed.

Arguments

Name	Description
challengeId ID!	Opaque login verification challenge ID returned after primary authentication.

loginVerificationTotpComplete

Type: LoginPayload!

Completes the TOTP or recovery-code fallback required after primary credentials succeed.

Arguments

Name	Description
input LoginVerificationTotpCompleteInput!	Pending login verification challenge and current authenticator or recovery code.

loginWithEmby

Type: LoginPayload!

Authenticates through Emby, applies configured TOTP requirements, and issues a session or MFA-enrollment token.

Arguments

Name	Description
input LoginWithEmbyInput!	Emby connection ID, mode, credentials, optional TOTP code, and optional session-persistence preference.

loginWithJellyfin

Type: LoginPayload!

Authenticates through Jellyfin, applies configured TOTP requirements, and issues a session or MFA-enrollment token.

Arguments

Name	Description
input LoginWithJellyfinInput!	Jellyfin connection ID, credentials, optional TOTP code, and optional session-persistence preference.

loginWithPlex

Type: LoginPayload!

Authenticates through Plex and issues a session token.

Arguments

Name	Description
input LoginWithPlexInput!	Plex connection ID, authentication token, and optional session-persistence preference.

mapMediaFileDiscEpisodes

Type: TitleMediaFilePayload!

Save explicit disc-title-to-episode associations on the existing physical image.

Arguments

Name	Description
fileId ID!	Registered physical media file ID.
mappings [MediaDiscEpisodeMappingInput!]!	Complete replacement set of authored-title-to-episode associations.

markTrackedDownloadFailed

Type: DownloadQueueActionPayload!

Mark a tracked download failed and optionally suppress automatic reacquisition.

Arguments

Name	Description
input MarkTrackedDownloadFailedInput!	Download client identity and the failure handling option.

mediaFileDiscEpisodeTargets

Type: [MediaDiscEpisodeTargetPayload!]!

List catalogued episodes eligible for explicit mapping to this registered disc image.

Arguments

Name	Description
fileId ID!	Registered physical media file ID.

mfaVerifyStepUp

Type: LoginPayload!

Verifies TOTP for a configuration step-up and issues a session with the resulting freshness window.

Arguments

Name	Description
input TotpVerifyInput!	Current TOTP code used for step-up verification.

pauseDownload

Type: DownloadQueueActionPayload!

Pause a tracked download through its configured download client.

Arguments

Name	Description
input PauseDownloadInput!	Download client item identity to pause.

pauseWantedItem

Type: PauseWantedItemPayload!

Pause acquisition for a scope. id is a state-row id or a convergence scope key; a scope key with no row yet materializes one.

Arguments

Name	Description
id ID!	Wanted-state row id or convergence scope key to pause.

prepareBackupDownload

Type: BackupDownloadUrlPayload!

Create a short-lived authorization token for downloading an existing backup.

Arguments

Name	Description
input PrepareBackupDownloadInput!	Stored backup filename to authorize for download.

previewExternalImport

Type: ExternalImportPreviewPayload!

Connect to Sonarr and/or Radarr, fetch their configs, return a preview.

Arguments

Name	Description
input PreviewExternalImportInput!	Completed or running warmup sessions and optional direct Prowlarr credentials.

previewMaintenanceRule

Type: MaintenancePreviewPayload!

Evaluate one matcher against a bounded title selection without saving anything.

Arguments

Name	Description
input PreviewMaintenanceRuleInput!	Either a stored rule set or an unsaved matcher, plus either the titles or the library to evaluate.

previewRequestRule

Type: RequestRulePreviewPayload!

Evaluate one matcher against one hypothetical request without saving anything.

This is the author-side preview: it returns the vote, the reasons, the tags, and the exact input document the rule saw. The requester-facing equivalent is the previewMyRequestDecision query, which returns none of the internals.

Arguments

Name	Description
input PreviewRequestRuleInput!	Either a stored rule set or an unsaved matcher, plus the sample request to evaluate it against.

previewTrackedRulePackUpdate

Type: TrackedRulePackPreviewPayload!

Preview the exact template changes from the latest compatible source version.

Arguments

Name	Description
packId String!	Installed rule-pack ID to compare with the registry.

queueBestRelease

Type: QueueDownloadPayload!

Select and queue the best available release for a title within the requested scope.

Arguments

Name	Description
input QueueBestReleaseInput!	Title, scope, and optional replacement policy for the best-release submission.

queueExistingTitleDownload

Type: QueueDownloadPayload!

Queue the release represented by a signed candidate token for an existing title. Returns a job id when accepted or a conflict payload when the submission scope is busy.

Arguments

Name	Description
input QueueDownloadInput!	Signed candidate token and submission options; the token supplies the release identity.

queueManualImport

Type: DownloadQueueActionPayload!

Accept a manual file-to-title mapping and enqueue the import for background processing.

Arguments

Name	Description
input QueueManualImportInput!	Selection id and candidate mappings chosen from a prior manual-import preview.

queueReplacementRelease

Type: QueueDownloadPayload!

Queue an operator-chosen release to replace the existing primary file. Scope comes from the signed candidate token and purpose is always the server-owned manual-replacement purpose.

Arguments

Name	Description
input QueueDownloadInput!	Signed candidate token for the replacement release; its scope and purpose override the input values.

queueUnlinkedRelease

Type: QueueUnlinkedReleasePayload!

Grab one release of an interactive search with no catalog title behind it: it is submitted to the chosen download client and recorded orphan-scoped, so the completed download waits in Activity for a manual import.

Arguments

Name	Description
input QueueUnlinkedReleaseInput!	Search job, release download URL, and the enabled download client the release is handed to.

refreshPluginCatalog

Type: [RegistryPluginPayload!]!

Refresh the configured plugin registry catalogs and return the available plugins.

rehydrateAllMetadata

Type: RehydrateAllMetadataPayload!

Rehydrate accessible title metadata for one language and report cleared title counts.

Arguments

Name	Description
input RehydrateAllMetadataInput!	Metadata language code used for rehydration.

releaseTitleClaim

Type: TitleClaim!

Withdraw a claim by hand. The reason is required and kept as history.

Arguments

Name	Description
input ReleaseTitleClaimInput!	Claim identity and why it is being released.

removeMaintenanceExclusion

Type: DeleteMaintenanceExclusionPayload!

Remove a maintenance exclusion.

Arguments

Name	Description
id ID!	Exclusion identity to remove.

renameTitles

Type: RenameTitlesPayload!

Start a background job renaming the files of the given titles.

Arguments

Name	Description
input RenameTitlesInput!	Facet and titles whose files are renamed; the work runs in the background.

reorderDownloadClientConfigs

Type: ReorderDownloadClientConfigsPayload!

Persist the ordering of download-client configurations.

Arguments

Name	Description
input ReorderDownloadClientConfigsInput!	Download-client identities in their desired order.

resetProxyHostKey

Type: ProxyConfigPayload!

Forget the pinned tunnel host key so the next connection trusts the server again.

Arguments

Name	Description
id ID!	Tunnel proxy configuration identity whose pinned host key to forget.

resetUserMfa

Type: UserPayload!

Resets all authentication factors for the user identified by id after checking the manage-users permission.

Arguments

Name	Description
id ID!	ID of the user whose authentication factors should be reset.

resolvePendingImport

Type: ResolvePendingImportPayload!

Resolve a pending import by creating or selecting its title metadata.

Arguments

Name	Description
input ResolvePendingImportInput!	Pending-import identity and title metadata used to resolve it.

restoreRecycledItem

Type: RestoreRecycledItemPayload!

Restore a recycled item back to its original path on disk.

Arguments

Name	Description
id ID!	Recycled-item identity to restore to its original path.

restoreRecycledItems

Type: RestoreRecycledItemsPayload!

Restore selected recycled items using one background job.

Arguments

Name	Description
input RestoreRecycledItemsInput!	Recycled-item identities, conflict policy, and preview fingerprint for the restore job.

resumeDownload

Type: DownloadQueueActionPayload!

Resume a paused tracked download through its configured download client.

Arguments

Name	Description
input ResumeDownloadInput!	Download client item identity to resume.

resumeLocationOperation

Type: ResumeLocationOperationPayload!

Pick an interrupted operation back up from its last verified checkpoint, or retry a failed or canceled one from the same place.

Finished titles are never reprocessed: a retry repeats only the titles that did not settle, after reopening the operation so Activity shows it as queued again. An operation that already finished, or was stored without its plan, is reported as not resumed rather than restarted from the beginning.

Arguments

Name	Description
id ID!	Location-operation identity to resume from its checkpoints.

resumeWantedItem

Type: ResumeWantedItemPayload!

Resume acquisition for a paused scope. id is a state-row id or a convergence scope key.

Arguments

Name	Description
id ID!	Wanted-state row id or convergence scope key to resume.

retryImport

Type: ImportResultPayload!

Retry a previously failed import, optionally with an archive password.

Arguments

Name	Description
input RetryImportInput!	Failed import identity and optional archive password used for the retry.

revokeMyApiKey

Type: RevokeMyApiKeyPayload!

Revokes one user-created API key owned by the interactive actor.

Arguments

Name	Description
id ID!	API-key record ID to revoke.

revokeMyOauthApp

Type: RevokeMyOauthAppPayload!

Revokes the authenticated actor’s OAuth grant identified by grant_id.

Arguments

Name	Description
grantId ID!	Grant ID of the OAuth app authorization to revoke.

runMaintenanceActionHandlerNow

Type: MaintenanceEvaluationTriggerPayload!

Run the maintenance action handler immediately instead of waiting for its schedule.

runMaintenanceEvaluationNow

Type: MaintenanceEvaluationTriggerPayload!

Run maintenance evaluation now.

Without a rule, this starts the ordinary scheduled job so the run shows up in the system-jobs surface, and returns as soon as it is accepted. Scoped to one rule it runs inline instead, because the job seam carries no parameters; that path is bounded by the rule’s own library scope.

Arguments

Name	Description
ruleSetId ID	Evaluate only this rule set; omit to evaluate every enabled rule.

saveExternalImportSetupSecretDraft

Type: SaveExternalImportSetupSecretDraftPayload!

Save the caller’s external-import secret draft and report whether another draft was replaced.

Arguments

Name	Description
input SaveExternalImportSetupSecretDraftInput!	Instance secrets and masked provider credentials keyed by their import deduplication keys.

saveQualityProfileSettings

Type: QualityProfileSettingsPayload!

Saves quality profiles and global or facet selections, using profile IDs to match existing profiles.

Arguments

Name	Description
input SaveQualityProfileSettingsInput!	Quality profiles and selections; replace_existing controls replacement while profile IDs match existing records.

scanLibrary

Type: LibraryScanProgressPayload!

Start a library scan and return the accepted scan session snapshot.

Arguments

Name	Description
input ScanLibraryInput!	Library identity and optional completed import-warmup session for scan hints.

scanTitleLibrary

Type: LibraryScanSummaryPayload!

Scan the library paths associated with one title and return the summary.

Arguments

Name	Description
titleId ID!	Title identity whose library paths should be scanned.

searchSubtitles

Type: SubtitleSearchPayload!

Search configured providers for subtitles matching a media file, and report why the search returned what it did.

Arguments

Name	Description
input SearchSubtitlesInput!	Media file ID and, optionally, the subtitle language to search for.

selectMediaFileDiscTitle

Type: TitleMediaFilePayload!

Select a playback title in a registered ISO; null restores automatic selection.

Arguments

Name	Description
fileId ID!	Registered physical media file ID.
discTitleId String	Authored title ID; null restores automatic selection.

setCollectionMonitored

Type: SetCollectionMonitoredPayload!

Set collection monitoring and return the affected collection episodes.

Arguments

Name	Description
input SetCollectionMonitoredInput!	Collection identity and desired monitored state.

setDefaultSeedingProfile

Type: DefaultSeedingProfilePayload!

Set or clear the seeding profile applied when nothing more specific matches.

Arguments

Name	Description
input SetDefaultSeedingProfileInput!	Seeding profile identity to use as the default, or null to clear it.

setEpisodeMonitored

Type: EpisodePayload!

Set episode monitoring and return the updated episode.

Arguments

Name	Description
input SetEpisodeMonitoredInput!	Episode identity and desired monitored state.

setIndexerDownloadClientMapping

Type: IndexerConfigPayload!

Set or clear the download client associated with an indexer.

Arguments

Name	Description
input SetIndexerDownloadClientMappingInput!	Indexer identity and optional download-client identity; null clears the mapping.

setIndexerSeedingProfile

Type: IndexerConfigPayload!

Set or clear the seeding profile applied to torrents from an indexer.

Arguments

Name	Description
input SetIndexerSeedingProfileInput!	Indexer identity and optional seeding profile identity; null clears the assignment.

setMaintenanceInstanceGates

Type: MaintenanceInstanceGates!

Arm or disarm the instance-wide maintenance gates. Omitted fields keep their stored value.

Arguments

Name	Description
input SetMaintenanceInstanceGatesInput!	The gates to change; omit a field to leave that gate alone.

setMaintenanceRuleArming

Type: MaintenanceRuleSet!

Set how far one rule set’s effects are armed. Destructive arming requires acknowledging the rule’s current candidate count.

Arguments

Name	Description
input SetMaintenanceRuleArmingInput!	Rule-set identity, the arming level, and the acknowledged candidate count for destructive arming.

setMaintenanceRuleMode

Type: MaintenanceRuleSet!

Move a maintenance rule set between evaluation modes.

Creation always produces a disabled rule, so arming one is always this deliberate second step. A rule moved back to disabled keeps the candidates it already opened: flipping a rule off must not destroy the membership and grace clocks it established.

Arguments

Name	Description
input SetMaintenanceRuleModeInput!	Rule-set identity and the evaluation mode to store.

setMinimumSeedersFloor

Type: DefaultSeedingProfilePayload!

Set the minimum-seeder floor applied when no seeding profile resolves.

Arguments

Name	Description
input SetMinimumSeedersFloorInput!	Fewest seeders a torrent candidate may report when no seeding profile resolves; 0 disables the check.

setMyUiSettings

Type: UiSettingsPayload!

Replaces the authenticated actor’s UI settings, retaining the current date-time format when the input omits or nulls it.

Arguments

Name	Description
input SetMyUiSettingsInput!	Complete UI settings to save; omitted or null date_time_format keeps its current value.

setPrimaryMovieFile

Type: TitlePayload!

Set the primary media file for a movie title.

Arguments

Name	Description
input SetPrimaryMovieFileInput!	Movie title identity and media-file identity to make primary.

setRequestRuleInstanceGates

Type: RequestRuleInstanceGates!

Arm or disarm the instance-wide request-rule gate. Omitted fields keep their stored value.

While the gate is off every rule is still evaluated and every decision is still recorded; only the effect is suspended, so an operator can read what policy would have done before letting it do it.

Arguments

Name	Description
input SetRequestRuleInstanceGatesInput!	The gate to change; omit the field to leave it alone.

setRequestRuleMode

Type: RequestRuleSetDetail!

Move a request rule set between evaluation modes.

Arguments

Name	Description
input SetRequestRuleModeInput!	Rule-set identity and the evaluation mode to store.

setSeriesMovieMonitored

Type: SeriesMovieLinkPayload!

Set monitoring for a series-movie link and return the updated link.

Arguments

Name	Description
input SetSeriesMovieMonitoredInput!	Series-movie link identity and desired monitored state.

setTitleMonitored

Type: TitlePayload!

Replace a title’s monitored state.

Arguments

Name	Description
input SetTitleMonitoredInput!	Title identity and desired monitored state.

setTitleRequiredAudio

Type: SetTitleRequiredAudioPayload!

Replace required audio languages for one title and facet.

Arguments

Name	Description
input SetTitleRequiredAudioInput!	Title identity, facet, and required audio-language codes.

setTrackedRulePackSettings

Type: TrackedRulePackPayload!

Atomically retain editable member settings and the automatic-update preference.

Arguments

Name	Description
packId String!	Installed rule-pack ID.
enabledTemplateIds [String!]!	Template IDs that should be enabled.
priorities [TrackedRulePackPriorityInput!]!	Local priority for each template whose priority changes.
autoUpdate Boolean!	Whether the scheduled registry refresh may update this pack.
expectedRevision Long!	Current pack revision required for this mutation.

setUserAppPermissions

Type: UserPayload!

Replaces a user’s app permissions after checking the manage-permissions permission.

Arguments

Name	Description
input SetUserAppPermissionsInput!	Target user ID and complete app-permission set; an empty set removes app permissions.

setUserLibraryPermissions

Type: UserPayload!

Replaces a user’s library grants after checking the manage-permissions permission.

Arguments

Name	Description
input SetUserLibraryPermissionsInput!	Target user ID and complete library-grant set; an empty set removes library grants.

setUserLoginEnabled

Type: UserPayload!

Enables or disables login for the user identified in the input and invalidates active connections.

Arguments

Name	Description
input SetUserLoginEnabledInput!	Target user ID and desired login-enabled state.

setUserPassword

Type: UserPayload!

Sets another user’s password or changes the authenticated actor’s password after validating the target and credentials.

Arguments

Name	Description
input SetUserPasswordInput!	Target user ID, new password, and optional current password for a self-service change.

startApplicationUpgrade

Type: ApplicationUpgradeStartPayload!

Begin a signed in-application upgrade for the currently advertised release.

Arguments

Name	Description
input StartApplicationUpgradeInput!	The update tag and version currently advertised by SMG.

startExternalImportArrSourceWarmup

Type: ExternalImportMonitorWarmupProgressPayload!

Start or reuse a background Sonarr or Radarr warmup and return its current progress snapshot.

Arguments

Name	Description
input StartExternalImportArrSourceWarmupInput!	Arr source kind and connection credentials used to identify the warmup session.

startExternalImportProwlarrWarmup

Type: ExternalImportMonitorWarmupProgressPayload!

Start or reuse a background Prowlarr warmup and return its current progress snapshot.

Arguments

Name	Description
input StartExternalImportProwlarrWarmupInput!	Prowlarr connection credentials used to identify the warmup session.

startInteractiveReleaseSearch

Type: InteractiveReleaseSearchPayload!

Start a background interactive release-search job for the requested scopes. Results accumulate as indexers complete, and a new search cancels the caller’s running job for the same scope.

Arguments

Name	Description
input SearchReleasesInput!	Either a title (with optional series-movie link, season and episode) or a raw query and kind, plus an optional indexer restriction, categories and result limit.

startLocationOperation

Type: StartLocationOperationPayload!

Confirm a previewed location operation and start it in the background.

The plan is rebuilt server side and compared against the fingerprint the client previewed; a stale fingerprint, or a selection that still holds blocked or unresolved titles, is refused instead of started.

The mode is confirmed the same way everything else is: it rebuilds the plan, so confirming USER_MOVED_FILES against a managed-move fingerprint fails the comparison rather than running the other workflow.

A root change (US4) and a root consolidation (US5) confirm through the same mutation, the same rootScope target, and the same typed-confirmation field; only the destination inside that target differs. Exactly one of the two destination forms may be named.

Arguments

Name	Description
input StartLocationOperationInput!	Previewed destination form (a title selection or a root-scoped target), mode, plan fingerprint, and typed confirmation when one is required.

submitMediaRequest

Type: SubmitMediaRequestPayload!

Create a media request with the requested metadata and acquisition preferences.

Arguments

Name	Description
input SubmitMediaRequestInput!	Library, facet, title metadata, and optional quality and monitoring preferences.

syncIndexerConfig

Type: IndexerConfigSyncPayload!

Synchronize an indexer configuration with its provider and return the sync result.

Arguments

Name	Description
id ID!	Indexer configuration identity to synchronize.

testDownloadClientConnection

Type: ProviderValidationPayload!

Test a download-client connection using stored or supplied configuration values.

Arguments

Name	Description
input TestDownloadClientConnectionInput!	Optional stored client identity, provider type, and connection values to test.

testEmbyConnect

Type: MediaServerConnectionTestPayload!

Validates an Emby Connect configuration without changing saved settings.

Arguments

Name	Description
input TestEmbyConnectInput!	Connection ID and Emby Connect credentials used only for this validation request.

testIndexerConnection

Type: ProviderValidationPayload!

Test an indexer connection and return provider validation details.

Arguments

Name	Description
input TestIndexerConnectionInput!	Provider type, optional values, optional indexer identity, and tri-state proxy identity.

testMediaServerConnection

Type: ProviderValidationPayload!

Validates the selected media-server connection without changing its saved configuration.

Arguments

Name	Description
input TestMediaServerConnectionInput!	Connection ID and optional Plex token used only for this validation request.

testNotificationChannel

Type: NotificationChannelTestPayload!

Test a notification channel and return the delivery result.

Arguments

Name	Description
id ID!	Notification-channel identity to test.

testProxyConfig

Type: ProxyTestResultPayload!

Test a proxy connection and return provider validation details.

Arguments

Name	Description
id ID!	Proxy configuration identity to test.
url String	HTTP(S) URL to fetch through this proxy or solver. Omit for the existing health check.

testRuleSet

Type: TestRuleSetPayload!

Evaluate the current unsaved editor draft against title-aware release facts without saving it.

Arguments

Name	Description
input TestRuleSetInput!	Current editor draft, copy context, selected title and episode, release name, and optional size. This is a scoring preview only.

testSubtitleProviderConnection

Type: ProviderValidationPayload!

Test a subtitle-provider connection and return provider validation details.

Arguments

Name	Description
input TestSubtitleProviderConnectionInput!	Optional stored provider identity, provider type, and connection values to test.

togglePlugin

Type: PluginInstallationPayload!

Enable or disable an installed plugin.

Arguments

Name	Description
input TogglePluginInput!	Installed plugin ID and desired enabled state.

togglePostProcessingScript

Type: PostProcessingScriptPayload!

Enable or disable a post-processing script, requiring acknowledgement when enabling inline shell code.

Arguments

Name	Description
id ID!	Script identity to toggle.
inlineShellAcknowledged Boolean	Must be true when enabling an inline shell script; ignored otherwise.

toggleRuleSet

Type: RuleSetPayload!

Set whether a rule set is enabled.

Arguments

Name	Description
input ToggleRuleSetInput!	Rule-set identity and desired enabled state.

totpDisable

Type: TotpStatusPayload!

Disables TOTP after verifying the current TOTP code.

Arguments

Name	Description
input TotpVerifyInput!	Current TOTP code required to disable TOTP.

totpEnrollmentComplete

Type: TotpEnrollmentCompletePayload!

Completes TOTP enrollment with the one-time challenge code and returns status plus recovery codes.

Arguments

Name	Description
input TotpEnrollmentCompleteInput!	Enrollment challenge ID and current TOTP code.

totpEnrollmentStart

Type: TotpEnrollmentStartPayload!

Starts TOTP enrollment for the authenticated session or MFA-enrollment session.

totpRegenerateRecoveryCodes

Type: TotpEnrollmentCompletePayload!

Regenerates recovery codes after verifying TOTP; returned codes are one-time secrets.

Arguments

Name	Description
input TotpVerifyInput!	Current TOTP code required to generate a new recovery-code set.

triggerAcquisitionSearch

Type: AcquisitionSearchJobPayload!

Start a background acquisition search for the selected wanted or upgrade scopes.

Arguments

Name	Description
input TriggerAcquisitionSearchInput!	Optional wanted-kind, facet, library, title, season, and item filters; an empty library list includes all permitted libraries.

triggerJob

Type: JobRunPayload!

Start the configured background job and return its accepted run snapshot.

Arguments

Name	Description
jobKey JobKeyValue!	Job key identifying the server-side job to start.

triggerRssSync

Type: RssSyncReportPayload!

Run RSS synchronization for accessible indexers and return its report.

triggerTitleMismatchRecoverySearch

Type: TriggerTitleMismatchRecoverySearchPayload!

Reopen title-mismatch scopes after a rematch so acquisition coverage can converge again.

Arguments

Name	Description
titleId ID!	Title identity whose changed match scopes should be searched again.

uninstallPlugin

Type: UninstallPluginPayload!

Uninstall a plugin and remove its installation record.

Arguments

Name	Description
pluginId ID!	Installed plugin ID to remove.

uninstallTrackedRulePack

Type: DeleteTrackedRulePackPayload!

Uninstall a tracked rule pack and its owned rules.

Arguments

Name	Description
packId String!	Installed rule-pack ID to remove.
revision Long!	Current pack revision required for this mutation.

unlinkExternalAccount

Type: UnlinkExternalAccountPayload!

Unlinks the external account identified by linked_account_id.

Arguments

Name	Description
linkedAccountId ID!	ID of the linked external account to remove.

updateAcquisitionSettings

Type: AcquisitionSettingsPayload!

Saves acquisition thresholds and polling intervals after checking the catalog-settings permission.

Arguments

Name	Description
input UpdateAcquisitionSettingsInput!	Acquisition settings with hour, second, day, count, and score values validated by the application.

updateAutoBackupSettings

Type: AutoBackupSettingsPayload!

Saves auto-backup scheduling and key changes after checking the system-settings permission.

Arguments

Name	Description
input UpdateAutoBackupSettingsInput!	Auto-backup settings; key fields change or clear the stored secret according to their flags.

updateBackupSettings

Type: BackupSettingsPayload!

Saves the custom backup path after checking the system-settings permission.

Arguments

Name	Description
input UpdateBackupSettingsInput!	Backup path settings to save.

updateDownloadClientConfig

Type: DownloadClientConfigPayload!

Patch a download-client configuration while preserving omitted provider secrets.

Arguments

Name	Description
input UpdateDownloadClientConfigInput!	Download-client identity and optional replacement fields; omitted provider secrets remain stored.

updateDownloadClientRouting

Type: [DownloadClientRoutingEntryPayload!]!

Replaces download-client routing entries for one content scope after authorization.

Arguments

Name	Description
input UpdateDownloadClientRoutingInput!	Content scope and complete routing entry list; an empty list clears entries for that scope.

updateGeneralSettings

Type: GeneralSettingsPayload!

Saves general system settings after checking the system-settings permission.

Arguments

Name	Description
input UpdateGeneralSettingsInput!	General settings including history retention, image-cache size in MB, and plugin CA bundle text.

updateIndexerConfig

Type: IndexerConfigPayload!

Patch an indexer configuration while preserving omitted fields and stored secrets.

Arguments

Name	Description
input UpdateIndexerConfigInput!	Indexer configuration identity and optional replacement fields; omitted provider secrets remain stored.

updateIndexerRouting

Type: [IndexerRoutingEntryPayload!]!

Replaces indexer routing entries for one content scope after authorization.

Arguments

Name	Description
input UpdateIndexerRoutingInput!	Content scope and complete routing entry list; an empty list clears entries for that scope.

updateLibrary

Type: LibraryPayload!

Patch a library while preserving omitted fields.

Arguments

Name	Description
input UpdateLibraryInput!	Library identity and optional replacement name, roots, or settings.

updateLibraryPaths

Type: LibraryPathsPayload!

Replace nonblank default library roots for movie, series, and anime facets.

Arguments

Name	Description
input UpdateLibraryPathsInput!	Default facet root paths; blank movie or series values and a null or blank anime value leave that facet unchanged.

updateMaintenanceRuleMatcher

Type: MaintenanceRuleSetDetail!

Replace a rule set’s matcher, action, and grace period by appending a revision.

Arguments

Name	Description
input UpdateMaintenanceRuleMatcherInput!	Rule-set identity, replacement matcher source and action, and optional grace period.

updateMaintenanceRuleMetadata

Type: MaintenanceRuleSet!

Rename and re-scope a rule set without touching its matcher, so no revision is created.

Arguments

Name	Description
input UpdateMaintenanceRuleMetadataInput!	Rule-set identity, replacement name, and optional description and library scope.

updateMediaServerConnection

Type: MediaServerConnectionPayload!

Patches a media-server connection by ID, leaving omitted fields unchanged and honoring explicit clear flags for secrets.

Arguments

Name	Description
input UpdateMediaServerConnectionInput!	Connection ID and optional patch fields; omitted fields remain unchanged and clear flags remove stored secrets.

updateMediaSettings

Type: MediaSettingsPayload!

Saves media settings for one content scope, with nullable fields passed through as application update semantics.

Arguments

Name	Description
input UpdateMediaSettingsInput!	Content scope and settings update; absent or null optional fields keep their current values, while supplied empty lists are applied as empty.

updateMyMediaRequest

Type: MediaRequestPayload!

Update the caller’s pending request preferences and return the current request.

Arguments

Name	Description
input UpdateMediaRequestInput!	Request identity and the replacement quality and monitoring preferences.

updateNotificationChannel

Type: NotificationChannelPayload!

Patch a notification channel while preserving omitted fields and provider secrets.

Arguments

Name	Description
input UpdateNotificationChannelInput!	Channel identity and optional replacement fields; omitted provider secrets remain stored and null clears the media-server link.

updateNotificationSubscription

Type: NotificationSubscriptionPayload!

Patch a notification subscription while preserving omitted fields.

Arguments

Name	Description
input UpdateNotificationSubscriptionInput!	Subscription identity and optional target, event, scope, or enabled-state replacements.

updateOauthClientRegistration

Type: OauthClientRegistrationPayload!

Replaces custom OAuth application metadata and callback allowlist. Disabling revokes all of its grants.

Arguments

Name	Description
clientId String!	Immutable client identifier returned during registration.
input UpdateOAuthClientRegistrationInput!	Replacement public-client configuration.

updatePluginAutoUpdateSettings

Type: PluginAutoUpdateSettingsPayload!

Saves the automatic official-plugin patch update setting after checking the system-settings permission.

Arguments

Name	Description
input UpdatePluginAutoUpdateSettingsInput!	Whether the scheduled plugin catalog refresh installs official patch updates automatically.

updatePostProcessingScript

Type: PostProcessingScriptPayload!

Update selected fields of a post-processing script and revalidate changed executable content.

Arguments

Name	Description
input UpdatePostProcessingScriptInput!	Script identity and optional fields to replace; omitted fields retain their values.

updateProxyConfig

Type: ProxyConfigPayload!

Patch a proxy configuration while preserving omitted fields.

Arguments

Name	Description
input UpdateProxyConfigInput!	Proxy configuration identity and optional replacement fields.

updateRecycleBinSettings

Type: RecycleBinSettingsPayload!

Saves recycle-bin settings after checking the system-settings permission.

Arguments

Name	Description
input UpdateRecycleBinSettingsInput!	Recycle-bin settings to save.

updateRequestRuleMatcher

Type: RequestRuleSetDetail!

Replace a rule set’s matcher by appending revision N+1.

Revision N is left exactly as written, so a decision recorded against it stays attributable.

Arguments

Name	Description
input UpdateRequestRuleMatcherInput!	Rule-set identity and the replacement matcher source.

updateRequestRuleMetadata

Type: RequestRuleSet!

Rename and re-scope a rule set without touching its matcher, so no revision is created.

Arguments

Name	Description
input UpdateRequestRuleMetadataInput!	Rule-set identity, replacement name, and optional description and library scope.

updateRuleSet

Type: RuleSetPayload!

Patch a rule set while preserving omitted fields.

Arguments

Name	Description
input UpdateRuleSetInput!	Rule-set identity and optional replacement source, metadata, facet scope, priority, or managed tag filter.

updateSecuritySettings

Type: SecuritySettingsPayload!

Saves security and MFA requirements, applies effective login state, and revokes authless OAuth refresh grants when login becomes enabled.

Arguments

Name	Description
input UpdateSecuritySettingsInput!	Security settings with password length and MFA requirements validated by the application.

updateSeedingProfile

Type: SeedingProfilePayload!

Patch a torrent seeding profile.

Arguments

Name	Description
input UpdateSeedingProfileInput!	Seeding profile identity and optional replacement fields; explicit nulls clear goals.

updateSeriesMovieTags

Type: [SeriesMovieLinkPayload!]!

Adds and/or removes user tags across a set of series movies.

Series-movie tags live on the link rather than on a title, so this is a separate mutation from updateTitleTags. The rules are the same ones: labels must already exist in the title-tag registry, they are normalized before they are stored, removals are applied before additions, and every link’s series is checked for title-management rights before the first write.

Arguments

Name	Description
input UpdateSeriesMovieTagsInput!	Series movies to patch plus the labels to add and remove.

updateServiceSettings

Type: ServiceSettingsPayload!

Saves service TLS paths after checking the system-settings permission.

Arguments

Name	Description
input UpdateServiceSettingsInput!	TLS certificate and key paths to save.

updateSubtitleProviderConfig

Type: SubtitleProviderConfigPayload!

Patch a subtitle-provider configuration while preserving omitted fields and secrets.

Arguments

Name	Description
input UpdateSubtitleProviderConfigInput!	Subtitle-provider identity and optional replacement fields; omitted secrets remain stored.

updateSubtitleSettings

Type: SubtitleSettingsPayload!

Saves subtitle preferences after checking the catalog-settings permission.

Arguments

Name	Description
input UpdateSubtitleSettingsInput!	Subtitle settings to validate and save; language flags default to false when omitted.

updateTitle

Type: TitlePayload!

Patch title metadata and settings while preserving omitted fields.

Arguments

Name	Description
input UpdateTitleInput!	Title identity and optional metadata or tri-state settings changes.

updateTitleTagDefinition

Type: TitleTagDefinitionMutationPayload!

Renames or re-describes a title tag after checking the catalog-settings permission.

A rename rewrites every title and delay profile carrying the old label. Rule sources are immutable and are never rewritten, so the returned counts name how many rules referenced the old label and will stop matching.

Arguments

Name	Description
input UpdateTitleTagDefinitionInput!	Tag identity plus the replacement label or description; omitted fields keep their current values.

updateTitleTags

Type: [TitlePayload!]!

Add and remove user tags across a set of titles, returning the updated titles.

A patch, not a replacement: reserved scryer: settings entries are left exactly as they were, and the merge happens inside the store transaction so a concurrent title-settings save cannot clobber it. Every title’s library is authorized before the first write, so a set containing one title the caller cannot manage changes nothing at all.

Arguments

Name	Description
input UpdateTitleTagsInput!	Titles to patch and the tag labels to add and remove.

updateTrackedRulePack

Type: TrackedRulePackPayload!

Apply a previously reviewed immutable source version to a tracked rule pack.

Arguments

Name	Description
packId String!	Installed rule-pack ID to update.
version String!	Reviewed immutable source version.
digest String!	Verified digest for the reviewed source version.
revision Long!	Revision returned by the update preview.

updateVerificationSettings

Type: VerificationSettingsPayload!

Saves the verification depth applied to download-client completed-download copies, after checking the system-settings permission. Location operations always verify in full and ignore it.

Arguments

Name	Description
input UpdateVerificationSettingsInput!	Verification depth to save.

upsertDelayProfile

Type: DelayProfilePayload!

Creates or updates a delay profile after checking the catalog-settings permission.

Arguments

Name	Description
input DelayProfileInput!	Delay profile; delay and age values are expressed in minutes and the ID selects create versus update.

validateExternalImportConnection

Type: ExternalImportConnectionValidationPayload!

Test one Sonarr, Radarr, or Prowlarr connection without starting a full warmup.

Arguments

Name	Description
input ValidateExternalImportConnectionInput!	External application kind and connection credentials to validate.

validateMaintenanceRule

Type: MaintenanceRuleValidationPayload!

Compile and check maintenance rule source without saving it.

Arguments

Name	Description
input ValidateMaintenanceRuleInput!	Matcher source to validate.

validateRequestRule

Type: RequestRuleValidationPayload!

Compile and check request rule source without saving it.

Arguments

Name	Description
input ValidateRequestRuleInput!	Matcher source to validate.

validateRuleSet

Type: RuleValidationResultPayload!

Validate rule source without saving it, using a supplied or temporary rule identity.

Arguments

Name	Description
input ValidateRuleSetInput!	Rule source and optional rule-set identity used for validation.

webauthnAuthenticateComplete

Type: LoginPayload!

Completes passkey authentication and issues a login payload without exposing the credential response.

Arguments

Name	Description
input WebauthnCompleteInput!	Challenge ID and WebAuthn assertion response from the authentication start request.

webauthnAuthenticateStart

Type: WebauthnChallengePayload!

Starts passkey authentication, masking failures when form login is enabled.

Arguments

Name	Description
username String	Optional compatibility hint that is not used to select or reveal an account; passkeys always start discoverable authentication.

webauthnLoginEnrollmentComplete

Type: LoginPasskeyEnrollmentCompletePayload!

Completes passkey enrollment for a restricted post-primary MFA-enrollment session and issues a full session.

Arguments

Name	Description
input WebauthnRegisterCompleteInput!	Passkey registration challenge and browser response for login enrollment.

webauthnLoginEnrollmentStart

Type: WebauthnChallengePayload!

Starts passkey enrollment for a restricted post-primary MFA-enrollment session.

webauthnRegisterComplete

Type: PasskeySummaryPayload!

Completes passkey registration using the authorized enrollment challenge.

Arguments

Name	Description
input WebauthnRegisterCompleteInput!	Challenge ID and WebAuthn response used to complete the pending registration.

webauthnRegisterStart

Type: WebauthnChallengePayload!

Starts passkey registration and returns a short-lived challenge without credential material.