Input objects

AddTitleInput

Metadata and acquisition settings for creating a title.

Arguments

Name	Description
name String!	Display name of the title.
facet MediaFacetValue!	Media facet, such as movie, series, or anime.
libraryId ID	Library identity receiving the title; null lets the server resolve the default behavior.
monitored Boolean!	Whether the title starts monitored.
tags [String!]!	Tag values attached to the title.
options TitleOptionsInput	Optional title settings to apply at creation.
externalIds [ExternalIdInput!]	External provider identifiers for the title.
smgId Int	SMG canonical movie title ID, when supplied by metadata search.
tvdbId String	TVDB title ID, when supplied by metadata search.
tmdbId Int	TMDB title ID, when supplied by metadata search.
imdbId String	IMDb title ID, when supplied by metadata search.
sourceHint String	Download source locator, such as an NZB URL or magnet URI, used when queuing the title.
sourceKind DownloadSourceKindValue	Optional source category for the title.
sourceTitle String	Optional source release title.
minAvailability String	Optional minimum availability value used by acquisition logic.
year Int	Release year when known.
overview String	Plot summary when known.
sortTitle String	Sort key for title ordering.
slug String	URL-safe title slug.
runtimeMinutes Int	Runtime in minutes.
language String	Metadata language code.
contentStatus String	Provider content-status label.

ApplyTitleFolderChangeInput

Request applying a folder-match correction.

Arguments

Name	Description
titleId ID!	Title whose folder match changes.
folderPath String!	Chosen folder, which must be inside one of the title's library roots.
resolution FolderMatchResolutionValue	How to settle ownership. Defaults to ASSIGN, which is refused when another title already owns the folder.

ApproveMediaRequestInput

Approval choices for a media request.

Arguments

Name	Description
requestId ID!	Media request identity to approve.
qualityProfileId ID!	Quality profile identity to apply to the approved title.
monitorType MonitorTypeValue	Optional monitoring policy to apply to the approved title.
monitorSelection MonitorSelectionInput	Optional approver override for the requested advanced selection; when omitted the request's stored selection is applied.
leaseDays Int	Approver override for the lease, in days. Omitting both this and leaseForever grants exactly what the requester asked for.
leaseForever Boolean	Set to true to grant the title forever regardless of what was asked. Rejected together with leaseDays.
tags [String!]	Approver override for the policy tags stamped on the created title. A supplied list replaces the policy's tags outright; omitting it keeps them.

AssignTrackedDownloadTitleInput

Assigns a tracked download to a title and an explicit acquisition scope.

Arguments

Name	Description
clientId ID	Download-client ID, or null when the provider identity is sufficient.
clientType String!	Download-client provider type.
downloadClientItemId String!	Provider-issued download item ID.
titleId ID!	Target title ID.
scope QueueDownloadScopeInput!	Target scope within the title.

BeginManualImportSelectionInput

Download identity used to build a manual-import preview.

Arguments

Name	Description
clientId ID!	Configured download-client identity.
clientType String!	Download-client provider type.
downloadClientItemId String!	Provider-specific download item identity.
titleId ID!	Title identity used to suggest import targets.
extractArchives Boolean	Explicitly extract an archive-only download before building the preview.

BindPendingImportInput

Binds one pending import to an optional collection and episode IDs.

Arguments

Name	Description
pendingImportId ID!	Pending-import item ID.
collectionId ID	Collection ID, or null when binding episodes directly.
episodeIds [ID!]!	Episode IDs to bind; empty means no explicit episode list.

BlocklistExternalSubtitleInput

Identifies a provider-backed subtitle to delete and add to the subtitle blocklist.

Arguments

Name	Description
externalSubtitleId ID!	External subtitle file ID to delete and blocklist.
reason String	Optional operator-supplied reason stored with the blocklist entry.
previewFingerprint String	Fingerprint returned by the required deletion preview.
typedConfirmation String	Required confirmation text when the preview reports a protected deletion.

CatalogDiscoveryInput

Controls catalog discovery for one required media facet and optional library scope.

Arguments

Name	Description
facet MediaFacetValue!	Required media facet whose catalog is searched.
libraryIds [ID!]	Library IDs defining the owned scope; omitted or empty means no explicit library restriction.
includeUnresolved Boolean	Include unresolved discovery records; defaults to true.
limitPerGroup Int	Maximum items per result group; defaults to 12 and values below 1 become 1.
maxGroups Int	Maximum number of groups; defaults to 6 and values below 1 become 1.

ChangeTitleFolderPreviewInput

Request describing a proposed folder-match correction; changes nothing.

Arguments

Name	Description
titleId ID!	Title whose folder match would change.
folderPath String!	Candidate folder, which must be inside one of the title's library roots.

CompleteRequiredPasswordChangeInput

New password selected after signing in with an administrator-provided temporary password.

Arguments

Name	Description
password String!	New password; stored securely and never returned.

ConvertTitleClaimToPermanentInput

Replaces a live claim with a permanent operator keep. The original stays as history in the CONVERTED state.

Arguments

Name	Description
claimId ID!	Claim to convert.

CreateBackupInput

Password used to encrypt a new backup.

Arguments

Name	Description
password String!	Encryption password; it is not returned in backup metadata.

CreateDownloadClientConfigInput

Configuration for a new download client.

Arguments

Name	Description
name String!	Display name of the client.
clientType String!	Download-client provider implementation identifier.
config [ProviderConfigValueInput!]!	Provider configuration values, including secret fields.
proxyConfigId ID	Proxy to carry this client's traffic. Any proxy kind is accepted, and the proxy must exist and be enabled.
isEnabled Boolean	Whether the client is enabled.

CreateExternalAccountInviteInput

Invitation linking a user to an external provider account.

Arguments

Name	Description
userId ID!	User identity receiving the invitation.
connectionId ID!	External authentication connection identity.
provider ExternalAccountProviderValue!	Provider represented by the connection.
providerUserIdentifier String!	Provider-side user identifier used to match the account.
providerUserId String	Optional provider-native user id.

CreateIndexerConfigInput

Configuration for a new indexer provider.

Arguments

Name	Description
name String!	Display name of the indexer.
providerType String!	Provider implementation identifier.
proxyConfigId ID	Optional proxy configuration identity.
downloadClientId ID	Optional download-client identity used for routed grabs.
rateLimitSeconds Int	Rate-limit interval in seconds.
rateLimitBurst Int	Maximum requests allowed in one rate-limit burst.
isEnabled Boolean	Whether the indexer is enabled.
enableInteractiveSearch Boolean	Whether interactive searches use this indexer.
enableAutoSearch Boolean	Whether automatic searches use this indexer.
config [ProviderConfigValueInput!]	Provider configuration values, including secret fields.

CreateLibraryInput

New media library definition.

Arguments

Name	Description
facet MediaFacetValue!	Media facet stored in the library.
name String!	Library display name.
roots [CreateLibraryRootInput!]!	Root paths owned by the library.
settings LibrarySettingsInput	Optional library acquisition and import settings.

CreateLibraryRootInput

New library root path and default marker.

Arguments

Name	Description
path String!	Absolute filesystem path for the root.
isDefault Boolean!	Whether this root is the library default.

CreateMaintenanceRuleSetInput

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

Arguments

Name	Description
subjectKind MaintenanceRuleSubjectKind	Defaults to title scope when omitted.
name String!	Rule-set name.
description String	Optional description.
regoSource String!	Matcher source as written in the editor. The package declaration is applied by the server.
action MaintenanceActionInput	Legacy action the first revision authorizes. Supply this or actionSequence, never both.
actionSequence MaintenanceActionSequenceInput	Ordered actions the first revision authorizes. Supply this or action, never both.
graceDays Int	Days a subject must match continuously before the action becomes due; defaults to zero.
libraryIds [String!]	Libraries to confine the rule to. Omitted or empty means every library.
storageRootId String	Configured library root whose capacity and owned files this revision uses. Required when the matcher reads a storage fact.

CreateMediaServerConnectionInput

Configuration and credentials for a new media-server connection.

Arguments

Name	Description
provider MediaServerProviderValue!	Media-server provider type.
displayName String!	Display name for the connection.
baseUrl String!	Server base URL.
externalUrl String	Browser-facing URL used for playback deep links. Omit to disable deep links for Jellyfin and Emby.
enabled Boolean	Whether the connection is enabled, defaulting to true.
loginEnabled Boolean	Whether login through the server is enabled, defaulting to false.
linkingEnabled Boolean	Whether account linking is enabled, defaulting to false.
autoAddEnabled Boolean	Whether automatic account addition is enabled, defaulting to false.
defaultAppPermissions [AppPermissionValue!]	Default application permissions for auto-added users.
defaultLibraryGrants [MediaServerDefaultLibraryGrantInput!]	Default library grants for auto-added users.
machineId String	Provider machine identity, when required.
plexAuthToken String	Plex authentication token; stored as a secret and not returned.
plexServerId String	Plex server identity.
apiKey String	Provider API key; stored as a secret and not returned.
adminUsername String	Provider administrator username.
adminPassword String	Provider administrator password; stored as a secret and not returned.
embyConnectionMode EmbyConnectionModeValue	Address-selection mode used for the Emby connection.
embyLocalSetupMethod EmbyLocalSetupMethodValue	Credential flow used to configure a local Emby server.
embyConnectEnabled Boolean	Whether Emby Connect is enabled.
embyConnectUsernameOrEmail String	Emby Connect account name used to authenticate the connection.
embyConnectPassword String	Emby Connect password; stored as a secret and not returned.
embyConnectServerId String	Emby Connect server identity.
pathMappings [MediaServerPathMappingInput!]	External-to-local filesystem path mappings.

CreateMyApiKeyInput

Input for creating an API key owned by the interactive actor.

Arguments

Name	Description
label String!	A human-readable label to distinguish the integration.
expiry ApiKeyExpiryPresetValue	Expiration policy. Omission uses 90 days.

CreateNotificationChannelInput

Values required to create a notification channel.

Arguments

Name	Description
name String!	Channel display name.
channelType String!	Provider channel type.
config [ProviderConfigValueInput!]!	Channel configuration values; secret values are stored securely.
mediaServerConnectionId ID	Media-server connection ID for channel providers that use one.
isEnabled Boolean	Whether the new channel starts enabled; omitted uses the service default.

CreateNotificationSubscriptionInput

Values required to subscribe a notification channel to an event target.

Arguments

Name	Description
channelId ID	Notification channel ID, or null for target-only event handling.
targetKind String	Target category, or null when the event is not target-specific.
targetId ID	Target ID, or null when the event is not target-specific.
eventType String!	Event type that triggers delivery.
scope String!	Scope category used to limit matching events.
scopeId String	Scope key, or null for a global scope.
isEnabled Boolean	Whether the new subscription starts enabled; omitted uses the service default.

CreateOAuthClientRegistrationInput

Custom public OAuth application details. Authorization-code plus S256 PKCE is required.

Arguments

Name	Description
displayName String!	Name displayed to users during authorization.
redirectUris [String!]!	Exact HTTPS callback URLs permitted for this application.
kind OauthClientKindValue	What the application is for. Omission registers a generic CUSTOM application.

CreatePostProcessingScriptInput

Values required to create a post-processing script.

Arguments

Name	Description
name String!	Script display name.
description String	Script description, or null for no description.
scriptType String!	Script source type.
scriptContent String	Script content, or null when supplied by the selected script type.
inlineShellAcknowledged Boolean	Explicit acknowledgement that inline shell executes with application privileges.
appliedFacets [String!]	Media facets to process, or null for the service default.
executionMode ExecutionModeValue	Execution mode, or null for the service default.
timeoutSecs Int	Maximum runtime in seconds, or null for the service default.
priority Int	Relative execution priority, or null for the service default.
debug Boolean	Whether debug output is enabled, or null for the service default.

CreateProxyConfigInput

Configuration for a proxy provider.

Arguments

Name	Description
name String!	Display name of the proxy.
providerType String!	Proxy provider identifier: byparr, trawl, http, http3, socks4, socks5, ssh_tunnel, or wireguard.
protocol String	Challenge-solver protocol. Omit to take the single protocol Scryer speaks; transport proxies reject any value because they speak none.
baseUrl String!	Proxy base URL.
requestTimeoutSeconds Int	Request timeout in seconds.
username String	Transport-proxy username. Write-only: stored encrypted and never read back. Challenge solvers reject it.
password String	Transport-proxy password. Write-only: stored encrypted and never read back. Requires a username; challenge solvers and SSH tunnels reject it.
remoteDns Boolean	SOCKS5 only: resolve destination hostnames at the proxy. A socks5h:// base URL implies true.
privateKey String	Private key for a tunnel provider: PEM for an SSH tunnel, base64 for WireGuard. Write-only: stored encrypted and never read back. An SSH tunnel and WireGuard both require a private key.
privateKeyPassphrase String	Passphrase protecting the private key above. Write-only: stored encrypted and never read back. Requires a private key, and only SSH tunnels accept one.
peerPublicKey String	WireGuard peer public key, from the [Peer] section. Required for WireGuard and rejected by every other provider. Not a secret: it is read back in full.
presharedKey String	Optional WireGuard preshared key. Write-only: stored encrypted and never read back. Only WireGuard accepts it.
tunnelAddresses [String!]	WireGuard interface addresses, from the [Interface] Address line. At least one is required for WireGuard; a single comma-separated entry is also accepted. Only WireGuard accepts them.
tunnelDnsServers [String!]	WireGuard resolvers, from the [Interface] DNS line. Optional; without them a destination must be addressed by IP. Only WireGuard accepts them.
tunnelMtu Int	WireGuard tunnel MTU. Omit to use the engine's default. Only WireGuard accepts it.
tunnelKeepaliveSeconds Int	WireGuard persistent keepalive in seconds. Omit to use the engine's default; zero switches keepalive off. Only WireGuard accepts it.
isEnabled Boolean	Whether the proxy is enabled.

CreateRequestRuleSetInput

Creates a request rule set together with its first matcher revision. The rule set is always created disabled; arming it is a second, deliberate call.

Arguments

Name	Description
name String!	Rule-set name.
description String	Optional description.
regoSource String!	Matcher source as written in the editor. The package declaration is applied by the server.
libraryIds [String!]	Libraries to confine the rule to. Omitted or empty means every library.

CreateRuleSetInput

Creates a user-authored Rego rule set.

Arguments

Name	Description
name String!	Rule-set name.
description String	Optional description.
regoSource String!	Complete Rego module evaluated for this rule set.
appliedFacets [String!]	Optional media facets.
priority Int	Optional evaluation priority.
enabled Boolean	Optional enabled state.

CreateSeedingProfileInput

Goals and removal behavior for a new seeding profile.

Arguments

Name	Description
name String!	Seeding profile name; must be unique.
ratio Float	Share ratio goal, or null to defer to the download client's own limits.
seedTimeMinutes Int	Seed time goal in minutes, or null to defer to the download client's own limits.
seasonPackMode SeasonPackSeedModeValue	Whether season packs inherit or override the profile's goals; defaults to inherit.
seasonPackRatio Float	Season-pack share ratio goal; only applied in override mode.
seasonPackSeedTimeMinutes Int	Season-pack seed time goal in minutes; only applied in override mode.
honorTrackerMinimums Boolean	Whether resolved goals are raised to tracker-declared minimums; defaults to true.
goalMetAction SeedGoalMetActionValue	Action taken once the goal is met; defaults to removing the entry.
neverRemove Boolean	Whether torrents grabbed under this profile are never auto-removed; defaults to false.
minimumSeeders Int	Fewest seeders a candidate may report and still be grabbed. Null inherits the system floor; 0 disables the check.
postImportTracking PostImportTrackingValue	Whether Scryer keeps managing torrents after import; defaults to parking them.

CreateSubtitleProviderConfigInput

Configuration for a new subtitle provider.

Arguments

Name	Description
name String!	Display name of the provider.
providerType String!	Subtitle provider implementation identifier.
config [ProviderConfigValueInput!]!	Provider configuration values, including secret fields.
enabledFacets [MediaFacetValue!]	Facets for which the provider is enabled.
isEnabled Boolean	Whether the provider is enabled.

CreateTitleTagDefinitionInput

New title tag to define.

Arguments

Name	Description
label String!	Label to define; trimmed, lowercased, and whitespace-collapsed before it is stored, and rejected when it uses the reserved scryer: prefix.
description String	Optional operator-facing note about what the tag is for.

CreateUserInput

New user account and permission grants.

Arguments

Name	Description
username String!	Login username.
password String!	Temporary password; the user must replace it after local-password sign-in.
appPermissions [AppPermissionValue!]!	Application permissions granted to the user.
libraryPermissions [LibraryPermissionGrantInput!]!	Library permissions granted to the user.

DelayProfileInput

Delay and routing policy for a download source.

Arguments

Name	Description
id ID!	Existing delay-profile identity to update.
name String!	Display name of the delay profile.
usenetDelayMinutes Int!	Usenet delay in minutes.
torrentDelayMinutes Int!	Torrent delay in minutes.
enableUsenet Boolean	Whether Usenet releases are eligible. Defaults to enabled for existing clients.
enableTorrent Boolean	Whether torrent releases are eligible. Defaults to enabled for existing clients.
preferredProtocol DelayProfilePreferredProtocolValue!	Preferred protocol when both delayed sources qualify.
minAgeMinutes Int!	Minimum release age in minutes.
bypassScoreThreshold Int	Optional score threshold that bypasses the delay.
bypassIfHighestQuality Boolean	Whether the highest-quality release bypasses its eligible delay. Defaults to disabled.
appliesToFacets [MediaFacetValue!]!	Facets to which the profile applies.
tags [String!]!	Tags restricting the profile's scope.
priority Int!	Relative priority among delay profiles.
enabled Boolean!	Whether this delay profile is active.

DeleteBackupInput

Backup filename to remove.

Arguments

Name	Description
filename String!	Existing backup filename.

DeleteDownloadInput

Identity and history behavior for deleting a tracked download.

Arguments

Name	Description
clientId ID	Download-client identity, when the item is scoped to a configured client.
clientType String!	Download-client provider type.
downloadClientItemId String!	Provider-specific download item identity.
isHistory Boolean!	Whether deletion should use the provider's history path.

DeleteEpisodeFilesInput

Destructive deletion request for the media files of selected episodes.

Arguments

Name	Description
titleId ID!	Title identity owning the episodes.
episodeIds [ID!]!	Episode identities whose media files are deleted.
deleteFromDisk Boolean	Whether the files are removed from disk.
previewFingerprint String	Aggregate preview fingerprint required to confirm the current deletion target.
typedConfirmation String	Required typed confirmation for large destructive deletions.

DeleteEpisodeFilesPreviewInput

Input for previewing deletion of the media files of selected episodes.

Arguments

Name	Description
titleId ID!	Title identity owning the episodes.
episodeIds [ID!]!	Episode identities whose media files would be deleted.

DeleteExternalSubtitleInput

Identifies an external subtitle deletion and its optional destructive-action confirmation.

Arguments

Name	Description
externalSubtitleId ID!	External subtitle file ID to delete.
previewFingerprint String	Fingerprint returned by the required deletion preview.
typedConfirmation String	Required confirmation text when the preview reports a protected deletion.

DeleteMediaFileInput

Destructive deletion request for one media file.

Arguments

Name	Description
fileId ID!	Media-file identity to delete.
deleteFromDisk Boolean	Whether the file is removed from disk.
previewFingerprint String	Preview fingerprint required to confirm the current deletion target.
typedConfirmation String	Required typed confirmation for destructive deletion.

DeleteRecycledItemsInput

Recycle-bin entries to delete permanently.

Arguments

Name	Description
ids [ID!]!	Recycle-bin entry IDs to delete.

DeleteTitleInput

Destructive deletion request for one title.

Arguments

Name	Description
titleId ID!	Title identity to delete.
deleteFilesOnDisk Boolean	Whether associated media files are removed from disk.
previewFingerprint String	Preview fingerprint required to confirm the current deletion target.
typedConfirmation String	Required typed confirmation for destructive deletion.

DeleteTitlesInput

Destructive deletion request for multiple titles.

Arguments

Name	Description
items [DeleteTitlesItemInput!]!	Title deletion items with per-title preview fingerprints.
deleteFilesOnDisk Boolean	Whether associated media files are removed from disk.
typedConfirmation String	Required typed confirmation for destructive deletion.

DeleteTitlesItemInput

One title identity and its preview fingerprint for bulk deletion.

Arguments

Name	Description
titleId ID!	Title identity to delete.
previewFingerprint String	Preview fingerprint required to confirm this title's current deletion target.

DeleteTitlesPreviewInput

Input for generating deletion previews for selected titles.

Arguments

Name	Description
titleIds [ID!]!	Title identities to include in the preview.

DiscoverEmbyConnectServersInput

Credentials used to discover Emby Connect servers.

Arguments

Name	Description
usernameOrEmail String!	Emby Connect username or email.
password String!	Emby Connect password.

DiscoveryHomeFilterOptionsInput

Selects public, personalized, and unresolved discovery sources for filter-option lookup.

Arguments

Name	Description
includePublic Boolean	Include public filter options; defaults to true when omitted.
includePersonalized Boolean	Include personalized filter options when authorized; defaults to true when omitted.
includeUnresolved Boolean	Include unresolved items in option generation; defaults to false when omitted.

DiscoveryHomeFiltersInput

Filters for discovery home items; omitted lists are treated as empty filters.

Arguments

Name	Description
contentTypes [MediaFacetValue!]	Restrict results to these media facets; omitted includes all facets.
genreTagKeys [String!]	Canonical genre tag keys to include; blank keys are invalid.
themeTagKeys [String!]	Canonical theme tag keys to include; blank keys are invalid.
studioSlugs [String!]	Studio slugs to include; omitted applies no studio restriction.
minimumYear Int	Inclusive minimum release year, if supplied.
maximumYear Int	Inclusive maximum release year, if supplied.
minimumRating Float	Inclusive rating floor on a finite 0 through 10 scale.

DiscoveryHomeInput

Controls which discovery home surfaces are included and how many items each section may contain.

Arguments

Name	Description
includePublic Boolean	Include public discovery sections; defaults to true when omitted.
includePersonalized Boolean	Include personalized sections when the caller is authorized; defaults to true when omitted.
includeUnresolved Boolean	Include unresolved external discovery items; defaults to false when omitted.
limitPerSection Int	Maximum items per section; defaults to 25 and must be between 1 and 100.
filters DiscoveryHomeFiltersInput	Optional content, tag, studio, year, and rating filters.

DiscoveryItemDetailInput

Identifies one discovery item and controls whether unresolved records may be returned.

Arguments

Name	Description
targetKey String!	Stable discovery target key, not a local title ID.
includeUnresolved Boolean	Include the unresolved record when no local title is resolved; defaults to true.

DiscoveryItemsInput

Filters and paginates the general discovery-item listing.

Arguments

Name	Description
query String	Free-text query applied to discovery titles and searchable metadata.
targetKinds [String!]	Target-kind values to include; omitted uses no target-kind filter.
sources [String!]	Source identifiers to include; omitted uses all available sources.
relationTypes [String!]	Relation types to include; omitted applies no relation-type filter.
relationSubtypes [String!]	Relation subtypes to include; omitted applies no relation-subtype filter.
genres [String!]	Genre values to include; omitted applies no genre filter.
statusTags [String!]	Status tags to include; omitted applies no status-tag filter.
facetTerms [String!]	Facet terms to include; omitted applies no facet-term filter.
includeOwned Boolean	Include items already owned in the caller's libraries; defaults to false.
includeUnresolved Boolean	Include unresolved items; defaults to false.
includePublic Boolean	Include public-source items; defaults to false.
limit Int	Page size; defaults to 50 and values below 1 become 1.
offset Int	Zero-based offset; defaults to 0 and negative values become 0.

DownloadClientApiKeyOverrideInput

API key override for a masked download-client candidate.

Arguments

Name	Description
dedupKey String!	Stable candidate identity used to apply the override.
apiKey String!	Replacement API key.

DownloadClientPasswordOverrideInput

Password override for a masked download-client candidate.

Arguments

Name	Description
dedupKey String!	Stable candidate identity used to apply the override.
password String!	Replacement password.

DownloadClientRoutingEntryInput

Routing settings for one download client.

Arguments

Name	Description
clientId ID!	Download-client identity.
enabled Boolean!	Whether this client participates in routing.
category String	Optional category sent to the client.
recentQueuePriority String	Priority label for recent queue items.
olderQueuePriority String	Priority label for older queue items.
removeCompleted Boolean!	Whether completed items are removed from the client.
removeFailed Boolean!	Whether failed items are removed from the client.
seedingProfileId ID	Optional seeding profile ID applied to torrents routed to this client.

DownloadSubtitleInput

Identifies a provider result and its matching metadata for subtitle download.

Arguments

Name	Description
mediaFileId ID!	Media file ID that will receive the external subtitle.
provider String	Subtitle provider name; null defaults to OpenSubtitles.
providerFileId String!	Provider-specific subtitle file ID.
language String!	Subtitle language code.
forced Boolean	Whether the subtitle is intended only for forced dialogue; null defaults to false.
hearingImpaired Boolean	Whether the subtitle includes hearing-impaired cues; null defaults to false.
score Int	Optional provider match score retained with the downloaded subtitle.
releaseInfo String	Optional release information retained for later matching and blocklisting.
uploader String	Optional provider uploader name.
aiTranslated Boolean	Whether the subtitle was translated with generative AI; null defaults to false.
machineTranslated Boolean	Whether the subtitle was machine translated; null defaults to false.

ExcludeMaintenanceSubjectInput

Excludes one subject from maintenance rules.

Arguments

Name	Description
subjectId ID	Required for episode or season scope.
subjectKind MaintenanceRuleSubjectKind	Defaults to title scope when omitted.
titleId ID!	Title to exclude.
ruleSetId ID	Rule to confine the exclusion to. Omitted means every rule.
reason String	Why the subject is being excluded.

ExecuteExternalImportInput

Candidate selections, mappings, and secret overrides for an external import.

Arguments

Name	Description
sourceWarmupSessionIds [ID!]!	Source warmup session IDs whose data is being imported.
prowlarr ExternalImportConnectionInput	Optional Prowlarr connection used when no Prowlarr warmup session is available.
selectedDownloadClientDedupKeys [String!]!	Deduplication keys of download clients to create.
selectedIndexerDedupKeys [String!]!	Deduplication keys of indexers to create.
downloadClientApiKeyOverrides [DownloadClientApiKeyOverrideInput!]!	API key overrides keyed by download-client deduplication key.
downloadClientPasswordOverrides [DownloadClientPasswordOverrideInput!]!	Password overrides keyed by download-client deduplication key.
indexerApiKeyOverrides [IndexerApiKeyOverrideInput!]!	API key overrides keyed by indexer deduplication key.

ExtendTitleClaimInput

Pushes a live claim’s window out.

Arguments

Name	Description
claimId ID!	Claim to extend.
expiresAt DateTime!	New expiry. Refused for a claim that is no longer live: an expired lease is replaced, not extended.

ExternalIdInput

An external identifier supplied with a title or media request.

Arguments

Name	Description
source String!	Provider namespace for the identifier, such as TVDB or IMDb.
kind String	Entity kind the identifier names at that source, such as movie, series, anime or title. Omit it when the kind is unknown: the identifier then matches a stored id of any kind.
value String!	Provider-issued identifier value.

ExternalImportAggregateWarmupProgressInput

Warmup session IDs whose aggregate progress should be calculated.

Arguments

Name	Description
sourceWarmupSessionIds [ID!]!	Warmup session IDs whose progress should be aggregated.

ExternalImportConnectionInput

Credentials for connecting to one external service instance.

Arguments

Name	Description
baseUrl String!	Base URL of the external service.
apiKey String!	API key used only for the connection operation and secret storage.

ExternalImportSetupInstanceApiKeyInput

API key for one external service instance in an import setup draft.

Arguments

Name	Description
instanceId ID!	External instance ID used to identify the draft entry.
kind ExternalImportConnectionKind!	External service kind.
apiKey String!	API key stored in the draft.

ExternalImportSourceLibraryMappingInput

Mapping from an external root folder to a Scryer library facet.

Arguments

Name	Description
sourceWarmupSessionId ID	Warmup session that surfaced this root; null identifies a manually added root without a monitored-status snapshot.
sourceKey String	External source identity, required when a warmup session is supplied.
kind ExternalArrSourceKind	External source kind, required when a warmup session is supplied.
arrRootPath String!	Root path reported by the external source.
scryerRootPath String!	Destination root path in Scryer.
libraryId ID!	Scryer library ID receiving the imported root.
facet MediaFacetValue!	Media facet receiving the imported root.

FacetScoringPersonaSelectionInput

Scoring-persona selection for a content scope.

Arguments

Name	Description
scope ContentScopeValue!	Content scope receiving the selection.
persona ScoringPersonaValue	Optional scoring persona override.
inheritGlobal Boolean!	Whether the scope inherits the global persona.

FinalizeExternalImportInput

Warmup sessions and root mappings to finalize as an external import.

Arguments

Name	Description
sourceWarmupSessionIds [ID!]!	Source warmup session IDs to finalize.
mappings [ExternalImportSourceLibraryMappingInput!]!	Root-to-library mappings selected for import.

FixTitleMatchInput

External metadata identity used to repair a title match.

Arguments

Name	Description
titleId ID!	Title identity to rematch.
tvdbId String	TVDB identity to associate with the title. Required for Series and Anime.
smgId Int	SMG canonical movie title ID to associate with a Movie title.

IgnoreTrackedDownloadInput

Identifies a tracked download to ignore without deleting it from the download client.

Arguments

Name	Description
clientId ID	Download-client ID, or null when the provider identity is sufficient.
clientType String!	Download-client provider type.
downloadClientItemId String!	Provider-issued download item ID.

IndexerApiKeyOverrideInput

API key override for a masked or conflicting indexer candidate.

Arguments

Name	Description
dedupKey String!	Stable candidate identity used to apply the override.
apiKey String!	Replacement API key.

IndexerRoutingEntryInput

Routing settings for one indexer.

Arguments

Name	Description
indexerId ID!	Indexer identity.
enabled Boolean!	Whether this indexer participates in routing.
categories [String!]!	Indexer categories to request.
priority Int!	Relative indexer priority.

IssueInteractiveReleaseCandidateTokenInput

Names one release of an interactive search to mint a candidate token for.

Arguments

Name	Description
searchId ID!	Interactive release-search job holding the release.
downloadUrl String!	Download URL of the release as returned by that search.
titleId ID!	Title identity the release is being assigned to.
season String	Optional season label or number for an episode target.
episode String	Optional episode label or number for an episode target.

LibraryPermissionGrantInput

Library permission grant for a user.

Arguments

Name	Description
libraryId ID!	Library identity receiving the grant.
permissions [LibraryPermissionValue!]!	Library permissions to store.

LibrarySettingsInput

Acquisition, import, routing, and filesystem settings for a library.

Arguments

Name	Description
requiredAudioLanguages [String!]	Required audio-language codes; use original to resolve per title.
metadataLanguage String	Metadata language override; null inherits the global default.
useSeasonFolders Boolean	Whether episodic titles use season folders; null inherits the facet setting.
qualityProfileId ID	Default quality profile identity.
requestQualityProfileIds [ID!]	Quality profile identities allowed for requests.
scoringPersona ScoringPersonaValue	Scoring persona applied by default.
fillerPolicy FillerPolicyValue	Filler monitoring policy.
recapPolicy RecapPolicyValue	Recap monitoring policy.
monitorSpecials Boolean	Whether specials are monitored.
interSeasonMovies Boolean	Whether inter-season movies are monitored.
monitorFillerMovies Boolean	Whether filler movies are monitored.
nfoWriteOnImport Boolean	Whether NFO metadata is written during import.
plexmatchWriteOnImport Boolean	Whether Plex match metadata is written during import.
importMode ImportModeValue	Import mode used for library files.
setPermissionsLinux Boolean	Whether Linux ownership and mode changes are applied.
fileChmod String	File chmod mode in numeric or accepted symbolic notation.
folderChmod String	Folder chmod mode in numeric or accepted symbolic notation.
chownGroup String	Unix group name applied when permissions are set.
indexerRouting [IndexerRoutingEntryInput!]	Indexer routing rules for this library.
downloadClientRouting [DownloadClientRoutingEntryInput!]	Download-client routing rules for this library.

LinkEmbyAccountInput

Emby credentials used to link an external account.

Arguments

Name	Description
connectionId ID!	Media-server connection identity.
mode EmbyConnectionModeValue!	Emby connection mode.
username String!	Emby username.
password String!	Emby password; used for linking and not returned.

LinkJellyfinAccountInput

Jellyfin credentials used to link an external account.

Arguments

Name	Description
connectionId ID!	Media-server connection identity.
username String!	Jellyfin username.
password String!	Jellyfin password; used for linking and not returned.

LinkPlexAccountInput

Plex credentials used to link an external account.

Arguments

Name	Description
connectionId ID!	Media-server connection identity.
plexAuthToken String!	Plex authentication token; used for linking and not returned.

LocationDestinationInput

Destination for a location operation. Both fields are optional: naming only a root keeps each title in its own library, and naming only a library lets that library’s root selection decide.

Arguments

Name	Description
libraryId ID	Destination library, or null to keep each title in its own library.
rootId ID	Destination root, or null to keep each title on its own root.

LocationOperationPreviewInput

Selection and destination to preview; nothing is changed.

Arguments

Name	Description
titleIds [ID!]!	Titles to move, in the order the client submitted them.
destination LocationDestinationInput!	Where the selection would go.
mode LocationExecutionModeInput	How the files would get there; omitted asks Scryer to do the moving.

LocationRootScopePreviewInput

The root and the destination a Change root would move it to (US4 + US5, FR-020).

FR-020 is one settings action with two destinations, so it is one input with two destinations. Exactly one of destinationPath and destinationRootId is named; the server decides which branch that is.

Arguments

Name	Description
libraryId ID!	Library the root belongs to. A root-scoped operation never crosses libraries.
rootId ID!	The root being moved. Its synthetic id survives either destination (FR-021, FR-078).
destinationPath String	A new path for the root. A path that lexically matches a configured root of this library is the same request as naming that root below, and is planned as a fold.
destinationRootId ID	Another configured root of this library, which absorbs the source root's content. Its configuration survives; the source root's is retired.
mode LocationExecutionModeInput	How the files get there; omitted asks Scryer to do the moving.

LocationRootScopeTargetInput

The root and the destination it moves to, as confirmed by a start.

The same exactly-one-destination shape the preview took, so a confirmation says back exactly what was previewed.

Arguments

Name	Description
libraryId ID!	Library the root belongs to.
rootId ID!	The root being moved.
destinationPath String	The previewed destination path, when the preview named one.
destinationRootId ID	The previewed destination root, when the preview named one.

LoginInput

Local username and password credentials with an optional TOTP code.

Arguments

Name	Description
username String!	Local username to authenticate.
password String!	Local password; never returned in a payload.
totpCode String	Optional six-digit TOTP code, required only when password-login MFA is enabled.
persistSession Boolean	Whether the returned session should persist; absent or null uses the request policy.

LoginVerificationPasskeyCompleteInput

Passkey completion for a previously verified primary login.

Arguments

Name	Description
loginChallengeId ID!	Opaque ID returned in the MFA step-up error after primary authentication.
webauthnChallengeId ID!	ID returned by loginVerificationPasskeyStart.
responseJson JSON!	Browser assertion JSON; credential material is consumed for verification and not echoed.

LoginVerificationTotpCompleteInput

TOTP or recovery-code completion for a previously verified primary login.

Arguments

Name	Description
loginChallengeId ID!	Opaque ID returned in the MFA step-up error after primary authentication.
code String!	Current authenticator or recovery code; never returned in a payload.

LoginWithEmbyInput

Emby credentials, connection mode, and optional MFA data for login.

Arguments

Name	Description
connectionId ID!	ID of the configured Emby connection.
mode EmbyConnectionModeValue!	Whether to use local Emby access or Emby Connect.
username String!	Emby username.
password String!	Emby password; never returned in a payload.
totpCode String	Optional TOTP code used when Emby-login MFA is enabled.
persistSession Boolean	Whether the returned session should persist; absent or null uses the request policy.

LoginWithJellyfinInput

Jellyfin credentials and optional MFA data for login.

Arguments

Name	Description
connectionId ID!	ID of the configured Jellyfin connection.
username String!	Jellyfin username.
password String!	Jellyfin password; never returned in a payload.
totpCode String	Optional TOTP code used when Jellyfin-login MFA is enabled.
persistSession Boolean	Whether the returned session should persist; absent or null uses the request policy.

LoginWithPlexInput

Plex credentials and the configured connection target used for login.

Arguments

Name	Description
connectionId ID!	ID of the configured Plex connection.
plexAuthToken String!	Plex authentication token used only for login.
persistSession Boolean	Whether the returned session should persist; absent or null uses the request policy.

MaintenanceActionInput

Selects one catalog action and its parameters.

Arguments

Name	Description
kind MaintenanceActionKind!	Catalog action to authorize.
targetQualityProfileId String	Target quality profile. Required by the quality-profile action and rejected for every other kind.
tags [String!]	Tags to add or remove. Required by the tag actions, ignored by every other kind, and rejected unless every label is already defined in the title-tag registry.

MaintenanceActionSequenceInput

A versioned ordered sequence. An empty sequence is a valid observe-only rule and is not represented with a placeholder action.

Arguments

Name	Description
schemaVersion Int!	Schema version that defines this sequence input representation.
steps [MaintenanceActionStepInput!]!	Ordered steps to store in the new immutable revision.

MaintenanceActionStepInput

One ordered input action with a caller-stable identifier.

Arguments

Name	Description
id ID!	Caller-stable identifier used for durable step receipts and history.
kind MaintenanceActionStepKind!	Catalog primitive this input step configures.
parameters MaintenanceActionStepParametersInput!	Typed parameters accepted by the selected primitive.

MaintenanceActionStepParametersInput

Parameters for one input sequence step. The selected kind determines the accepted subset. Keeping this input closed and validated by the server prevents Rego or the web client from inventing effects.

Arguments

Name	Description
includeDescendants Boolean	Include monitored descendants when unmonitoring a whole title.
targetQualityProfileId String	Quality-profile identifier for a change-quality-profile step.
searchCondition MaintenanceSearchCondition	Condition that controls whether a search step requests work.
tags [String!]	Tags to add or remove for a tag step.

ManualImportCandidateMappingInput

Maps a persisted manual-import candidate to an episode, series-movie link, or title-level movie target.

Arguments

Name	Description
candidateId ID!	Candidate ID from the persisted manual-import selection.
episodeId ID	Deprecated: Use episodeIds, which also covers a file that holds more than one episode. Episode target ID for an episodic import; null for a series-movie or movie import.
episodeIds [ID!]!	Episode target IDs for an episodic import; empty for a series-movie or movie import. Merged with the deprecated episodeId.
seriesMovieLinkId ID	Series-movie link ID for a series-movie import; null for an episode or movie import.
discSelection MediaDiscSelectionInput	Explicit playback title and episode mappings for one intact ISO image.

ManualPluginRepoInput

GitHub repository source for a manual plugin preview or install.

Arguments

Name	Description
githubRepoUrl String!	GitHub repository URL.

ManualPluginUploadInput

Uploaded plugin artifact and explicit risk acknowledgement.

Arguments

Name	Description
fileName String!	Uploaded file name.
wasmBase64 String!	Base64-encoded WASM artifact.
acknowledgeRisk Boolean!	Must be true to acknowledge manual artifact risk.

MarkTrackedDownloadFailedInput

Marks a tracked download failed and optionally prevents reacquisition.

Arguments

Name	Description
clientId ID	Download-client ID, or null when the provider identity is sufficient.
clientType String!	Download-client provider type.
downloadClientItemId String!	Provider-issued download item ID.
skipReacquire Boolean	When true, suppress reacquisition after marking failure.

MediaDiscEpisodeMappingInput

Associate one complete authored disc title with one catalogued episode.

Arguments

Name	Description
discTitleId String!	Authored disc title or playlist ID.
episodeId ID!	Catalogued episode ID.

MediaDiscSelectionInput

Disc title override and explicit episode mappings for one intact image.

Arguments

Name	Description
titleId String	Manual authored title ID; null requests automatic selection.
episodeMappings [MediaDiscEpisodeMappingInput!]	Explicit authored-title-to-episode associations for this physical image.

MediaRenameApplyInput

Idempotent request to apply a title’s rename plan.

Arguments

Name	Description
facet MediaFacetValue!	Facet containing the title.
titleId ID!	Title identity whose rename plan is applied.
fingerprint String!	Preview fingerprint required to ensure the plan is current.
idempotencyKey String	Optional caller key preventing duplicate application of the same request.

MediaRenameBulkApplyInput

Idempotent request to apply a bulk rename plan.

Arguments

Name	Description
facet MediaFacetValue!	Facet containing the titles.
fingerprint String!	Preview fingerprint required to ensure the plan is current.
idempotencyKey String	Optional caller key preventing duplicate application of the same request.

MediaRenamePreviewBulkInput

Scope and mode for previewing renames across several titles at once.

Arguments

Name	Description
facet MediaFacetValue!	Facet shared by every requested title.
titleIds [ID!]!	Titles whose rename plans are returned, in the order supplied.
renamableOnly Boolean	Whether to return only the items counted by renamable; counts and fingerprint still describe the whole plan.
maxItems Int	Maximum number of items returned across all plans; counts and fingerprints still describe the whole plan.

MediaRenamePreviewInput

Scope and mode for previewing media file renames.

Arguments

Name	Description
facet MediaFacetValue!	Facet whose paths are previewed.
titleId ID	Optional title identity; null previews the full facet scope.
dryRun Boolean	Whether to calculate changes without applying them; omission uses the resolver default.
renamableOnly Boolean	Whether to return only the items counted by renamable; counts and fingerprint still describe the whole plan.
maxItems Int	Maximum number of items returned; counts and fingerprint still describe the whole plan.

MediaRequestExternalRatingInput

One provider-specific rating submitted with a media request.

Arguments

Name	Description
source String!	Rating provider name.
value Float	Provider rating value before normalization, or null when absent.
score Float	Provider score on its native scale, or null when absent.
normalized Float!	Score normalized to the shared comparison scale.
votes Int	Number of votes reported by the provider, or null when absent.
url String!	Provider page for this rating.

MediaServerDefaultLibraryGrantInput

Default library permission grant to create with a media-server connection.

Arguments

Name	Description
libraryId ID!	Library identity receiving the grant.
permissions [LibraryPermissionValue!]!	Permissions granted by default.

MediaServerPathMappingInput

Path mapping used when connecting an external media server.

Arguments

Name	Description
sourcePath String!	Path reported by the external server.
destinationPath String!	Corresponding local filesystem path.

MetadataMovieInput

Metadata gateway movie lookup by one supported identity and language.

Arguments

Name	Description
tvdbId String	TVDB movie ID, when known.
smgId Int	SMG canonical movie title ID, when known.
tmdbId Int	TMDB movie ID, when known.
imdbId String	IMDb movie ID, when known.
language String	Optional metadata language code.

MetadataSeriesInput

Metadata gateway series lookup by provider ID and language.

Arguments

Name	Description
tvdbId String!	TVDB series ID.
includeEpisodes Boolean	Whether episode metadata should be included; omitted uses the service default.
language String	Optional metadata language code.

MonitorSelectionInput

Seasons and canon series movies chosen under the ADVANCED monitor type.

Arguments

Name	Description
seasonNumbers [Int!]!	Season numbers to monitor; 0 is specials.
seriesMovies [MonitorSelectionMovieInput!]	Canon series movies to monitor.

MonitorSelectionMovieInput

One canon series movie inside an advanced monitoring selection.

Arguments

Name	Description
name String!	Movie name to show back to the approver.
externalIds [ExternalIdInput!]!	Provider identifiers for the selected movie.

PauseDownloadInput

Identity of a download item to pause.

Arguments

Name	Description
clientId ID	Download-client identity; null identifies the default or unscoped client behavior.
downloadClientItemId String!	Provider-specific download item identity.

PendingReleaseFilterInput

Optional predicates for pending-release pages.

Arguments

Name	Description
titleId ID	Restrict results to a title identifier; null leaves all titles included.
wantedItemId ID	Restrict results to a wanted scope identifier; null leaves all scopes included.
statuses [PendingReleaseStatusValue!]	Restrict results to these pending-release statuses; null leaves all statuses included.

PrepareBackupDownloadInput

Backup filename to prepare for download.

Arguments

Name	Description
filename String!	Existing backup filename.

PreviewExternalImportInput

Warmup sessions and optional Prowlarr connection used to build an import preview.

Arguments

Name	Description
sourceWarmupSessionIds [ID!]!	Source warmup session IDs to include.
prowlarrWarmupSessionId ID	Prowlarr warmup session ID, when one was started.
prowlarr ExternalImportConnectionInput	Deprecated: use prowlarrWarmupSessionId Deprecated direct Prowlarr connection retained for compatibility.

PreviewMaintenanceRuleInput

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

Supply either ruleSetId to preview a stored rule set, or regoSource with exactly one action definition (action or actionSequence) to preview an unsaved draft, never both. Select titles with either titleIds or libraryId, never both.

Arguments

Name	Description
libraryIds [String!]	Selected libraries for an unsaved matcher; empty means all libraries.
subjectKind MaintenanceRuleSubjectKind	Defaults to title scope when omitted.
ruleSetId ID	Stored rule set to preview at its current revision.
regoSource String	Unsaved matcher source to preview, as written in the editor.
action MaintenanceActionInput	Legacy action for the unsaved draft. Supply this or actionSequence, never both.
actionSequence MaintenanceActionSequenceInput	Ordered actions for the unsaved draft. Supply this or action, never both.
graceDays Int	Grace period for the unsaved draft; defaults to zero.
storageRootId String	Configured library root for an unsaved matcher. Required when its matcher reads a storage fact.
subjectIds [ID!]	Optional exact subjects, requiring their owning titleIds.
titleIds [ID!]	Evaluate exactly these titles.
libraryId ID	Evaluate the first titles of this library.
limit Int	How many titles to evaluate for a library selection; defaults to twenty and is clamped to the preview cap.

PreviewRequestRuleInput

Runs one matcher against one hypothetical request without saving anything.

Supply either ruleSetId to preview a stored rule set or regoSource to preview an unsaved draft, never both: they answer different questions, and accepting both would make it ambiguous which source produced the verdict.

Arguments

Name	Description
ruleSetId ID	Stored rule set to preview at its current revision.
regoSource String	Unsaved matcher source to preview, as written in the editor.
sample RequestRuleSampleInput!	The request to evaluate the matcher against.

ProviderConfigValueInput

One provider configuration update, with typed value slots and explicit secret clearing.

Arguments

Name	Description
key String!	Provider configuration key being written.
stringValue String	String value slot; null means this slot is not selected.
boolValue Boolean	Boolean value slot; null means this slot is not selected.
intValue Int	Signed integer value slot; null means this slot is not selected.
floatValue Float	Floating-point value slot; null means this slot is not selected.
secretValue String	New secret value; it is accepted for writing but never returned in payloads.
clearSecret Boolean	When true, clear the stored secret instead of returning or preserving it.

QualityProfileCriteriaInput

Quality constraints and scoring rules for release selection.

Arguments

Name	Description
qualityTiers [String!]!	Ordered quality-tier identifiers.
archivalQuality String	Optional archival quality tier.
allowUnknownQuality Boolean!	Whether releases with unknown quality are allowed.
sourceAllowlist [String!]!	Allowed release-source identifiers.
sourceBlocklist [String!]!	Blocked release-source identifiers.
videoCodecAllowlist [String!]!	Allowed video-codec identifiers.
videoCodecBlocklist [String!]!	Blocked video-codec identifiers.
audioCodecAllowlist [String!]!	Allowed audio-codec identifiers.
audioCodecBlocklist [String!]!	Blocked audio-codec identifiers.
dolbyVisionAllowed Boolean!	Whether Dolby Vision is allowed.
detectedHdrAllowed Boolean!	Whether detected HDR is allowed.
preferRemux Boolean!	Whether remux releases are preferred.
allowBdDisk Boolean!	Whether Blu-ray disk releases are allowed.
allowUpgrades Boolean!	Whether upgrades above the current file are allowed.
scoringOverrides ScoringOverridesInput!	Additional scoring preferences.
cutoffTier String	Optional cutoff quality tier.
minScoreToGrab Int	Optional minimum score required to grab a release.
cutoffScore Int	Optional score past which same-tier upgrades stop. Omitting it keeps the stored value rather than clearing it, so a UI save cannot wipe a value set through the API before the editor exposes the field.

QualityProfileInput

Named quality profile definition.

Arguments

Name	Description
id ID!	Quality profile identity.
name String!	Display name of the profile.
criteria QualityProfileCriteriaInput!	Constraints used to accept and score releases.

QualityProfileSelectionInput

Quality profile selection for a content scope.

Arguments

Name	Description
scope ContentScopeValue!	Content scope receiving the selection.
profileId ID	Quality profile identity; null uses inherited or global behavior.
inheritGlobal Boolean!	Whether the scope inherits the global profile.

QueueBestReleaseInput

Scope and replacement choices for selecting the best release.

Arguments

Name	Description
titleId ID!	Title identity whose best release is selected.
scope QueueDownloadScopeInput!	Acquisition scope targeted by the selection.
replaceInProgress Boolean	Whether an in-progress submission may be replaced; omission uses the resolver default.

QueueDownloadInput

Signed-candidate submission choices for an existing title.

Arguments

Name	Description
titleId ID!	Title identity receiving the queued release.
candidateToken String!	Signed token identifying and authorizing the candidate release.
sizeBytes Long	Indexer-announced release size, checked against the signed candidate when present.
scope QueueDownloadScopeInput!	Acquisition scope targeted by the submission.
replaceInProgress Boolean	Whether an in-progress submission may be replaced; omission uses the resolver default.
purpose QueueDownloadPurposeValue	Submission purpose; omission uses the normal download purpose.

QueueDownloadScopeInput

Union input selecting the acquisition scope of a tracked download.

Arguments

Name	Description
episode ID	One target episode ID.
episodeSet [ID!]	Multiple target episode IDs.
seriesMovie ID	One series-movie link ID.
collection ID	One collection ID.
title Boolean	Whole-title marker; the boolean must indicate the title scope.

QueueManualImportInput

Candidate mappings selected from a manual-import preview.

Arguments

Name	Description
selectionId ID!	Manual-import selection identity.
files [ManualImportCandidateMappingInput!]!	File mappings to enqueue for import.

QueueUnlinkedReleaseInput

Names one release of an interactive search to grab without assigning it a title.

Arguments

Name	Description
searchId ID!	Interactive release-search job holding the release.
downloadUrl String!	Download URL of the release as returned by that search.
downloadClientId ID!	Enabled download client the release is handed to.

RehydrateAllMetadataInput

Language used when clearing metadata for a full rehydration.

Arguments

Name	Description
language String!	Metadata language code, such as en or en-US.

ReleaseTitleClaimInput

Withdraws a claim by hand.

Arguments

Name	Description
claimId ID!	Claim to release.
reason String	Why it is being released. Required by the service: a hold withdrawn without a reason leaves nothing to explain the deletion it permits.

RenameTitlesInput

Titles whose files should be renamed in the background.

Arguments

Name	Description
facet MediaFacetValue!	Facet shared by every requested title.
titleIds [ID!]!	Titles to rename; each is locked until the job finishes with it.

ReorderDownloadClientConfigsInput

New ordering for download-client configurations.

Arguments

Name	Description
ids [ID!]!	Download-client identities in desired order.

RequestRuleSampleInput

The hypothetical request an author-side preview is evaluated against.

It names a real user and a real library on purpose: the question a preview answers is “what would this rule do to this person asking for this title”, and a synthetic requester would exercise none of the permission, history, or linked-provider facts that make request rules useful.

Arguments

Name	Description
userId ID!	User to evaluate as.
libraryId ID!	Library to evaluate against.
externalIds [ExternalIdInput!]!	Provider identifiers of the sample title. An empty list is a legitimate preview of requester facts alone, and leaves every metadata fact unknown.
qualityProfileId ID	Quality profile the sample requests.
monitorType MonitorTypeValue	Monitoring policy the sample requests.
leaseDays Int	Lease the sample requests, in days.
leaseForever Boolean	Set to true for a sample that asks to keep the title forever. Rejected together with leaseDays.

ResolvePendingImportInput

Resolves one pending import to a title and requested title metadata.

Arguments

Name	Description
pendingImportId ID!	Pending-import item ID.
title AddTitleInput!	Title metadata to associate with the item.
attachToExistingTitle Boolean!	Attach the item to a title that already carries this identity in the same library and facet instead of rejecting the request. Defaults to false, which keeps the "title already exists in this library" error.

RestoreRecycledItemsInput

Recycle-bin entries and the preview version to restore.

Arguments

Name	Description
ids [ID!]!	Recycle-bin entry IDs to restore.
conflictPolicy RecycleRestoreConflictPolicyValue!	Conflict behavior for occupied destination paths.
previewFingerprint String!	Fingerprint returned by the current restore preview.

ResumeDownloadInput

Identity of a download item to resume.

Arguments

Name	Description
clientId ID	Download-client identity; null identifies the default or unscoped client behavior.
downloadClientItemId String!	Provider-specific download item identity.

RetryImportInput

Requests retrying one import record, optionally supplying an archive password.

Arguments

Name	Description
importId ID!	Import record ID to retry.
password String	Optional password for an encrypted source archive.

RootFolderInput

Library root path and default marker.

Arguments

Name	Description
path String!	Absolute filesystem path for the library root.
isDefault Boolean!	Whether this root is the library default.

RuleSetTestDraftInput

Unsaved rule-set fields evaluated by a scoring preview.

Arguments

Name	Description
name String!	Rule name used in the preview output.
description String!	Rule description retained for the editor draft.
regoSource String!	Complete Rego source for the unsaved draft.
enabled Boolean!	Whether the draft participates in the preview policy set.
priority Int!	Evaluation priority for the draft.
appliedFacets [String!]!	Media facets to which the draft applies.

SaveExternalImportSetupSecretDraftInput

Secret values collected for an external import setup.

Arguments

Name	Description
instanceApiKeys [ExternalImportSetupInstanceApiKeyInput!]!	External instance API keys keyed by instance ID.
downloadClientApiKeyOverrides [DownloadClientApiKeyOverrideInput!]!	Replacement API keys keyed by download-client deduplication key.
downloadClientPasswordOverrides [DownloadClientPasswordOverrideInput!]!	Replacement passwords keyed by download-client deduplication key.
indexerApiKeyOverrides [IndexerApiKeyOverrideInput!]!	Replacement API keys keyed by indexer deduplication key.

SaveQualityProfileSettingsInput

Complete quality-profile and scoring-persona settings replacement.

Arguments

Name	Description
profiles [QualityProfileInput!]!	Quality profiles to store.
globalProfileId ID	Global quality profile identity, when configured.
globalScoringPersona ScoringPersonaValue	Global scoring persona, when configured.
categorySelections [QualityProfileSelectionInput!]!	Per-category quality-profile selections.
categoryPersonaSelections [FacetScoringPersonaSelectionInput!]!	Per-category scoring-persona selections.
replaceExisting Boolean!	Whether existing stored profiles and selections are replaced.

ScanLibraryInput

Requests scanning one library and optionally supplies an import warmup session.

Arguments

Name	Description
libraryId ID!	Target library ID.
importWarmupSessionId ID	Optional import warmup session ID to use during the scan.

ScoringOverridesInput

Per-title scoring behavior overrides.

Arguments

Name	Description
allowX265Non4K Boolean	Whether non-4K x265 releases are allowed.
blockDvWithoutFallback Boolean	Whether Dolby Vision without a fallback is blocked.
preferCompactEncodes Boolean	Whether compact encodes are preferred.
preferLosslessAudio Boolean	Whether lossless audio is preferred.
blockUpscaled Boolean	Whether upscaled releases are blocked.

SearchReleasesInput

Filters for an interactive release search. Exactly one of titleId and query names the subject.

Arguments

Name	Description
titleId ID	Title identity whose releases are searched; required unless query is given.
seriesMovieLinkId ID	Optional series/movie link identity for an episodic movie target.
season String	Optional season label or number to search.
episode String	Optional episode label or number to search.
limit Int	Optional result limit; the resolver applies its own default and cap.
query String	Raw operator query searched without a catalog title.
kind InteractiveSearchKindValue	Search kind; required with query.
indexerIds [ID!]	Optional indexer configuration identities to restrict the search to.
categories [String!]	Optional newznab categories; the kind's defaults apply when omitted.

SearchSubtitlesInput

Selects a media file and language for subtitle provider searches.

Arguments

Name	Description
mediaFileId ID!	Media file ID whose release metadata is used for matching.
language String	Requested subtitle language code; null or blank searches the administrator's preferred subtitle language.

SetCollectionMonitoredInput

Monitoring state change for a collection.

Arguments

Name	Description
collectionId ID!	Collection identity to update.
monitored Boolean!	Whether the collection is monitored.

SetDefaultSeedingProfileInput

Global default seeding profile assignment.

Arguments

Name	Description
seedingProfileId ID	Seeding profile identity to use as the default, or null to clear it.

SetEpisodeMonitoredInput

Monitoring state change for an episode.

Arguments

Name	Description
episodeId ID!	Episode identity to update.
monitored Boolean!	Whether the episode is monitored.

SetIndexerDownloadClientMappingInput

Download-client mapping for one indexer.

Arguments

Name	Description
indexerId ID!	Indexer identity to update.
downloadClientId ID	Download-client identity to assign, or null to clear the mapping.

SetIndexerSeedingProfileInput

Seeding profile assignment for one indexer.

Arguments

Name	Description
indexerId ID!	Indexer identity to update.
seedingProfileId ID	Seeding profile identity to assign, or null to clear the assignment.

SetMaintenanceInstanceGatesInput

Arms or disarms the instance-wide maintenance gates. An omitted field leaves that gate exactly as stored.

Arguments

Name	Description
evaluationEnabled Boolean	Whether the scheduled evaluator may run.
resultDisplayEnabled Boolean	Whether candidate results are returned to clients.
presentationEffectsEnabled Boolean	Reserved for provider collection projection and lifecycle notifications. Nothing reads it yet.
reversibleEffectsEnabled Boolean	Whether low and medium risk actions may execute for rules that are armed and in OBSERVE mode.
destructiveEffectsEnabled Boolean	Whether high risk actions may execute. Setting this to true lets every rule already armed as DESTRUCTIVE begin deleting media files on the next handler pass.

SetMaintenanceRuleArmingInput

Sets how far one rule set’s effects are armed.

Arguments

Name	Description
id ID!	Rule-set ID.
arming MaintenanceEffectArming!	Arming level to store. DESTRUCTIVE requires acknowledging the rule's current candidate count and applies only to high-risk actions.
acknowledgedCandidateCount Int	The candidate count the operator saw and acknowledged; required for DESTRUCTIVE and must equal the rule's current non-terminal count.
acknowledgedRevisionNumber Int	The reviewed matcher/action revision; required for DESTRUCTIVE.
acknowledgedLibraryIds [ID!]	The reviewed library scope; required for DESTRUCTIVE. An empty list explicitly acknowledges all libraries; omission is not confirmation.

SetMaintenanceRuleModeInput

Moves a rule set between evaluation modes.

Arguments

Name	Description
id ID!	Rule-set ID.
mode MaintenanceEvaluationMode!	Mode to store. Anything other than DISABLED also enables the rule.

SetMinimumSeedersFloorInput

Replacement system-wide minimum-seeder floor.

Arguments

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

SetMyUiSettingsInput

Complete caller presentation-preferences update.

Arguments

Name	Description
theme UiThemeValue!	Selected theme.
dateTimeFormat UiDateTimeFormatValue	Optional date and time format; null preserves the existing value.
highlightColor String	Optional primary highlight color; null preserves the existing value.
secondaryColor String	Optional secondary color; null preserves the existing value.
highContrastMode Boolean!	Whether high-contrast presentation should be enabled.
reduceMotion Boolean!	Whether motion-reduction behavior should be enabled.
hideSponsorButton Boolean!	Whether the sponsor button should be hidden.
density UiDensityValue!	Selected density.
sidebarMode UiSidebarModeValue!	Selected sidebar mode.
defaultLandingView UiDefaultLandingViewValue!	Content area to open by default.
tableColumns [UiTableColumnSettingInput!]!	Complete table-column setting list; empty clears all saved column settings.

SetPrimaryMovieFileInput

Primary-file assignment for a movie title.

Arguments

Name	Description
titleId ID!	Movie title identity.
fileId ID!	Media-file identity to make primary.

SetRequestRuleInstanceGatesInput

Arms or disarms the instance-wide request-rule gate. An omitted field leaves the gate exactly as stored.

Arguments

Name	Description
evaluationEnabled Boolean	Whether stored request rules may decide anything.

SetRequestRuleModeInput

Moves a rule set between evaluation modes.

Arguments

Name	Description
ruleSetId ID!	Rule-set ID.
mode RequestRuleEvaluationModeValue!	Mode to store. Anything other than DISABLED also enables the rule.

SetSeriesMovieMonitoredInput

Monitoring state change for a series-movie link.

Arguments

Name	Description
seriesMovieLinkId ID!	Series-movie link identity to update.
monitored Boolean!	Whether the linked movie is monitored.

SetTitleMonitoredInput

Monitoring state change for a title.

Arguments

Name	Description
titleId ID!	Title identity to update.
monitored Boolean!	Whether the title is monitored.

SetTitleRequiredAudioInput

Sets a title-level required-audio-language override.

Arguments

Name	Description
titleId ID!	Target title ID.
facet MediaFacetValue!	The facet of the title: "movie", "series", or "anime"
languages [String!]	null removes the override and inherits from the library or facet. [] stores an explicit "no required languages" override for the title. Use original to resolve the title's original language dynamically.

SetUserAppPermissionsInput

Replacement application permissions for a user.

Arguments

Name	Description
userId ID!	User identity to update.
permissions [AppPermissionValue!]!	Application permissions to store.

SetUserLibraryPermissionsInput

Replacement library permission grants for a user.

Arguments

Name	Description
userId ID!	User identity to update.
grants [LibraryPermissionGrantInput!]!	Library grants to store.

SetUserLoginEnabledInput

Enable or disable login for a user identity.

Arguments

Name	Description
userId ID!	User identity to update.
enabled Boolean!	Whether login is enabled.

SetUserPasswordInput

Password replacement for a user account. Administrator-provided passwords are temporary.

Arguments

Name	Description
userId ID!	User identity whose password changes.
password String!	New password; stored securely and never returned.
currentPassword String	Current password when required by the authorization policy.

StartApplicationUpgradeInput

The exact update notice accepted by startApplicationUpgrade.

Arguments

Name	Description
expectedTag String!	Release tag displayed by the current update notice.
expectedVersion String!	Release version displayed by the current update notice.

StartExternalImportArrSourceWarmupInput

External source and credentials for an asynchronous warmup session.

Arguments

Name	Description
kind ExternalArrSourceKind!	External source kind.
connection ExternalImportConnectionInput!	Connection URL and API key.

StartExternalImportProwlarrWarmupInput

Prowlarr credentials for an asynchronous warmup session.

Arguments

Name	Description
connection ExternalImportConnectionInput!	Connection URL and API key.

StartLocationOperationInput

Confirmation of a previewed location operation.

Exactly one destination form is confirmed: a title selection with its destination, or a root-scoped target. titleIds and destination stayed where they were and are still what a selection sends; they are nullable only so a root-scoped confirmation does not have to claim an empty selection going nowhere.

Arguments

Name	Description
titleIds [ID!]	Titles to move, matching the previewed selection. Omitted for a root-scoped confirmation, which has no selection to express.
destination LocationDestinationInput	Where the selection goes, matching the previewed destination. Omitted for a root-scoped confirmation, which names its roots below instead.
rootScope LocationRootScopeTargetInput	Confirms a previewed root-scoped operation (US4 + US5): one root's path is replaced, or one root is folded into another root of the same library.
mode LocationExecutionModeInput	The mode the plan was previewed under; a different mode is a different plan, so it produces a different fingerprint and is refused.
planFingerprint String!	Fingerprint of the previewed plan; a stale fingerprint is refused.
typedConfirmation String	Phrase the user typed, for operations that require typed confirmation.

SubmitMediaRequestInput

Metadata and preferences submitted with a media request.

Arguments

Name	Description
libraryId ID!	Library identity in which the requested title belongs.
facet MediaFacetValue!	Requested media facet.
title String!	Requested title name.
externalIds [ExternalIdInput!]!	External provider identifiers for the request.
year Int	Release year when known.
overview String	Plot summary when known.
sortTitle String	Sort key for title ordering.
slug String	URL-safe title slug.
runtimeMinutes Int	Runtime in minutes.
language String	Metadata language code.
contentStatus String	Provider content-status label.
rating Float	Combined metadata rating, or null when unavailable.
ratingSources [String!]	Sources contributing to the combined metadata rating.
externalRatings [MediaRequestExternalRatingInput!]	Provider-specific metadata ratings.
requestedQualityProfileId ID	Quality profile identity requested for approval.
requestedMonitorType MonitorTypeValue	Monitoring policy requested for approval.
requestedMonitorSelection MonitorSelectionInput	Seasons and series movies to monitor; required with ADVANCED.
requestedLeaseDays Int	How long the requester wants the media kept, in days. Omitted means forever, which is what Scryer granted before leases existed.

SubtitleLanguagePreferenceInput

Subtitle language preference with optional hearing-impaired and forced flags.

Arguments

Name	Description
code String!	BCP 47 or provider language code.
hearingImpaired Boolean	Whether hearing-impaired subtitles are preferred.
forced Boolean	Whether forced subtitles are preferred.

TestDownloadClientConnectionInput

Connection details used to test a download client.

Arguments

Name	Description
id ID	Existing client identity, when testing a stored configuration.
clientType String!	Provider implementation identifier for an unsaved configuration.
config [ProviderConfigValueInput!]!	Provider configuration values used for the test.
proxyConfigId ID	Proxy to dial through for this test, so it exercises the same egress live traffic will use. Omit to test the client directly.

TestEmbyConnectInput

Credentials used to test an Emby Connect server.

Arguments

Name	Description
connectionId ID!	Media-server connection identity.
usernameOrEmail String!	Emby Connect username or email.
password String!	Emby Connect password.

TestIndexerConnectionInput

Connection details used to test an indexer provider.

Arguments

Name	Description
providerType String!	Provider implementation identifier.
config [ProviderConfigValueInput!]	Optional provider configuration values used for the test.
indexerId ID	Existing indexer identity, when testing a stored configuration.
proxyConfigId ID	Proxy identity: omission preserves the stored association, null clears it, and a value replaces it.

TestMediaServerConnectionInput

Credentials used to test an existing media-server connection.

Arguments

Name	Description
id ID!	Media-server connection identity to test.
plexAuthToken String	Optional Plex authentication token used for this test.

TestRuleSetInput

Input for an explicit, read-only title-aware rule-set scoring preview.

Arguments

Name	Description
draft RuleSetTestDraftInput	Current unsaved editor draft. Omit when testing a saved rule set.
testRuleSetId ID	Saved rule-set identity to test without supplying a draft.
editRuleSetId ID	Existing rule-set identity being edited, or null when creating a rule.
copySourceRuleSetId ID	Source identity when the editor was opened by copying a rule, or null.
copyDisablesSource Boolean!	Whether copying disables the source rule in the preview policy set.
titleId ID!	Library title used to construct title-aware scoring facts.
episodeId ID	Episode belonging to the selected title, or null for a whole-title preview.
releaseName String!	Release name to parse and score.
sizeBytes Long	Release size in bytes, or null when unknown.

TestSubtitleProviderConnectionInput

Connection details used to test a subtitle provider.

Arguments

Name	Description
id ID	Existing provider identity, when testing a stored configuration.
providerType String!	Provider implementation identifier for an unsaved configuration.
config [ProviderConfigValueInput!]!	Provider configuration values used for the test.

TitleCatalogFilterInput

Optional predicates for narrowing a title catalog page.

Arguments

Name	Description
monitored Boolean	Restrict results to monitored or unmonitored titles; null leaves both included.
contentStatuses [TitleCatalogContentStatusValue!]	Restrict results to these content statuses; null leaves all statuses included.
rootFolderIds [ID!]	Restrict results to titles stored under these root folder IDs; null leaves all roots included.
genreTagKeys [String!]	Restrict results to titles having one of these canonical genre tag keys; null leaves all genres included.
themeTagKeys [String!]	Restrict results to titles having one of these canonical theme tag keys; null leaves all themes included.
tags [String!]	Restrict results to titles carrying at least one of these user-defined tag labels; null or empty leaves all titles included. Labels are normalized the way the tag registry stores them, and reserved scryer: entries are rejected.
minimumYear Int	Inclusive lower bound for release year; null imposes no lower bound.
maximumYear Int	Inclusive upper bound for release year; null imposes no upper bound.
minimumRating Float	Minimum combined rating on the catalog rating scale; null imposes no rating bound.

TitleCatalogSortInput

Ordering applied to a title catalog page.

Arguments

Name	Description
key TitleCatalogSortKeyValue!	Field used for ordering.
direction SortDirectionValue	Ascending or descending direction; omitted or null defaults to ascending.

TitleHistoryFilterInput

Filters and pagination controls for title history.

Arguments

Name	Description
eventTypes [TitleHistoryEventTypeValue!]	Event types to include, or null for all types.
titleIds [ID!]	Title IDs to include, or null for all titles.
libraryIds [ID!]	Library IDs to include, or null for all libraries.
titleSearch String	Case-insensitive title search text, or null for no text filter.
downloadId String	Download identity to include, or null for all downloads.
episodeId ID	Episode ID to include, or null for all episodes.
groupByEvent Boolean	Whether equivalent events should be grouped.
limit Int	Maximum number of events to return.
offset Int	Number of matching events to skip.

TitleOptionsInput

Optional title settings used when creating or updating a title.

Arguments

Name	Description
qualityProfileId ID	Quality profile identity; omission preserves the current value, null clears it, and a value replaces it.
rootFolderId ID	Deprecated: Retired for existing titles with tracked files: use locationOperationPreview and startLocationOperation to move a title. Still accepted at title creation and for titles with no tracked files. Root-folder identity used when a title is created; omission preserves the current value, null clears it, and a value replaces it. Changing the root of an existing title that has tracked files is refused: preview the change with locationOperationPreview and run it with startLocationOperation.
monitorType MonitorTypeValue	Monitoring policy; omission preserves the current value, null clears it, and a value replaces it.
useSeasonFolders Boolean	Whether season folders are used for Series or Anime; omission preserves the current value, null clears it, and a value replaces it. Movies reject this field.
metadataLanguage String	Metadata language; omission preserves the current value, null clears it, and a value replaces it.
monitorSpecials Boolean	Whether specials are monitored; omission preserves the current value, null clears it, and a value replaces it.
interSeasonMovies Boolean	Whether inter-season movies are monitored; omission preserves the current value, null clears it, and a value replaces it.
fillerPolicy FillerPolicyValue	Filler policy; omission preserves the current value, null clears it, and a value replaces it.
recapPolicy RecapPolicyValue	Recap policy; omission preserves the current value, null clears it, and a value replaces it.
releaseNumbering ReleaseNumberingValue	Which episode numbering this title's releases are read in; omission preserves the current value, null clears it (back to AUTO), and a value replaces it. Movies reject this field.
monitorSelection MonitorSelectionInput	Seasons and series movies to monitor under ADVANCED; omission preserves the current selection, null clears it, and a value replaces it. Required with ADVANCED, and rejected for movies.

TogglePluginInput

Enables or disables one installed plugin.

Arguments

Name	Description
pluginId ID!	ID of the installed plugin to enable or disable.
enabled Boolean!	Desired enabled state.

ToggleRuleSetInput

Enables or disables one rule set.

Arguments

Name	Description
id ID!	Rule-set ID.
enabled Boolean!	Desired enabled state.

TotpEnrollmentCompleteInput

TOTP enrollment completion request.

Arguments

Name	Description
challengeId ID!	ID of the pending TOTP enrollment challenge.
code String!	Current TOTP code used to verify the enrollment.

TotpVerifyInput

TOTP verification request.

Arguments

Name	Description
code String!	Current TOTP code; never returned in a payload.

TrackedRulePackPriorityInput

Priority to retain for one tracked source template.

Arguments

Name	Description
templateId String!	Stable template ID from the source pack.
priority Int!	Local evaluation priority.

TriggerAcquisitionSearchInput

Scope filters for an acquisition search. Omitted intent preserves Wanted behavior.

Arguments

Name	Description
intent AcquisitionSearchIntentValue	Optional explicit title/season search intent.
wantedKind WantedKindValue	Wanted category to search, defaulting to missing items.
facet MediaFacetValue	Optional facet restriction.
libraryIds [ID!]	Optional library identities to include.
titleId ID	Optional title identity to include.
seasonNumber Int	Optional season number for the selected title.
wantedItemId ID	Optional wanted-scope identity for searching exactly one scope.

UiTableColumnSettingInput

Input form for one table-column preference.

Arguments

Name	Description
facet UiSettingsFacetValue!	Media facet to which the setting applies.
tableViewMode UiTableViewModeValue!	Table mode to which the setting applies.
columnId String!	Stable column identifier.
columnOrder Int!	Zero-based display order.
visible Boolean!	Whether the column should be visible.

UpdateAcquisitionSettingsInput

Acquisition scheduler timing and scoring thresholds.

Arguments

Name	Description
enabled Boolean!	Whether acquisition scheduling is enabled.
upgradeCooldownHours Int!	Upgrade cooldown in hours.
sameTierMinDelta Int!	Minimum score improvement for a same-tier upgrade.
crossTierMinDelta Int!	Deprecated and inert: accepted and stored for compatibility, ignored by acquisition (quality tier is compared before score, so no cross-tier delta is ever consulted). Will be removed in a later minor.
forcedUpgradeDeltaBypass Int!	Score delta that bypasses the forced-upgrade guard.
pollIntervalSeconds Int!	Scheduler poll interval in seconds.
longTailBackfillMaxScopesPerCycle Int!	Maximum long-tail scopes processed per cycle.
longTailReconvergeDays Int!	Days between long-tail reconvergence passes.

UpdateAutoBackupSettingsInput

Automatic-backup schedule and key-management settings.

Arguments

Name	Description
enabled Boolean!	Whether automatic backups are enabled.
dailyTimeLocal String!	Daily backup time in local time format.
setAutoBackupKey String	New automatic-backup encryption key, when rotating or setting one.
clearAutoBackupKey Boolean!	Whether the stored automatic-backup key should be cleared.

UpdateBackupSettingsInput

Optional custom backup destination.

Arguments

Name	Description
customBackupPath String	Filesystem path used for custom backups.

UpdateDownloadClientConfigInput

Patch for an existing download client.

Arguments

Name	Description
id ID!	Download-client configuration identity to patch.
name String	Replacement display name; omission preserves it.
clientType String	Replacement provider implementation; omission preserves it.
config [ProviderConfigValueInput!]	Replacement provider configuration; omitted secret fields retain stored secrets.
proxyConfigId ID	Replacement proxy assignment; omission preserves it and null clears it.
isEnabled Boolean	Replacement enabled state; omission preserves it.

UpdateDownloadClientRoutingInput

Download-client routing entries for a content scope.

Arguments

Name	Description
scope ContentScopeValue!	Content scope receiving the routing rules.
entries [DownloadClientRoutingEntryInput!]!	Routing entries keyed by download-client identity.

UpdateGeneralSettingsInput

General retention, cache, and plugin trust settings.

Arguments

Name	Description
apiExplorerEnabled Boolean	Whether administrators may use the API explorer. Omission preserves the saved setting.
experimentalFeaturesEnabled Boolean	Whether surfaces that are still being finished are shown on this instance. Omission preserves the saved setting.
personalizedDiscoveryEnabled Boolean	Whether this instance sends its library context to the metadata gateway for personalized discovery. Omission preserves the saved setting.
srrdbFilenameRecoveryEnabled Boolean	Whether automatic SABnzbd and NZBGet imports may ask srrdb.com to recover obfuscated filenames. Omission preserves the saved setting.
keepHistoryForever Boolean	Whether history is retained without expiry.
historyRetentionDays Int	History retention period in days when not retained forever.
imageCacheMaxSizeMb Int	Maximum image-cache size in megabytes.
pluginHttpCaBundlePem String	PEM bundle path or contents used to trust plugin HTTP certificates.

UpdateIndexerConfigInput

Patch for an existing indexer provider.

Arguments

Name	Description
id ID!	Indexer configuration identity to patch.
name String	Replacement display name; omission preserves the current value.
providerType String	Replacement provider implementation; omission preserves the current value.
proxyConfigId ID	Proxy identity: omission preserves it, null clears it, and a value replaces it.
downloadClientId ID	Download-client identity: omission preserves it, null clears it, and a value replaces it.
rateLimitSeconds Int	Replacement rate-limit interval in seconds; omission preserves it.
rateLimitBurst Int	Replacement rate-limit burst; omission preserves it.
isEnabled Boolean	Replacement enabled state; omission preserves it.
enableInteractiveSearch Boolean	Replacement interactive-search state; omission preserves it.
enableAutoSearch Boolean	Replacement automatic-search state; omission preserves it.
config [ProviderConfigValueInput!]	Replacement provider configuration; omitted secret fields retain stored secrets.

UpdateIndexerRoutingInput

Indexer routing entries for a content scope.

Arguments

Name	Description
scope ContentScopeValue!	Content scope receiving the routing rules.
entries [IndexerRoutingEntryInput!]!	Routing entries keyed by indexer identity.

UpdateLibraryInput

Patch for an existing media library.

Arguments

Name	Description
libraryId ID!	Library identity to patch.
name String	Replacement display name; omission preserves it.
roots [UpdateLibraryRootInput!]	Replacement root list; omission preserves roots and an empty list clears them when valid.
settings LibrarySettingsInput	Optional replacement library settings.

UpdateLibraryPathsInput

Root paths for movie, series, and optional anime libraries.

Arguments

Name	Description
moviePath String!	Movie library path.
seriesPath String!	Series library path.
animePath String	Anime library path, when configured.

UpdateLibraryRootInput

Replacement library root path and default marker.

Arguments

Name	Description
path String!	Absolute filesystem path for the root.
isDefault Boolean!	Whether this root is the library default.

UpdateMaintenanceRuleMatcherInput

Replaces the matcher of an existing rule set, appending a revision.

Arguments

Name	Description
id ID!	Rule-set ID.
regoSource String!	Replacement matcher source as written in the editor.
action MaintenanceActionInput	Legacy action the new revision authorizes. Supply this or actionSequence, never both.
actionSequence MaintenanceActionSequenceInput	Ordered actions the new revision authorizes. Supply this or action, never both.
graceDays Int	Days a subject must match continuously before the action becomes due; defaults to zero.
storageRootId ID	Configured library root. Omission preserves the current root, null clears it, and a value replaces it.

UpdateMaintenanceRuleMetadataInput

Renames and re-scopes a rule set without touching its matcher.

Arguments

Name	Description
id ID!	Rule-set ID.
name String!	Replacement name.
description String	Replacement description; omitted clears it.
libraryIds [String!]	Replacement library scope. Omitted or empty means every library.

UpdateMediaRequestInput

Replacement preferences for the caller’s media request.

Arguments

Name	Description
requestId ID!	Media request identity to update.
requestedQualityProfileId ID!	Quality profile identity requested for the title.
requestedMonitorType MonitorTypeValue	Optional monitoring policy requested for the title.
requestedMonitorSelection MonitorSelectionInput	Seasons and series movies to monitor; required with ADVANCED.
requestedLeaseDays Int	Replacement lease in days. Omission preserves the current lease; null requests forever.

UpdateMediaServerConnectionInput

Patch for an existing media-server connection.

Arguments

Name	Description
id ID!	Media-server connection identity to patch.
provider MediaServerProviderValue	Replacement provider type; omission preserves the current value.
displayName String	Replacement display name; omission preserves the current value.
baseUrl String	Replacement base URL; omission preserves the current value.
externalUrl String	Replacement browser-facing URL; omission preserves the current value and an empty value clears it.
enabled Boolean	Replacement enabled state; omission preserves the current value.
loginEnabled Boolean	Replacement login-enabled state; omission preserves the current value.
linkingEnabled Boolean	Replacement linking-enabled state; omission preserves the current value.
autoAddEnabled Boolean	Replacement auto-add state; omission preserves the current value.
defaultAppPermissions [AppPermissionValue!]	Replacement default application permissions; omission preserves the current list.
defaultLibraryGrants [MediaServerDefaultLibraryGrantInput!]	Replacement default library grants; omission preserves the current list.
machineId String	Replacement machine identity; omission preserves it.
clearMachineId Boolean	Whether the stored machine identity should be cleared.
plexAuthToken String	Replacement Plex authentication token; omission preserves it and the value is never returned.
plexServerId String	Replacement Plex server identity; omission preserves it.
apiKey String	Replacement provider API key; omission preserves it and the value is never returned.
clearApiKey Boolean	Whether the stored API key should be cleared.
adminUsername String	Replacement provider administrator username; omission preserves it.
adminPassword String	Replacement provider administrator password; omission preserves it and the value is never returned.
embyConnectionMode EmbyConnectionModeValue	Replacement Emby connection mode; omission preserves it.
embyLocalSetupMethod EmbyLocalSetupMethodValue	Replacement Emby local setup method; omission preserves it.
embyConnectEnabled Boolean	Replacement Emby Connect enabled state; omission preserves it.
embyConnectUsernameOrEmail String	Replacement Emby Connect username or email; omission preserves it.
embyConnectPassword String	Replacement Emby Connect password; omission preserves it and the value is never returned.
embyConnectServerId String	Replacement Emby Connect server identity; omission preserves it.
pathMappings [MediaServerPathMappingInput!]	Replacement path mappings; omission preserves the current mappings.

UpdateMediaSettingsInput

Optional media-settings values applied to a content scope.

Arguments

Name	Description
scope ContentScopeValue!	Content scope receiving the settings.
libraryPath String	Optional library path override.
rootFolders [RootFolderInput!]	Optional replacement list of library roots; null leaves existing roots unchanged.
requiredAudioLanguages [String!]	Optional required audio-language codes; use original to resolve per title.
useSeasonFolders Boolean	Whether episodic titles use season folders.
folderTemplate String	Optional title folder template.
seasonFolderTemplate String	Optional season folder template.
specialsFolderTemplate String	Optional specials folder template.
renameEnabled Boolean	Whether automatic renaming is enabled.
renameTemplate String	Optional file and folder rename template.
renameCollisionPolicy RenameCollisionPolicyValue	Collision policy for generated paths.
renameMissingMetadataPolicy RenameMissingMetadataPolicyValue	Behavior when metadata needed for renaming is missing.
fillerPolicy FillerPolicyValue	Filler monitoring policy.
recapPolicy RecapPolicyValue	Recap monitoring policy.
monitorSpecials Boolean	Whether specials are monitored.
interSeasonMovies Boolean	Whether inter-season movies are monitored.
monitorFillerMovies Boolean	Whether filler movies are monitored.
nfoWriteOnImport Boolean	Whether NFO metadata is written during import.
plexmatchWriteOnImport Boolean	Whether Plex match metadata is written during import.
importMode ImportModeValue	Import mode used for files in this scope.
setPermissionsLinux Boolean	Whether Linux ownership and mode changes are applied.
fileChmod String	File chmod mode in numeric or accepted symbolic notation.
folderChmod String	Folder chmod mode in numeric or accepted symbolic notation.
chownGroup String	Optional Unix group name for imported paths.

UpdateNotificationChannelInput

Values that may be changed on an existing notification channel.

Arguments

Name	Description
id ID!	Notification channel ID to update.
name String	Replacement channel display name, or null to leave it unchanged.
config [ProviderConfigValueInput!]	Replacement configuration, or null to leave it unchanged.
mediaServerConnectionId ID	Replacement media-server connection; an explicit null clears it.
isEnabled Boolean	Replacement enabled state, or null to leave it unchanged.

UpdateNotificationSubscriptionInput

Values that may be changed on an existing notification subscription.

Arguments

Name	Description
id ID!	Notification subscription ID to update.
targetKind String	Replacement target category, or null to leave it unchanged.
targetId ID	Replacement target ID, or null to leave it unchanged.
eventType String	Replacement event type, or null to leave it unchanged.
scope String	Replacement scope category, or null to leave it unchanged.
scopeId String	Replacement scope key, or null to leave it unchanged.
isEnabled Boolean	Replacement enabled state, or null to leave it unchanged.

UpdateOAuthClientRegistrationInput

Replacement details for a custom OAuth application.

Arguments

Name	Description
displayName String!	Name displayed to users during authorization.
redirectUris [String!]!	Exact HTTPS callback URLs permitted for this application.
enabled Boolean!	Whether the application is active. Disabling revokes its existing grants.

UpdatePluginAutoUpdateSettingsInput

Automatic official-plugin patch update setting.

Arguments

Name	Description
enabled Boolean!	Whether the scheduled plugin catalog refresh installs official patch updates automatically.

UpdatePostProcessingScriptInput

Values that may be changed on an existing post-processing script.

Arguments

Name	Description
id ID!	Script ID to update.
name String	Replacement script name, or null to leave unchanged.
description String	Replacement description, or null to leave unchanged.
scriptType String	Replacement script source type, or null to leave unchanged.
scriptContent String	Replacement script content, or null to leave unchanged.
inlineShellAcknowledged Boolean	Explicit acknowledgement that inline shell executes with application privileges.
appliedFacets [String!]	Replacement media facets, or null to leave unchanged.
executionMode ExecutionModeValue	Replacement execution mode, or null to leave unchanged.
timeoutSecs Int	Replacement maximum runtime in seconds, or null to leave unchanged.
priority Int	Replacement execution priority, or null to leave unchanged.
enabled Boolean	Replacement enabled state, or null to leave unchanged.
debug Boolean	Replacement debug state, or null to leave unchanged.

UpdateProxyConfigInput

Patch for a proxy configuration.

Arguments

Name	Description
id ID!	Proxy configuration identity to patch.
name String	Replacement display name; omission preserves it.
baseUrl String	Replacement base URL; omission preserves it.
requestTimeoutSeconds Int	Replacement request timeout in seconds; omission preserves it.
username String	Replacement transport-proxy username. Write-only: omission preserves the stored value, null clears it, and it is never read back.
password String	Replacement transport-proxy password. SSH tunnels reject passwords. Write-only: omission preserves the stored value, null clears it.
remoteDns Boolean	Replacement SOCKS5 remote-DNS state; omission preserves it.
privateKey String	Replacement tunnel private key: PEM for an SSH tunnel, base64 for WireGuard. Write-only: omission preserves the stored value, null clears it, and it is never read back. Writing it re-derives tunnelPublicKey.
privateKeyPassphrase String	Replacement private key passphrase. Write-only: omission preserves the stored value, null clears it, and it is never read back.
peerPublicKey String	Replacement WireGuard peer public key; omission preserves it. It has no cleared state: a WireGuard tunnel cannot exist without one.
presharedKey String	Replacement WireGuard preshared key. Write-only: omission preserves the stored value, null clears it, and it is never read back.
tunnelAddresses [String!]	Replacement WireGuard interface addresses; omission preserves them, and an empty list clears them.
tunnelDnsServers [String!]	Replacement WireGuard resolvers; omission preserves them, and an empty list clears them.
tunnelMtu Int	Replacement WireGuard MTU; omission preserves it and null restores the engine's default.
tunnelKeepaliveSeconds Int	Replacement WireGuard keepalive in seconds; omission preserves it, null restores the engine's default, and zero switches keepalive off.
isEnabled Boolean	Replacement enabled state; omission preserves it.

UpdateRecycleBinSettingsInput

Recycle-bin enablement setting.

Arguments

Name	Description
enabled Boolean!	Whether deleted media is retained in the recycle bin.

UpdateRequestRuleMatcherInput

Replaces the matcher of an existing rule set, appending revision N+1.

Arguments

Name	Description
ruleSetId ID!	Rule-set ID.
regoSource String!	Replacement matcher source as written in the editor.

UpdateRequestRuleMetadataInput

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

Arguments

Name	Description
ruleSetId ID!	Rule-set ID.
name String!	Replacement name.
description String	Replacement description; omitted clears it.
libraryIds [String!]	Replacement library scope. Omitted or empty means every library.

UpdateRuleSetInput

Patches a rule set while preserving omitted values.

Arguments

Name	Description
id ID!	Rule-set ID.
name String	Replacement name, or null to preserve.
description String	Replacement description, or null to preserve.
regoSource String	Replacement Rego source, or null to preserve.
appliedFacets [String!]	Replacement facet list, or null to preserve.
priority Int	Replacement priority, or null to preserve.
managedTagFilter [String!]	Narrow a managed locale pack to titles carrying one of these tags. An empty list clears the filter so the pack applies wherever its facts match. Rejected for user-authored rule sets.

UpdateSecuritySettingsInput

Authentication and local-access security settings.

Arguments

Name	Description
sessionDurationDays Int	Session lifetime in days (1–365). Omission preserves the saved instance setting.
formLoginEnabled Boolean!	Whether form login is enabled.
passwordMinLength Int!	Minimum accepted password length.
skipLoginForLocalIps Boolean!	Whether local IPs may skip login.
apiKeysRestrictToSystemSettingsUsers Boolean	Whether API keys are restricted to users with system-settings permission.
mfaRequireConfigStepUp Boolean!	Whether sensitive configuration changes require MFA step-up.
mfaRequirePasswordLogin Boolean!	Whether password login requires MFA.
mfaRequireJellyfinLogin Boolean	Whether Jellyfin login requires an enrolled authentication factor.
mfaRequireEmbyLogin Boolean	Whether Emby login requires an enrolled authentication factor. Omission preserves the saved setting.
totpRequireJellyfinLogin Boolean	Deprecated: Use mfaRequireJellyfinLogin. Deprecated alias for mfaRequireJellyfinLogin.
totpRequireEmbyLogin Boolean	Deprecated: Use mfaRequireEmbyLogin. Deprecated alias for mfaRequireEmbyLogin. Omission preserves the saved setting.

UpdateSeedingProfileInput

Patch for a stored seeding profile; omitted fields are preserved and explicit nulls clear goals.

Arguments

Name	Description
id ID!	Seeding profile identity to patch.
name String	Replacement name; omission preserves it.
ratio Float	Replacement share ratio goal; null clears it and omission preserves it.
seedTimeMinutes Int	Replacement seed time goal in minutes; null clears it and omission preserves it.
seasonPackMode SeasonPackSeedModeValue	Replacement season-pack mode; omission preserves it.
seasonPackRatio Float	Replacement season-pack ratio goal; null clears it and omission preserves it.
seasonPackSeedTimeMinutes Int	Replacement season-pack seed time goal in minutes; null clears it and omission preserves it.
honorTrackerMinimums Boolean	Replacement tracker-minimum handling; omission preserves it.
goalMetAction SeedGoalMetActionValue	Replacement goal-met action; omission preserves it.
neverRemove Boolean	Replacement never-remove flag; omission preserves it.
minimumSeeders Int	Replacement minimum seeders; null restores the system floor and omission preserves it.
postImportTracking PostImportTrackingValue	Replacement post-import tracking mode; omission preserves it.

UpdateSeriesMovieTagsInput

User-tag additions and removals applied across a set of series movies.

Arguments

Name	Description
seriesMovieLinkIds [ID!]!	Series-movie links to patch. Each link's series is checked for title-management rights before the first write, so a set spanning a library the caller cannot manage changes nothing.
add [String!]	Labels to add. Each must already be defined in the title-tag registry, and reserved scryer: entries are rejected.
remove [String!]	Labels to remove. A label the registry no longer defines may still be removed, so a deleted tag can always be cleared off a series movie.

UpdateServiceSettingsInput

TLS certificate and private-key filesystem paths.

Arguments

Name	Description
tlsCertPath String!	Absolute TLS certificate path.
tlsKeyPath String!	Absolute TLS private-key path.

UpdateSubtitleProviderConfigInput

Patch for an existing subtitle provider.

Arguments

Name	Description
id ID!	Subtitle-provider configuration identity to patch.
name String	Replacement display name; omission preserves it.
providerType String	Replacement provider implementation; omission preserves it.
config [ProviderConfigValueInput!]	Replacement provider configuration; omitted secret fields retain stored secrets.
enabledFacets [MediaFacetValue!]	Replacement enabled facets; omission preserves them.
isEnabled Boolean	Replacement enabled state; omission preserves it.
disabledUntil DateTime	Disable-until timestamp: omission preserves it, null clears it, and a value replaces it.

UpdateSubtitleSettingsInput

Subtitle acquisition, translation, and synchronization settings.

Arguments

Name	Description
enabled Boolean!	Whether subtitle processing is enabled.
languages [SubtitleLanguagePreferenceInput!]!	Ordered language preferences.
autoDownloadOnImport Boolean!	Whether subtitles are downloaded automatically after import.
minimumScoreSeries Int!	Minimum provider score for series subtitles.
minimumScoreMovie Int!	Minimum provider score for movie subtitles.
searchIntervalHours Int!	Search interval in hours.
includeAiTranslated Boolean!	Whether AI-translated subtitles are accepted.
includeMachineTranslated Boolean!	Whether machine-translated subtitles are accepted.
syncEnabled Boolean!	Whether subtitle synchronization is enabled.
syncThresholdSeries Int!	Synchronization threshold for series subtitles.
syncThresholdMovie Int!	Synchronization threshold for movie subtitles.
syncMaxOffsetSeconds Int!	Maximum synchronization offset in seconds.

UpdateTitleInput

Patch for title metadata and settings.

Arguments

Name	Description
titleId ID!	Title identity to patch.
name String	Replacement title name; omission preserves it.
facet MediaFacetValue	Replacement facet; omission preserves it.
tags [String!]	Replacement tag list; omission preserves it and an empty list clears tags.
options TitleOptionsInput	Optional title settings patch.

UpdateTitleTagDefinitionInput

Title-tag rename or description change.

Arguments

Name	Description
id ID!	Title-tag definition to change.
label String	Replacement label; omitted or null leaves the label alone. A rename rewrites every title and delay profile carrying the old label.
description String	Replacement description; omitted leaves it alone, and null clears it.

UpdateTitleTagsInput

User-tag additions and removals applied across a set of titles.

Arguments

Name	Description
titleIds [ID!]!	Titles to patch. Every title's library is checked before the first write, so a set containing one title the caller cannot manage changes nothing.
add [String!]	Labels to add. Each must already be defined in the title-tag registry, and reserved scryer: entries are rejected.
remove [String!]	Labels to remove. A label the registry no longer defines may still be removed, so a deleted tag can always be cleared off a title.

UpdateVerificationSettingsInput

Verification depth applied to download-client completed-download copies. Location operations (library moves, root changes, consolidations) always verify in full and ignore this preference: they move the only copy of the content, so the stronger guarantee is a floor rather than a choice.

Arguments

Name	Description
depth VerificationDepthValue!	Depth applied when proving a copied file before its source is touched.

ValidateExternalImportConnectionInput

External service kind and credentials to validate.

Arguments

Name	Description
kind ExternalImportConnectionKind!	External service kind.
connection ExternalImportConnectionInput!	Base URL and API key to validate.

ValidateMaintenanceRuleInput

Validates maintenance rule source without saving it.

Arguments

Name	Description
regoSource String!	Matcher source to validate, as written in the editor.

ValidateRequestRuleInput

Validates request rule source without saving it.

Arguments

Name	Description
regoSource String!	Matcher source to validate, as written in the editor.

ValidateRuleSetInput

Validates Rego source, optionally in the context of an existing rule set.

Arguments

Name	Description
regoSource String!	Rego source to validate.
ruleSetId ID	Existing rule-set ID for context, or null for standalone validation.

WebauthnCompleteInput

WebAuthn assertion response paired with a previously issued challenge.

Arguments

Name	Description
challengeId ID!	ID of the WebAuthn challenge to complete.
responseJson JSON!	Browser assertion JSON; credential material is consumed for verification and not echoed.
persistSession Boolean	Whether the returned session should persist; absent or null uses the request policy.

WebauthnRegisterCompleteInput

WebAuthn registration response paired with a previously issued challenge.

Arguments

Name	Description
challengeId ID!	ID of the WebAuthn registration challenge.
responseJson JSON!	Browser registration JSON; credential material is consumed for verification and not echoed.
friendlyName String	Optional display name for the new passkey; absent or null leaves it unset.