Skip to content

Objects

Result of giving up on an operation nobody is running.

Fields

NameDescription
id
ID!

Operation the abandon was requested for.

abandoned
Boolean!

Whether the operation was marked failed and its titles and roots released. False when it had already stopped on its own.

detail
String

Why it was left alone, when it was.

Progress snapshot for a background acquisition search.

Fields

NameDescription
jobRun
JobRunPayload

Accepted job snapshot for shared live tracking; absent in legacy query projections.

id
ID!

Acquisition-search job ID.

state
AcquisitionSearchJobStateValue!

Current job lifecycle state.

total
Int!

Total search targets.

processed
Int!

Number of targets processed.

grabbedCount
Int!

Number of releases grabbed.

failedCount
Int!

Number of target searches that failed.

currentTitle
String

Title currently being processed, or null when idle or complete.

startedAt
DateTime!

UTC job start time.

finishedAt
DateTime

UTC completion time, or null while running.

Acquisition worker enablement and polling or convergence limits.

Fields

NameDescription
enabled
Boolean!

Whether automatic acquisition is enabled.

upgradeCooldownHours
Int!

Upgrade cooldown in hours.

sameTierMinDelta
Int!

Minimum score delta for same-tier upgrades.

crossTierMinDelta
Int!
Deprecated: Inert since 0.18.17: quality tier is compared before score, so no cross-tier delta is consulted. The value is stored and ignored; the field will be removed in a later minor.

Deprecated and inert. Quality tier is compared before score, so no score delta ever sees a cross-tier comparison; the stored value is returned unchanged and ignored by acquisition. Scheduled for removal in a later minor.

forcedUpgradeDeltaBypass
Int!

Score delta that bypasses normal forced-upgrade thresholds.

pollIntervalSeconds
Int!

Acquisition polling interval in seconds.

longTailBackfillMaxScopesPerCycle
Int!

Maximum long-tail scopes processed per cycle.

longTailReconvergeDays
Int!

Number of days before long-tail scopes are reconverged.

A queued or active import operation. This reports real import work only, never worker capacity.

Fields

NameDescription
id
ID!

Opaque runtime identity for this active import stream.

importId
ID!

Identifier of the persisted import record.

libraryId
ID!

Identifier of the library receiving the import.

facet
MediaFacetValue!

Media category of the import target.

sourcePath
String!

Filesystem path of the source file or extraction directory.

destinationPath
String!

Filesystem path where the import is being placed.

phase
ActiveImportStreamPhaseValue!

Current runtime phase of the import.

bytes
Long!

Number of source bytes transferred so far.

totalBytes
Long!

Total source bytes expected for the transfer, or zero when unavailable.

queuedAt
DateTime!

Time the import entered the active worker queue.

startedAt
DateTime

Time work began, or null while the import remains queued.

updatedAt
DateTime!

Time this stream was last updated.

cancellable
Boolean!

Whether this stream can still be cancelled.

cancellationRequested
Boolean!

Whether cancellation has been requested and is being processed.

Revision metadata for active import stream updates.

Fields

NameDescription
revision
Long!

Monotonic revision for active import stream changes.

updatedAt
DateTime

Time active import streams last changed, or null before the first change.

Activity notification with delivery channels and actor context.

Fields

NameDescription
id
ID!

ID of the activity event.

kind
ActivityKindValue!

Activity kind.

severity
ActivitySeverityValue!

Activity severity.

channels
[ActivityChannelValue!]!

Channels associated with the activity.

actorKind
ActorKindValue!

Origin of the actor that caused the activity.

actorUserId
ID

ID of the user actor, or null for anonymous or system activity.

actorDisplayName
String!

Display name of the actor.

titleId
ID

ID of the affected title, or null when not title-scoped.

facet
MediaFacetValue

Media facet, or null when not facet-scoped.

episodeIds
[ID!]!

Episodes affected by the activity when it originated from an import.

message
String!

Human-readable activity message.

occurredAt
DateTime!

UTC time when the activity occurred.

Title-history event counts for one dashboard activity window.

Fields

NameDescription
grabbed
Int!

Releases grabbed during the window.

upgraded
Int!

Existing files replaced by a better release during the window.

imported
Int!

Imports that completed during the window.

importFailed
Int!

Imports rejected as failed during the window; skipped imports are excluded.

downloadFailed
Int!

Downloads that failed during the window.

Result of adding or reusing a title and optionally queuing its acquisition.

Fields

NameDescription
title
TitlePayload!

Title created or reused by the operation.

metadataHydrationState
AddTitleHydrationStateValue!

Metadata processing outcome, including whether work was accepted or completed.

reusedExistingTitle
Boolean!

Whether an existing title matched the requested identity.

reusedQueuedDownload
Boolean!

Whether an existing queued download was reused instead of creating another one.

downloadJobId
ID

Identifier of the metadata or acquisition job, or null when no job was created.

queuedDownload
QueueDownloadPayload

Queued download created or reused by the operation, or null when nothing was queued.

Non-secret API-key metadata.

Fields

NameDescription
id
ID!

API-key record ID.

label
String!

Human-readable label.

actor
String!

Auditable identity used for requests made with this key.

expiresAt
DateTime

UTC expiry time, or null when the key does not expire.

revokedAt
DateTime

UTC revocation time, or null while active.

lastUsedAt
DateTime

UTC last successful-use time, or null when unused.

createdAt
DateTime!

UTC creation time.

provisioningSource
String!

Provisioning source (user or environment).

Durable job run accepted for an application upgrade.

Fields

NameDescription
jobRun
JobRunPayload!

The registered application-upgrade job.

Current update availability and installation eligibility.

Fields

NameDescription
currentVersion
String!

Running application version.

updateVersion
String

Available application version, or null when no update notice exists.

updateTag
String

Available release tag, or null when no update notice exists.

updateAvailable
Boolean!

Whether the current update notice offers a newer version.

installationKind
ApplicationInstallationKindValue!

Installation layout identified at startup.

managementOwner
ApplicationUpgradeOwnerValue!

Party responsible for managing application upgrades.

eligible
Boolean!

Whether this installation is eligible for an in-app upgrade.

eligibilityReason
String!

Stable snake_case code explaining eligibility.

activeRun
JobRunPayload

In-memory application-upgrade job still running in this process, if any.

latestRun
JobRunPayload

Most recent persisted application-upgrade job, if any.

Result of approving a media request.

Fields

NameDescription
titleId
ID!

Title identity created or updated by approval.

wantedSearch
WantedSearchPayload

Search counts when approval queued acquisition work.

searchError
String

Non-fatal search error when approval succeeded but search could not be queued.

claimError
String

Non-fatal claim error when the title was created and the request resolved, but the retention claim could not be written. The approval is deliberately not rolled back: the requester has their title, and an operator can re-pin it by hand.

Audio stream metadata for a media file.

Fields

NameDescription
profile
String

Codec profile, or null when unavailable.

name
String

Original container track name, or null when absent.

codec
String

Codec name, or null when unavailable.

channels
Int

Number of audio channels, or null when unavailable.

language
String

Language code, or null when unavailable.

inferredLanguage
String

Language inferred from the track name when the container has no language field for this track, or null when the track is tagged or nothing can be inferred.

bitrateKbps
Int

Bitrate in kilobits per second, or null when unavailable.

Effective authentication runtime flags after configuration and environment overrides.

Fields

NameDescription
effectiveFormLoginEnabled
Boolean!

Effective form-login state.

skipLoginForLocalIps
Boolean!

Whether local IPs may skip login.

passkeyEnabled
Boolean!

Whether passkey authentication is enabled.

defaultPersistSession
Boolean!

Whether this request's network provenance defaults sessions to persistent storage.

envOverrideActive
Boolean!

Whether an environment override is active.

mfaRequirePasswordLogin
Boolean!

Whether password login is required alongside MFA.

mfaRequireConfigStepUp
Boolean!

Whether configuration changes require MFA step-up.

mfaRequireJellyfinLogin
Boolean!

Whether Jellyfin login requires an enrolled authentication factor.

mfaRequireEmbyLogin
Boolean!

Whether Emby login requires an enrolled authentication factor.

totpRequireJellyfinLogin
Boolean!
Deprecated: Use mfaRequireJellyfinLogin.

Deprecated alias for mfaRequireJellyfinLogin.

totpRequireEmbyLogin
Boolean!
Deprecated: Use mfaRequireEmbyLogin.

Deprecated alias for mfaRequireEmbyLogin.

Automatic backup schedule and encryption-key readiness.

Fields

NameDescription
enabled
Boolean!

Whether automatic backups are enabled.

dailyTimeLocal
String!

Daily local-time schedule in the service's configured time format.

autoBackupKeyPresent
Boolean!

Whether the automatic-backup encryption key is present.

autoBackupDisabledMissingKeyNotice
Boolean!

Whether automatic backup is disabled because the key is missing.

nextRunAt
DateTime

Next scheduled run in UTC, or null when no run is scheduled.

Provides a temporary authorization token and route for downloading one backup.

Fields

NameDescription
downloadUrl
String!

HTTP path from which the selected backup can be downloaded.

downloadAuthorizationToken
String!

Short-lived token authorizing the backup download.

expiresAt
DateTime!

UTC timestamp after which the download token is invalid.

Metadata and lifecycle result for one backup file.

Fields

NameDescription
filename
String!

Backup filename.

sizeBytes
Long!

Backup size in bytes.

createdAt
DateTime!

Backup creation time in UTC.

formatVersion
String!

Backup format version.

sourceEngine
String!

Database engine that produced the backup.

sourceMigrationKey
String

Source migration key, when recorded.

encrypted
Boolean!

Whether the backup is encrypted.

rowCounts
[BackupRowCountPayload!]!

Counts of rows included by table.

trigger
String!

Operation that created the backup.

status
String!

Backup lifecycle status.

errorMessage
String

Failure detail, or null when the operation succeeded.

Row count for one table in a backup.

Fields

NameDescription
table
String!

Table name.

rowCount
Long!

Number of rows copied from the table.

Configured, default, and effective backup paths.

Fields

NameDescription
customBackupPath
String

Custom backup path, or null when the default path is used.

defaultBackupPath
String!

Service default backup path.

effectiveBackupPath
String!

Effective path selected after applying the custom override.

Reports the result of deleting and blocklisting an external subtitle.

Fields

NameDescription
id
ID!

External subtitle ID targeted by the operation.

blocklisted
Boolean!

Whether the subtitle was deleted and its provider result blocklisted.

Stored boolean provider configuration value.

Fields

NameDescription
value
Boolean!

Boolean value.

Calendar episode with title, library, monitoring, and air-date context.

Fields

NameDescription
id
ID!

Episode ID.

titleId
ID!

Parent title ID.

libraryId
ID!

ID of the library containing the parent title.

libraryName
String

Library name, or null when unavailable.

librarySlug
String

Library slug, or null when unavailable.

titleName
String!

Display name of the parent title.

titleSlug
String

Title slug, or null when unavailable.

titleFacet
String!

Title facet string.

seasonNumber
String

Season number text, or null when unavailable.

episodeNumber
String

Episode number text, or null when unavailable.

episodeTitle
String

Episode title, or null when unavailable.

overview
String

Movie or episode overview, or null when unavailable.

imageUrl
String

Proxied movie poster or episode-still URL.

airDate
Date

Air date, or null when unavailable.

monitored
Boolean!

Whether both the episode and its parent title are monitored.

mediaAvailability
EpisodeMediaAvailabilityPayload!

Compact availability derived from the episode's primary media file.

playbackLinks
[MediaServerPlaybackLinkPayload!]!

Provider-native playback links available to the current user.

Result of requesting cancellation for an acquisition search.

Fields

NameDescription
id
ID!

Acquisition-search job ID.

accepted
Boolean!

True when cancellation was accepted; false when the search was already terminal.

Result of canceling an external import monitor warmup.

Fields

NameDescription
sessionId
ID!

Warmup session ID.

canceled
Boolean!

Whether cancellation changed the session state.

Result of requesting cancellation for an interactive release search.

Fields

NameDescription
id
ID!

Interactive search job ID.

accepted
Boolean!

True when cancellation was accepted; false when the search was already terminal.

Result of requesting cancellation for a library scan.

Fields

NameDescription
sessionId
ID!

Library-scan session ID.

accepted
Boolean!

True when cancellation was accepted; false when the scan was already terminal.

Result of requesting cancellation; the runner stops at the next title checkpoint.

Fields

NameDescription
id
ID!

Operation the cancel was requested for.

cancelRequested
Boolean!

Whether the request was recorded; false when the operation already finished.

Canonical metadata tag with provenance and content-safety flags.

Fields

NameDescription
key
String!

Stable canonical tag key.

category
String!

Canonical tag category.

name
String!

Display name for the tag.

confidence
Float

Confidence score from 0 through 1 when supplied by the source.

sources
[String!]!

Source names contributing this tag.

sourceTagKeys
[String!]!

Original provider tag keys that mapped to this canonical tag.

isAdult
Boolean!

Whether the tag is marked adult.

isSpoiler
Boolean!

Whether the tag is marked spoiler-sensitive.

Canonical tag key and display name used by discovery filters.

Fields

NameDescription
key
String!

Stable canonical tag key accepted by discovery filters.

name
String!

Display name associated with the canonical key.

One catalog discovery group with surface, count, and bounded items.

Fields

NameDescription
id
String!

Stable group identifier.

kind
CatalogDiscoveryGroupKindValue!

Reason this group was selected.

surface
CatalogDiscoverySurfaceValue!

Public or personalized origin of the group.

labelValue
String

Optional label value, such as a genre or theme key.

totalCount
Long!

Total matching items before the returned item page is applied.

items
[DiscoveryItemPayload!]!

Items returned for this group.

Catalog discovery response containing authorization state and grouped results.

Fields

NameDescription
canViewPersonalized
Boolean!

Whether the caller may view personalized groups.

groups
[CatalogDiscoveryGroupPayload!]!

Discovery groups returned in selection order; empty means no group qualified.

Result of applying a folder-match correction.

Fields

NameDescription
outcome
FolderMatchOutcomeValue!

What the correction actually did.

title
FolderMatchTitleRefPayload!

The edited title after the change.

previousFolderPath
String

Folder the edited title owned before, or null when it owned none.

detachedMediaFileCount
Int!

Media associations detached because a title gave up a folder.

scan
LibraryScanSummaryPayload

Rescan of the edited title's new folder, or null for a no-op.

swappedTitle
FolderMatchTitleRefPayload

The other title after a swap, with the folder it received.

swappedTitleScan
LibraryScanSummaryPayload

Rescan of the swapped title's new folder.

displacedTitle
DisplacedTitleRepairPayload

The title left unmatched by a takeover, or null when none was displaced.

Read-only description of a proposed folder-match correction.

Fields

NameDescription
title
FolderMatchTitleRefPayload!

The title being edited.

facet
MediaFacetValue!

Media facet of the title being edited.

libraryId
ID!

Library that owns the title and every candidate folder.

libraryName
String!

Library display name.

currentRootId
ID

Root containing the title's current folder, or null when it owns none.

currentRootPath
String

Path of the root containing the title's current folder.

selectedFolderPath
String!

Candidate folder, normalized to its stored form.

selectedRootId
ID!

Root containing the candidate folder; always a root of the title's library.

selectedRootPath
String!

Path of the root containing the candidate folder.

ownership
FolderMatchOwnershipValue!

How the candidate folder relates to the title being edited.

currentOwner
FolderMatchTitleRefPayload

The other title holding the candidate folder, or null when unowned.

currentFolderTrackedMediaCount
Int!

Tracked media rows the title currently has inside its existing folder.

selectedFolderTrackedMediaCount
Int!

Tracked media rows inside the candidate folder, counted across the title being edited and the candidate folder's owner.

filesWillMove
Boolean!

Always false: correcting a folder match never moves file content.

noOp
Boolean!

Whether the title already owns the candidate folder, making this a no-op.

availableResolutions
[FolderMatchResolutionValue!]!

Resolutions this exact selection admits.

ClearExternalImportSetupSecretDraftPayload

Section titled “ClearExternalImportSetupSecretDraftPayload”

Result of clearing the current user’s external import secret draft.

Fields

NameDescription
cleared
Boolean!

False when there was no draft owned by the caller to clear.

Accepted request to clear cached title images.

Fields

NameDescription
requestedAt
DateTime!

When the cache-clear request was accepted.

Identity returned after clearing a title release blocklist entry.

Fields

NameDescription
id
ID!

Cleared release-blocklist entry identity.

An ordered season, collection, or other grouped set of episodes for a title.

Fields

NameDescription
id
ID!

Stable collection identifier.

titleId
ID!

Identifier of the title owning this collection.

collectionType
CollectionTypeValue!

Collection kind, such as a season or special grouping.

collectionIndex
String!

Domain-specific collection index, preserved as text for non-numeric values.

label
String

Human-readable collection label, or null when unavailable.

orderedPath
String

Ordered path used to place this collection among its parent collections, or null when absent.

narrativeOrder
String

Narrative ordering value, or null when the source does not provide one.

firstEpisodeNumber
String

First episode number in the collection, or null when no episode number is known.

lastEpisodeNumber
String

Last episode number in the collection, or null when no episode number is known.

monitored
Boolean!

Whether acquisition and monitoring are enabled for this collection.

createdAt
DateTime!

Time when the collection record was created, in UTC.

sizeBytes
Long

Aggregated live media-file size for this collection.

fileSizeBytes
Long

Size in bytes of the media file associated with this collection, or null when unavailable.

episodesOwned
Int

Owned-vs-total episode progress for this collection, populated when requested.

episodesMonitored
Int

Monitored episode count for this collection, populated when requested.

episodesTotal
Int

Total countable episode count for this collection, populated when requested.

episodeRecordsTotal
Int

Total episode records in this collection including uncountable placeholders (TBA/undated), populated when requested.

title
TitlePayload

Parent title for this collection, or null if the title is no longer available to the caller.

episodes
[EpisodePayload!]!

Episodes belonging to this collection, or an empty list when none are available.

Union member identifying a collection by ID.

Fields

NameDescription
collectionId
ID!

Target collection ID.

Result of completing initial application setup.

Fields

NameDescription
completed
Boolean!

Whether setup is now complete.

Creation result. apiKey is shown once and must be stored by the caller.

Fields

NameDescription
apiKey
String!

Generated raw API key. This is never returned again.

key
ApiKeyPayload!

Non-secret metadata for the generated key.

One cutoff-unmet target with its current and target quality tiers and convergence state.

Fields

NameDescription
titleId
ID!

Target title ID.

titleName
String!

Title display name.

titleSlug
String

Title slug, or null when unavailable.

titleFacet
MediaFacetValue!

Media facet containing the title.

libraryId
ID!

Library ID containing the title.

libraryName
String

Library name, or null when unavailable.

librarySlug
String

Library slug, or null when unavailable.

episodeId
ID

Episode ID for episodic targets, or null for title-level targets.

seasonNumber
String

Season number as parsed text, or null when unavailable.

episodeNumber
String

Episode number as parsed text, or null when unavailable.

currentTier
String!

Current quality tier.

targetTier
String!

Required target quality tier.

convergenceState
ConvergenceStateValue!

Convergence state for this upgrade scope.

indexersCovered
Int!

Number of indexers covering the target.

indexersRouted
Int!

Number of indexers selected by routing.

One page of cutoff-unmet targets plus the full matching count.

Fields

NameDescription
items
[CutoffUnmetItemPayload!]!

Items in the requested page.

totalCount
Int!

Total matching targets before pagination.

hasMore
Boolean!

Whether more matching targets exist after this page.

A trailing activity window together with the window immediately before it, so callers can render each count with its period-over-period delta.

Fields

NameDescription
current
ActivityWindowCountsPayload!

Counts for the trailing window ending at the time of the request.

previous
ActivityWindowCountsPayload!

Counts for the equally long window immediately before the current one.

Count of wanted items grouped by decision code.

Fields

NameDescription
code
String!

Decision code.

count
Int!

Number of wanted items with this code.

Global default seeding profile after an assignment change.

Fields

NameDescription
seedingProfileId
ID

Seeding profile identity used as the default, or null when unset.

minimumSeedersFloor
Int!

Fewest seeders a torrent candidate may report when no seeding profile resolves.

Identifier returned after requesting delay-profile deletion.

Fields

NameDescription
id
ID!

Deleted delay-profile ID.

Delay profile controlling protocol timing and acquisition bypass rules.

Fields

NameDescription
id
ID!

Delay-profile ID.

name
String!

Delay-profile name.

usenetDelayMinutes
Int!

Usenet delay in minutes.

torrentDelayMinutes
Int!

Torrent delay in minutes.

enableUsenet
Boolean!

Whether Usenet releases are eligible for this profile.

enableTorrent
Boolean!

Whether torrent releases are eligible for this profile.

preferredProtocol
DelayProfilePreferredProtocolValue!

Preferred protocol after delay eligibility.

minAgeMinutes
Int!

Minimum release age in minutes.

bypassScoreThreshold
Int

Score threshold that bypasses delay, or null when disabled.

bypassIfHighestQuality
Boolean!

Whether the highest-quality release bypasses its eligible delay.

appliesToFacets
[MediaFacetValue!]!

Media facets to which the profile applies.

tags
[String!]!

Tags used to select this profile.

priority
Int!

Lower values run with higher priority according to service ordering.

enabled
Boolean!

Whether the profile is enabled.

Result of attempting to delete a backup file.

Fields

NameDescription
filename
String!

Filename targeted by the deletion.

deleted
Boolean!

False when no backup file with that name existed.

Result of deleting a download-client configuration.

Fields

NameDescription
id
ID!

Deleted download-client identity.

clearedIndexerMappingCount
Int!

Number of indexer mappings cleared as a consequence.

Per-file result within a multi-episode media-file deletion preview.

Fields

NameDescription
fileId
ID!

Media-file identity that would be deleted.

episodeId
ID!

First requested episode the media file is linked to.

episodeIds
[ID!]!

Every requested episode the media file is linked to. A multi-episode file is deleted once but covers each of these episodes.

preview
DeletePreviewPayload

Deletion preview for this file, or null when preview generation failed.

error
String

Error message, or null when preview generation succeeded.

Accepted media-file IDs and background job information for a multi-episode media-file deletion request.

Fields

NameDescription
jobRun
JobRunPayload!

Background job run tracking the deletion work.

acceptedFileIds
[ID!]!

Media-file identities accepted for processing.

Combined deletion preview for the media files of several episodes of one title.

Fields

NameDescription
preview
DeletePreviewPayload!

Aggregate preview across all resolved media files.

items
[DeleteEpisodeFilePreviewResultPayload!]!

Per-file results, ordered by media-file identity.

fileCount
Int!

Number of media files resolved from the requested episodes.

failedCount
Int!

Number of media files that failed preview generation.

Reports the result of deleting an external subtitle.

Fields

NameDescription
id
ID!

External subtitle ID targeted by the deletion.

deleted
Boolean!

Whether the subtitle file and tracked record were deleted.

Identity returned after deleting an indexer configuration.

Fields

NameDescription
id
ID!

Deleted indexer configuration identity.

Identity returned after deleting a library.

Fields

NameDescription
id
ID!

Deleted library identity.

Identifier returned after removing a maintenance exclusion.

Fields

NameDescription
id
ID!

Removed exclusion ID.

Identifier returned after deleting a maintenance rule set.

Fields

NameDescription
id
ID!

Deleted rule-set ID.

Result of a media-file deletion request.

Fields

NameDescription
id
ID!

Deleted media-file identity.

jobRun
JobRunPayload!

Background job accepted to complete deletion and related cleanup.

Identity returned after deleting a media-server connection.

Fields

NameDescription
id
ID!

Deleted connection identity.

Acknowledgement containing the ID of a deleted passkey.

Fields

NameDescription
id
ID!

ID of the deleted passkey.

Identifier of a deleted notification channel.

Fields

NameDescription
id
ID!

Deleted notification channel ID.

Identifier of a deleted notification subscription.

Fields

NameDescription
id
ID!

Deleted notification subscription ID.

Result of deleting a custom OAuth application.

Fields

NameDescription
clientId
String!

Deleted OAuth client identifier.

deleted
Boolean!

Whether a persisted custom registration was removed.

Identifier of a deleted post-processing script.

Fields

NameDescription
id
ID!

Deleted script ID.

Read-only media deletion preview with confirmation and sample-path details.

Fields

NameDescription
fingerprint
String!

Stable preview fingerprint required to apply the same plan.

totalFileCount
Int!

Total files selected by the preview.

mediaCount
Int!

Selected media-file count.

subtitleCount
Int!

Selected subtitle-file count.

imageCount
Int!

Selected image-file count.

otherCount
Int!

Selected other-file count.

directoryCount
Int!

Selected directory count.

requiresTypedConfirmation
Boolean!

Whether typed confirmation is required before applying the plan.

typedConfirmationPrompt
String

Required confirmation text, or null when typed confirmation is not required.

targetLabel
String!

Human-readable preview target label.

samplePaths
[String!]!

Sample paths from the selected files and directories.

Identity returned after deleting a proxy.

Fields

NameDescription
id
ID!

Deleted proxy configuration identity.

Result of deleting one recycle-bin entry.

Fields

NameDescription
id
ID!

Recycle-bin entry ID.

deleted
Boolean!

Whether the recycle-bin record and file were deleted.

Accepted background deletion for multiple recycle-bin entries.

Fields

NameDescription
ids
[ID!]!

Recycle-bin entry IDs accepted for deletion.

jobRun
JobRunPayload!

Background job accepted for the deletion operation.

Identifier returned after deleting a request rule set.

Fields

NameDescription
id
ID!

Deleted rule-set ID.

Identifier returned after deleting a rule set.

Fields

NameDescription
id
ID!

Deleted rule-set ID.

Identity returned after deleting a seeding profile.

Fields

NameDescription
id
ID!

Deleted seeding profile identity.

Identity returned after deleting a subtitle provider.

Fields

NameDescription
id
ID!

Deleted subtitle-provider identity.

Identity returned after deleting a title.

Fields

NameDescription
id
ID!

Deleted title identity.

Per-title result within a multi-title deletion preview.

Fields

NameDescription
titleId
ID!

Target title ID.

preview
DeletePreviewPayload

Deletion preview, or null when preview generation failed.

error
String

Error message, or null when preview generation succeeded.

Accepted title IDs and background job information for a deletion request.

Fields

NameDescription
jobRun
JobRunPayload!

Background job run tracking the deletion work.

acceptedTitleIds
[ID!]!

Title IDs accepted for processing.

Combined deletion preview for multiple titles.

Fields

NameDescription
preview
DeletePreviewPayload!

Aggregate preview across all successful title targets.

items
[DeleteTitlePreviewResultPayload!]!

Per-title results.

failedCount
Int!

Number of title targets that failed preview generation.

Identifier returned after uninstalling a tracked rule pack.

Fields

NameDescription
packId
String!

Immutable registry rule-pack ID.

Identity returned after deleting a user.

Fields

NameDescription
id
ID!

Deleted user identity.

Directory entry returned while browsing a configured path.

Fields

NameDescription
name
String!

Entry name.

path
String!

Entry path.

isDirectory
Boolean!

Whether the entry is a directory rather than a file.

Content certification for one country and release type.

Fields

NameDescription
value
String!

Certification value, such as an age category.

source
String!

Authority or source that supplied the certification.

releaseType
Int

Release-type code, or null when the source did not specify one.

Country-specific content ratings and their certifications.

Fields

NameDescription
country
String!

ISO-like country code supplied by the source.

certifications
[DiscoveryContentCertificationPayload!]!

Certifications reported for this country.

ageRating
Int

Numeric age rating, or null when unavailable.

ageRatingSource
String

Source of the numeric age rating, or null when unavailable.

External identifier associated with a discovery item.

Fields

NameDescription
source
String!

External source name.

kind
String!

External identifier kind.

id
String!

Provider-issued identifier value.

key
String!

Canonical composite key for the external identity.

Rating from an external source, including normalized score and optional vote count.

Fields

NameDescription
source
String!

External rating source name.

value
Float

Source-specific raw value, or null when unavailable.

score
Float

Source-specific score, or null when unavailable.

normalized
Float!

Normalized score used for cross-source comparison.

votes
Int

Number of votes reported by the source, or null when unavailable.

url
String!

Source URL for the rating record.

Discovery facet counts for external and local catalog matches.

Fields

NameDescription
name
String!

Human-readable facet name.

value
String!

Stable facet value.

smgCount
Long

External discovery count, or null when unavailable.

localCount
Long

Local owned-title count, or null when unavailable.

Compact discovery card identity and display metadata.

Fields

NameDescription
id
ID!

Stable local or discovery-card ID for this result.

targetKey
String!

Stable discovery target key used for detail lookup.

targetKind
MediaFacetValue!

Kind of target represented by the card.

displayTitle
String!

Display title selected for this card.

originalTitle
String

Original source title when it differs from the display title, or null.

sortTitle
String

Normalized sort title when available, or null.

year
Int

Release year, or null when unavailable.

posterUrl
String

Poster URL, or null when no poster is available.

contentType
MediaFacetValue!

Content facet represented by the card.

isAdult
Boolean!

Whether the source metadata marks the content as adult.

ownedInInput
Boolean!

Whether the target is already owned in the input scope.

Card-oriented discovery home response with synchronization status and optional hero and sections.

Fields

NameDescription
status
DiscoverySyncStatusPayload!

Synchronization readiness and pending-context information.

heroItem
DiscoveryHomeHeroPayload

Selected hero card, or null when no eligible card exists.

publicSections
[DiscoveryHomeSectionPayload!]!

Public card sections; empty means no public section was selected.

personalizedSections
[DiscoveryHomeSectionPayload!]!

Personalized card sections; empty when unavailable or no items qualify.

completeCollection
DiscoveryHomeSectionPayload

Complete-collection card section, or null when none is available.

canViewPersonalized
Boolean!

Whether the caller may view personalized cards.

Available discovery-home filter values for genres, themes, and studios.

Fields

NameDescription
genres
[CanonicalTagFilterOptionPayload!]!

Canonical genre options; empty means no matching genre option exists.

themes
[CanonicalTagFilterOptionPayload!]!

Canonical theme options; empty means no matching theme option exists.

studioSlugs
[String!]!

Studio slugs available in the selected scope.

Expanded discovery hero metadata, ratings, tags, and ownership state.

Fields

NameDescription
id
ID!

Stable local or discovery-card ID for this result.

targetKey
String!

Stable discovery target key used for detail lookup.

targetKind
MediaFacetValue!

Kind of target represented by the hero.

displayTitle
String!

Display title selected for the hero.

originalTitle
String

Original source title when it differs from the display title, or null.

sortTitle
String

Normalized sort title when available, or null.

year
Int

Release year, or null when unavailable.

posterUrl
String

Poster URL, or null when no poster is available.

backgroundUrl
String

Background artwork URL, or null when unavailable.

overview
String

Overview text, or null when unavailable.

contentType
MediaFacetValue!

Content facet represented by the hero.

isAdult
Boolean!

Whether the source metadata marks the content as adult.

rating
Float

Primary rating on the source's normalized scale, or null when unavailable.

ratingSources
[String!]!

Names of rating sources contributing to the primary rating.

externalRatings
[DiscoveryExternalRatingPayload!]!

External ratings with source-specific values and vote counts.

genreTags
[CanonicalMediaTagPayload!]!

Canonical genre and theme tags associated with the hero.

matchedSubjectCount
Int!

Number of subject matches contributing to this hero selection.

ownedInInput
Boolean!

Whether the target is already owned in the input scope.

Discovery home response with synchronization status, selected sections, facets, and authorization state.

Fields

NameDescription
status
DiscoverySyncStatusPayload!

Synchronization readiness and pending-context information used to interpret the result.

heroItem
DiscoveryItemPayload

Selected hero item, or null when no eligible item exists.

publicSections
[DiscoverySectionPayload!]!

Public sections; an empty list means no public section was selected.

personalizedSections
[DiscoverySectionPayload!]!

Personalized sections; empty when unavailable or no items qualify.

completeCollection
DiscoverySectionPayload

Complete-collection section, or null when none is available.

facets
[DiscoveryFacetPayload!]!

Facet summaries returned for the selected discovery scope.

canViewPersonalized
Boolean!

Whether the caller may view personalized results.

A titled discovery home section with its source surface, total count, and bounded items.

Fields

NameDescription
sectionId
String!

Stable section identifier.

sectionType
String!

Section classification value.

title
String!

Human-readable section title.

surface
DiscoverySurfaceValue!

Whether this section is public, personalized, or mixed.

totalCount
Long!

Total matching items before the returned item page is applied.

items
[DiscoveryHomeCardPayload!]!

Items returned for this section, possibly fewer than the total.

Detailed discovery item with resolution, metadata, relationships, provenance, and ownership state.

Fields

NameDescription
id
ID!

Stable local or discovery-item ID.

targetKey
String!

Stable discovery target key used for detail lookup.

targetKind
String!

Target kind string supplied by the discovery source.

resolved
Boolean!

Whether the target resolved to a local title.

resolvedTitleId
ID

Local title ID when resolved, or null when unresolved.

displayTitle
String!

Display title selected from available metadata.

originalTitle
String

Original source title when available.

sortTitle
String

Normalized sort title when available.

year
Int

Release year, or null when unavailable.

posterUrl
String

Poster URL, or null when unavailable.

backgroundUrl
String

Background artwork URL, or null when unavailable.

overview
String

Overview text, or null when unavailable.

contentType
String

Content facet string, or null when the source did not classify it.

canonicalTags
[CanonicalMediaTagPayload!]!

Canonical tags associated with the item.

isAdult
Boolean!

Whether the source metadata marks the content as adult.

contentRatings
[DiscoveryContentRatingPayload!]!

Country-specific content ratings.

rating
Float

Primary normalized rating, or null when unavailable.

ratingSources
[String!]!

Names of sources contributing to the primary rating.

externalRatings
[DiscoveryExternalRatingPayload!]!

External ratings from individual providers.

externalIds
[DiscoveryExternalIdPayload!]!

External IDs associated with the item.

statusTags
[String!]!

Source-derived status tags.

sourceTags
[String!]!

Source-derived tags not mapped to canonical tags.

sources
[String!]!

Source identifiers contributing this item.

bestSource
String

Highest-priority source, or null when no source is preferred.

relationTypes
[String!]!

Relation types connecting this item to other discovery subjects.

relationSubtypes
[String!]!

Relation subtypes connecting this item to other discovery subjects.

sourceCount
Int

Number of contributing sources, or null when not computed.

edgeCount
Int

Number of discovery edges, or null when not computed.

relationCount
Int

Number of relations, or null when not computed.

sourceSubjectCount
Int

Number of matched source subjects, or null when not computed.

rankScore
Float

Ranking score used for ordering, or null when not computed.

matchedSubjectTitles
[String!]!

Titles of matched subjects contributing to this item.

matchedSubjectCount
Int!

Number of matched subjects contributing to this item.

tmdbCollectionId
String

TMDB collection ID, or null when unavailable.

tmdbCollectionName
String

TMDB collection name, or null when unavailable.

ownedInInput
Boolean!

Whether the target is already owned in the input scope.

studioSlug
String

Studio slug, or null when unavailable.

personIds
[Int!]!

Numeric person IDs associated with the item.

facetTerms
[String!]!

Facet terms extracted from the source.

contextTerms
[String!]!

Context terms extracted from the source.

Paged discovery-item results with a total count and personalization capability.

Fields

NameDescription
items
[DiscoveryItemPayload!]!

Items in the requested page; empty means no items matched.

totalCount
Long!

Total number of matching items before pagination.

canViewPersonalized
Boolean!

Whether the caller may view personalized results.

A discovery section containing a title, origin surface, count, and items.

Fields

NameDescription
sectionId
String!

Stable section identifier.

sectionType
String!

Section classification value.

title
String!

Human-readable section title.

surface
String!

Surface label for this section.

totalCount
Long!

Total matching items before the returned item page is applied.

items
[DiscoveryItemPayload!]!

Items returned for this section.

Generation markers, completion timestamps, and eligibility timestamps for discovery synchronization.

Fields

NameDescription
lastSuccessGenerationId
ID

Generation ID of the last successfully completed context snapshot, or null before the first success.

lastPublicFeedGenerationId
ID

Generation ID of the last completed public-feed build, or null when none has completed.

lastContextSnapshotCompletedAt
DateTime

UTC completion time of the last context snapshot, or null when none has completed.

lastIncrementalReloadCompletedAt
DateTime

UTC completion time of the last incremental reload, or null when none has completed.

lastPublicFeedCompletedAt
DateTime

UTC completion time of the last public-feed build, or null when none has completed.

nextContextSnapshotEligibleAt
DateTime

UTC time when another context snapshot becomes eligible, or null when no schedule is set.

nextIncrementalReloadEligibleAt
DateTime

UTC time when another incremental reload becomes eligible, or null when no schedule is set.

nextPublicFeedEligibleAt
DateTime

UTC time when another public-feed build becomes eligible, or null when no schedule is set.

updatedAt
DateTime!

UTC time when this synchronization state was last updated.

Discovery synchronization state and the number of context changes awaiting processing.

Fields

NameDescription
state
DiscoverySyncStatePayload!

Current synchronization lifecycle state and next eligible work times.

pendingContextChangeCount
Long!

Number of discovery context changes not yet incorporated into a completed snapshot.

Identifier of a dismissed pending release.

Fields

NameDescription
id
ID!

Pending release ID.

A title left without a folder by a takeover, and how it surfaces for repair.

Fields

NameDescription
id
ID!

Displaced title identity.

name
String!

Displaced title display name.

previousFolderPath
String!

Folder the displaced title no longer owns.

repairReasonCode
String!

Reason recorded on its unmatched-discovery item.

Ordered domain event envelope for stream subscriptions.

Fields

NameDescription
sequence
Long!

Monotonically increasing stream sequence.

eventId
ID!

ID of the event.

occurredAt
DateTime!

UTC time when the event occurred.

actorKind
ActorKindValue!

Origin of the actor that caused the event.

actorUserId
ID

ID of the user actor, or null for anonymous or system events.

actorDisplayName
String!

Display name of the actor.

titleId
ID

ID of the affected title, or null when not title-scoped.

facet
MediaFacetValue

Media facet, or null when not facet-scoped.

eventType
DomainEventTypeValue!

Typed domain event name.

streamKind
StreamKindValue!

Stream category containing the event.

streamId
ID

ID of the stream target, or null for the global stream.

payloadJson
JSON!

Event-specific JSON payload.

Download-client configuration with provider metadata and masked secret fields.

Fields

NameDescription
id
ID!

Download-client configuration ID.

name
String!

Download-client name.

clientType
String!

Download-client provider type.

baseUrl
String

Base URL, or null for clients without a URL.

config
[ProviderConfigValuePayload!]!

Provider configuration fields with secrets masked.

storedSecretKeys
[String!]!

Names of stored secret fields, never their values.

isEnabled
Boolean!

Whether the client is enabled.

status
String!

Current client status.

lastError
String

Most recent error, or null when none is recorded.

lastSeenAt
DateTime

UTC time the client was last observed, or null before the first observation.

disabledUntil
DateTime

UTC time this client's failure backoff expires, or null when the client is not backed off. Grabs skip a client until this time passes.

escalationLevel
Int!

Which rung of the failure backoff ladder the client is on: 0 when it is healthy, rising to 5 for a client that has been failing for an hour.

proxyConfigId
ID

Proxy carrying this client's traffic, or null when none is assigned. Any proxy kind may be assigned. A challenge solver has no effect on a native client, whose requests are not made by a plugin guest.

createdAt
DateTime!

UTC creation time.

updatedAt
DateTime!

UTC last-update time.

Download-client option used by paged queue and history filters.

Fields

NameDescription
clientId
ID!

Download-client ID.

clientName
String!

Download-client name.

clientType
String!

Download-client provider type.

Download-client routing behavior for one client.

Fields

NameDescription
clientId
ID!

Download-client ID.

enabled
Boolean!

Whether this route is enabled.

category
String

Optional category assigned to recent downloads.

recentQueuePriority
String

Priority for recent queue items, or null when unspecified.

olderQueuePriority
String

Priority for older queue items, or null when unspecified.

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.

A page of completed or failed queue history items and clients available for filtering.

Fields

NameDescription
items
[DownloadQueueItemPayload!]!

Items in the requested page in stable history order.

hasMore
Boolean!

Whether another page exists after this page.

totalCount
Int!

Number of matching history items across all pages.

availableClients
[DownloadClientFilterOptionPayload!]!

Clients represented after activity filters and before the client filter is applied.

The import actions one queue item offers, decided by the server so every client surface agrees.

Fields

NameDescription
manualImportInteractive
Boolean!

Whether a manual import should open the file-mapping dialog first.

manualImportDirect
Boolean!

Whether a manual import can run without the mapping dialog.

assignTitle
Boolean!

Whether the item can be assigned to a title.

ignore
Boolean!

Whether the item can be ignored.

markFailed
Boolean!

Whether the item can be marked failed.

A page of queue items classified for import.

Fields

NameDescription
items
[DownloadQueueItemPayload!]!

Import items in the requested page in stable order.

hasMore
Boolean!

Whether another page exists after this page.

totalCount
Int!

Number of matching import items across all pages.

Result of a queue command and the item state observed after it was issued.

Fields

NameDescription
kind
DownloadQueueActionKindValue!

Command action accepted for the queue item.

downloadClientItemId
String!

Client-local item identifier targeted by the command.

clientId
ID

Identifier of the client targeted by the command, or null when unresolved.

clientType
String

Client type targeted by the command, or null when unresolved.

importId
ID

Application import identifier affected by the command, or null when not applicable.

commandId
ID

Command identifier for tracking asynchronous work, or null when no command was created.

removed
Boolean!

Whether the item was removed from the queue.

queueItem
DownloadQueueItemPayload

Updated queue item, or null when the item was removed or is unavailable.

Queue item state with download client, import, and tracked-download information.

Fields

NameDescription
id
ID!

Identifier of this queue item.

titleId
ID

Identifier of the associated title, or null for an unmatched item.

episodeId
ID

Identifier of the associated episode, or null for title-level or unmatched items.

titleName
String!

Title name resolved for display, including an unmatched release title when needed.

facet
MediaFacetValue

Media facet of the matched title, or null when unmatched.

isScryerOrigin
Boolean!

Whether the item originated from Scryer's acquisition workflow.

sourceProvider
String

Provider label associated with the source release, or null when unknown.

clientId
ID!

Identifier of the download client owning this item.

clientName
String!

Display name of the download client.

clientType
String!

Download client type identifier.

state
DownloadQueueStateValue!

State reported by the download client.

displayState
DownloadDisplayStateValue!

Normalized state across the download client and import workflow.

progressPercent
Int!

Download progress percentage from 0 through 100.

importTransferPhase
ImportTransferPhaseValue

Import transfer stage, or null when no import transfer is active.

importTransferBytes
Long

Bytes transferred during import, or null when transfer accounting is unavailable.

importTransferTotalBytes
Long

Total bytes expected during import, or null when the total is unknown.

importTransferStartedAt
DateTime

Time the import transfer started, in UTC, or null when not started.

importTransferUpdatedAt
DateTime

Time the import transfer was last updated, in UTC, or null when not updated.

sizeBytes
Long

Download size in bytes, or null when the client has not reported it.

remainingSeconds
Int

Estimated remaining time in seconds, or null when unavailable.

queuedAt
DateTime

Time the item entered the queue, in UTC, or null when unknown.

lastUpdatedAt
DateTime

Time the client last updated the item, in UTC, or null when unknown.

attentionRequired
Boolean!

Whether the item requires attention before the workflow can proceed.

attentionReason
String

Reason for the attention flag, or null when no attention is required.

downloadClientItemId
String!

Client-local item identifier; together with client_id it identifies the remote item.

downloadId
String

Application download identifier, or null when the item is not linked to one.

importStatus
ImportStatusValue

Import lifecycle status, or null before import classification.

importErrorCode
ImportErrorCodeValue

Import failure code, or null when there is no import failure.

importErrorMessage
String

Import failure detail, or null when there is no import failure.

importedAt
DateTime

Time the item was imported, in UTC, or null before successful import.

deleteStatus
DownloadQueueDeleteStatusValue

Deletion command status, or null when no deletion was requested.

deleteErrorMessage
String

Deletion failure detail, or null when deletion has not failed.

trackedState
TrackedDownloadStateValue

Tracked-download lifecycle state, or null when no tracked record matches.

trackedStatus
TrackedDownloadStatusValue

Tracked-download status, or null when no tracked record matches.

trackedStatusMessages
[String!]!

Human-readable tracked-download status messages; empty when none are available.

trackedMatchType
TitleMatchTypeValue

Match classification for the tracked download, or null when unmatched.

seedingState
DownloadSeedingStateValue

Seeding obligation state, or null when the item carries no torrent seeding information.

seedRatio
Float

Share ratio observed by the download client, or null when it reports none.

seedRatioGoal
Float

Share ratio this download was grabbed under, or null when no profile applied.

seedTimeSeconds
Long

Seconds spent seeding as reported by the client, or null when it has no counter.

seedTimeGoalSeconds
Long

Seeding time in seconds this download was grabbed under, or null when no profile applied.

isPrivate
Boolean

Whether the torrent's metainfo carries the private flag; null when the client cannot say.

importActions
DownloadImportActionsPayload!

Import actions this download currently offers; every client surface renders from this.

queueScope
QueueDownloadScopePayload

Acquisition scope for this queue item, or its episode scope when no more specific scope is available.

title
TitlePayload

Caller-visible matched title, or null when the queue item is unmatched or inaccessible.

A live download queue page with revision and readiness metadata.

Fields

NameDescription
items
[DownloadQueueItemPayload!]!

Items in the requested page in stable queue order.

hasMore
Boolean!

Whether another page exists after this page.

totalCount
Int!

Number of matching queue items across all pages.

availableClients
[DownloadClientFilterOptionPayload!]!

Clients represented after queue, title, and permission filters and before the client filter is applied.

revision
Long!

Monotonic queue revision used to detect updates.

updatedAt
DateTime

Time the queue data was updated, in UTC, or null before the first update.

ready
Boolean!

Whether the queue data is complete enough to represent current state.

stale
Boolean!

Whether the queue data may be behind its source.

Queue revision metadata returned after synchronization.

Fields

NameDescription
revision
Long!

New monotonic queue revision.

updatedAt
DateTime

Time the queue data was updated, in UTC, or null when no update exists.

Confirms the provider subtitle saved for a media file.

Fields

NameDescription
mediaFileId
ID!

Media file ID that received the subtitle.

providerFileId
String!

Provider-specific subtitle file ID that was downloaded.

downloaded
Boolean!

Whether the subtitle download and import completed.

Emby Connect server and its reachable addresses.

Fields

NameDescription
serverId
String!

Emby Connect server identity.

name
String!

Server display name.

userType
EmbyConnectUserTypeValue!

Emby Connect user category.

localAddress
String

Local server address, when advertised.

remoteAddress
String

Remote server address, when advertised.

localApiBaseUrl
String

Local API base URL, when reachable.

remoteApiBaseUrl
String

Remote API base URL, when reachable.

localStatus
EmbyConnectAddressStatusValue!

Local address probe result.

remoteStatus
EmbyConnectAddressStatusValue!

Remote address probe result.

suggestedBaseUrl
String

Server address selected by connection logic, when one is available.

Accepted background request to empty the selected recycle bins.

Fields

NameDescription
jobRun
JobRunPayload!

Background job whose result reports the number of entries purged.

Availability summary for an episode’s primary media.

Fields

NameDescription
state
EpisodeMediaAvailabilityStateValue!

Current availability or scan state.

primaryQualityLabel
String

Quality label of the primary file, or null before a file is available.

Episode identity, schedule metadata, flags, and media readiness fields.

Fields

NameDescription
id
ID!

Stable episode identifier.

titleId
ID!

Identifier of the title containing this episode.

collectionId
ID

Identifier of the containing collection, or null when not assigned.

episodeType
EpisodeTypeValue!

Episode kind, such as regular, special, filler, or recap.

episodeNumber
String

Season-relative episode number, or null when unknown.

seasonNumber
String

Season number, or null when the source does not provide one.

episodeLabel
String

Display label for the episode number, or null before metadata is available.

title
String

Episode title, or null before metadata is available.

overview
String

Episode synopsis, or null before metadata is available.

airDate
Date

Air date as a calendar date without a time zone, or null when unknown.

durationSeconds
Int

Duration in seconds, or null when media or metadata has not supplied it.

hasMultiAudio
Boolean!

Whether more than one audio stream is present in the available media.

hasSubtitle
Boolean!

Whether at least one subtitle stream is present in the available media.

isFiller
Boolean!

Whether the episode is classified as filler.

isRecap
Boolean!

Whether the episode is classified as recap.

absoluteNumber
String

Absolute episode number, or null when unknown.

imageUrl
String

Proxied episode image URL, or null when no image source is available.

monitored
Boolean!

Whether acquisition and monitoring are enabled for this episode.

createdAt
DateTime!

Time when the episode record was created, in UTC.

sizeBytes
Long

Aggregated live media-file size for this episode.

playbackLinks
[MediaServerPlaybackLinkPayload!]!

Provider-native playback links for this episode, when an exact catalog mapping exists.

parentTitle
TitlePayload

Parent title for this episode, or null if it is no longer available to the caller.

collection
CollectionPayload

Containing collection when the episode has one, otherwise null.

wantedItem
WantedItemPayload

Acquisition state for this episode, or null when no wanted state exists.

mediaAvailability
EpisodeMediaAvailabilityPayload!

Media readiness for this episode, including missing and unmonitored states.

mediaFiles
[TitleMediaFilePayload!]!

Media files associated with this episode, or an empty list when none are available.

Union member identifying one episode by ID.

Fields

NameDescription
episodeId
ID!

Target episode ID.

Union member identifying multiple episodes by ID.

Fields

NameDescription
episodeIds
[ID!]!

Target episode IDs; empty means no episode scope was supplied.

Runtime state for one external authentication connection.

Fields

NameDescription
id
ID!

Connection identity.

provider
ExternalAccountProviderValue!

External provider type.

displayName
String!

Display name of the connection.

loginEnabled
Boolean!

Whether login through this connection is enabled.

linkingEnabled
Boolean!

Whether account linking through this connection is enabled.

embyConnectEnabled
Boolean!

Whether Emby Connect is enabled for this connection.

Runtime authentication providers, linking providers, and connections.

Fields

NameDescription
loginProviders
[ExternalAccountProviderValue!]!

Providers enabled for login.

linkingProviders
[ExternalAccountProviderValue!]!

Providers enabled for account linking.

connections
[ExternalAuthRuntimeConnectionPayload!]!

Configured external authentication connections.

External identifier from a provider.

Fields

NameDescription
source
String!

Provider or source name.

kind
String

Entity kind the identifier names at that source, such as movie, series, anime or title. Absent when the identifier does not say.

value
String!

Identifier assigned by that source.

ExternalImportAggregateWarmupProgressPayload

Section titled “ExternalImportAggregateWarmupProgressPayload”

Aggregate title-fetch progress for external source warmups.

Fields

NameDescription
status
ExternalImportMonitorWarmupStatusValue!

Aggregate warmup status.

titlesTotalKnown
Boolean!

Whether the total title count is known.

titlesFetched
Int!

Number of titles fetched.

titlesTotal
Int!

Total titles expected when known.

errorMessage
String

Failure detail, or null when no error occurred.

Connection and warmup result for one external Arr source.

Fields

NameDescription
sessionId
ID!

Warmup session ID.

sourceKey
String!

Stable source identity.

kind
ExternalArrSourceKind!

External source kind.

baseUrl
String!

Source base URL.

connected
Boolean!

Whether the source connection succeeded.

version
String

Source version, or null when unavailable.

status
ExternalImportMonitorWarmupStatusValue!

Warmup lifecycle status.

error
String

Connection or warmup error, or null on success.

Connection probe result for an external service.

Fields

NameDescription
kind
ExternalImportConnectionKind!

Service kind that was validated.

baseUrl
String!

Normalized service base URL.

connected
Boolean!

Whether the service accepted the connection credentials.

version
String

Detected service version, or null when unavailable.

error
String

Connection failure detail, or null when connected.

Download-client candidate discovered during external import.

Fields

NameDescription
sourceKeys
[String!]!

Source identities that reported this candidate.

name
String!

Download-client name.

implementation
String!

Source implementation name.

scryerClientType
String

Scryer client type, or null when unsupported.

host
String

Hostname or address, when reported.

port
String

Port as reported by the external source, which may not be numeric.

useSsl
Boolean!

Whether the source uses TLS.

urlBase
String

URL base path, when reported.

username
String

Username, when reported.

apiKeyPresent
Boolean!

Whether an API key was returned by the source.

dedupKey
String!

Stable identity used to deduplicate this candidate.

supported
Boolean!

Whether Scryer can create this client type.

requiresPasswordOverride
Boolean!

Whether an explicit password override is required.

Indexer candidate discovered during external import.

Fields

NameDescription
sourceKeys
[String!]!

Source identities that reported this candidate.

name
String!

Indexer name.

implementation
String!

Source implementation name.

scryerProviderType
String

Scryer provider type, or null when unsupported.

baseUrl
String

Indexer base URL, when reported.

apiKeyPresent
Boolean!

Whether an API key was returned by the source.

dedupKey
String!

Stable identity used to deduplicate this candidate.

supported
Boolean!

Whether Scryer can create this provider type.

childCount
Int!

Number of grouped child indexers.

childNames
[String!]!

Names of grouped child indexers.

requiresApiKeyOverride
Boolean!

Whether an explicit API key override is required.

apiKeyHelpUrl
String

Provider help URL for obtaining an API key, when available.

ExternalImportMonitorWarmupProgressPayload

Section titled “ExternalImportMonitorWarmupProgressPayload”

Progress and match counts for one external monitor warmup session.

Fields

NameDescription
sessionId
ID!

Warmup session ID.

status
ExternalImportMonitorWarmupStatusValue!

Warmup lifecycle status.

phase
ExternalImportMonitorWarmupPhaseValue!

Current warmup phase.

startedAt
DateTime!

Session start time in UTC.

updatedAt
DateTime!

Last progress update time in UTC.

overallTotalKnown
Boolean!

Whether the overall total is known.

overallProgress
LibraryScanPhaseProgressPayload!

Overall progress counters.

moviesTotalKnown
Boolean!

Whether the movie total is known.

moviesProgress
LibraryScanPhaseProgressPayload!

Movie loading progress counters.

seriesTotalKnown
Boolean!

Whether the series total is known.

seriesProgress
LibraryScanPhaseProgressPayload!

Series loading progress counters.

episodeFetchTotalKnown
Boolean!

Whether the episode fetch total is known.

episodeFetchExpectedTotal
Int

Expected episode count when known.

episodeFetchExpectedMonitoredTotal
Int

Expected monitored episode count when known.

episodeFetchProgress
LibraryScanPhaseProgressPayload!

Episode loading progress counters.

snapshotBuildTotalKnown
Boolean!

Whether snapshot-build totals are known.

snapshotBuildProgress
LibraryScanPhaseProgressPayload!

Snapshot-build progress counters.

matchedMovieCount
Int!

Number of matched movies.

matchedSeriesCount
Int!

Number of matched series.

unmatchedMovieCount
Int!

Number of unmatched movies.

unmatchedSeriesCount
Int!

Number of unmatched series.

ambiguousMovieCount
Int!

Number of ambiguous movies.

ambiguousSeriesCount
Int!

Number of ambiguous series.

errorMessage
String

Failure detail, or null when no error occurred.

External import candidates and source warmup results.

Fields

NameDescription
prowlarrConnected
Boolean!

Whether Prowlarr connected during preview construction.

prowlarrVersion
String

Prowlarr version, or null when unavailable.

prowlarrError
String

Prowlarr connection error, or null when connected.

arrSources
[ExternalImportArrSourcePayload!]!

External Arr source sessions included in the preview.

rootFolders
[ExternalImportRootFolderPayload!]!

Root folders reported by the sources.

downloadClients
[ExternalImportDownloadClientPayload!]!

Download-client candidates grouped by deduplication identity.

indexers
[ExternalImportIndexerPayload!]!

Indexer candidates grouped by deduplication identity.

Counts and errors produced by external import execution.

Fields

NameDescription
mediaPathsSaved
Boolean!

Whether selected media paths were saved.

downloadClientsCreated
Int!

Number of download clients created.

indexersCreated
Int!

Number of indexers created.

pluginsInstalled
[String!]!

Plugin identifiers installed as part of the import.

errors
[String!]!

Errors encountered during execution.

Root folder reported by an external Arr source.

Fields

NameDescription
sourceWarmupSessionId
ID!

Warmup session that reported the root.

sourceKey
String!

Stable source identity.

kind
ExternalArrSourceKind!

External source kind.

arrRootPath
String!

Root path reported by the source.

Download-client or indexer API key stored in an import draft.

Fields

NameDescription
dedupKey
String!

Stable candidate identity used for deduplication.

apiKey
String!

Stored API key value for the draft.

API key entry returned from an external import secret draft.

Fields

NameDescription
instanceId
ID!

External instance ID.

kind
ExternalImportConnectionKind!

External service kind.

apiKey
String!

Stored API key value for the draft.

ExternalImportSetupPasswordOverridePayload

Section titled “ExternalImportSetupPasswordOverridePayload”

Download-client password stored in an import draft.

Fields

NameDescription
dedupKey
String!

Stable candidate identity used for deduplication.

password
String!

Stored password value for the draft.

Secret values held in an external import setup draft.

Fields

NameDescription
instanceApiKeys
[ExternalImportSetupInstanceApiKeyPayload!]!

External instance API keys in the draft.

downloadClientApiKeyOverrides
[ExternalImportSetupApiKeyOverridePayload!]!

Download-client API key overrides in the draft.

downloadClientPasswordOverrides
[ExternalImportSetupPasswordOverridePayload!]!

Download-client password overrides in the draft.

indexerApiKeyOverrides
[ExternalImportSetupApiKeyOverridePayload!]!

Indexer API key overrides in the draft.

updatedAt
DateTime!

Last update time in UTC.

ExternalImportSetupSecretDraftStatusPayload

Section titled “ExternalImportSetupSecretDraftStatusPayload”

Ownership and existence status for the current user’s import secret draft.

Fields

NameDescription
hasDraft
Boolean!

Whether a secret draft exists.

ownedByCurrentUser
Boolean!

Whether the draft belongs to the current user.

updatedAt
DateTime

Draft update time in UTC, or null when no draft exists.

Subtitle provider record blocked for a media file.

Fields

NameDescription
id
ID!

Blocklist entry ID.

mediaFileId
ID!

Media file ID affected by the blocklist entry.

provider
String!

Subtitle provider.

providerFileId
String!

Provider subtitle file ID.

language
String!

Blocked subtitle language code.

reason
String

Blocklist reason, or null when none was recorded.

createdAt
DateTime!

Creation time in UTC.

Subtitle file downloaded for a media file.

Fields

NameDescription
id
ID!

Subtitle record ID.

mediaFileId
ID!

Media file ID containing the subtitle.

titleId
ID!

Title ID owning the media file.

episodeId
ID

Episode ID, or null for movie or series-level subtitles.

sourceKind
String!

Subtitle source category.

language
String!

Subtitle language code.

provider
String

Subtitle provider, or null when provider metadata is unavailable.

providerFileId
String

Provider subtitle file ID, or null when unavailable.

filePath
String!

Local subtitle file path.

score
Int

Provider score, when supplied.

scorePercent
Int

Provider score as a percentage, when supplied.

hearingImpaired
Boolean!

Whether the subtitle is marked for hearing-impaired viewers.

forced
Boolean!

Whether the subtitle is forced.

aiTranslated
Boolean!

Whether the subtitle was translated by an AI system.

machineTranslated
Boolean!

Whether the subtitle was translated by a machine process.

uploader
String

Provider uploader, or null when unavailable.

releaseInfo
String

Provider release information, or null when unavailable.

synced
Boolean!

Whether the subtitle timing is synchronized.

downloadedAt
DateTime!

Download time in UTC.

Effective scoring-persona selection for one content scope.

Fields

NameDescription
scope
ContentScopeValue!

Content scope to which the selection applies.

overridePersona
ScoringPersonaValue

Scope-specific persona override, or null when inherited.

effectivePersona
ScoringPersonaValue!

Effective scoring persona.

inheritsGlobal
Boolean!

Whether the effective persona comes from the global setting.

Accepted external import finalization and its monitor warmup session.

Fields

NameDescription
monitorWarmupSessionId
ID!

Monitor warmup session ID tracking accepted background work.

finalizeSessionId
ID!

Session ID of the background apply; poll externalImportWarmupStatus with it until the apply reaches a terminal status.

progress
ExternalImportMonitorWarmupProgressPayload!

Status of the background apply at the moment finalize was accepted.

Result of repairing a title match and any follow-up scan work.

Fields

NameDescription
title
TitlePayload!

Title after the identity repair.

hydrated
Boolean!

Whether metadata became available during the repair.

libraryScan
LibraryScanSummaryPayload

Library scan summary, or null when no scan was accepted or run.

warnings
[String!]!

Non-fatal warnings produced while repairing the match.

Stored floating-point provider configuration value.

Fields

NameDescription
value
Float!

Floating-point value.

A title taking part in a folder-match correction.

Fields

NameDescription
id
ID!

Title identity.

name
String!

Title display name.

folderPath
String

Folder this title owns, or null when it owns none.

Result of requesting an immediate grab for a pending release.

Fields

NameDescription
id
ID!

Pending release ID.

grabbed
Boolean!

Whether the release was accepted for grabbing.

General service settings, including effective image-cache limits and trusted certificate data.

Fields

NameDescription
apiExplorerEnabled
Boolean!

Whether administrators may use the API explorer.

experimentalFeaturesEnabled
Boolean!

Whether surfaces that are still being finished are shown on this instance.

personalizedDiscoveryEnabled
Boolean!

Whether this instance sends its library context to the metadata gateway for personalized discovery.

srrdbFilenameRecoveryEnabled
Boolean!

Whether automatic SABnzbd and NZBGet imports may ask srrdb.com to recover obfuscated filenames.

keepHistoryForever
Boolean!

Whether import history is retained indefinitely.

historyRetentionDays
Int!

History retention period in days when indefinite retention is false.

imageCacheMaxSizeMb
Int!

Configured image-cache maximum in megabytes.

effectiveImageCacheMaxSizeBytes
Long!

Effective image-cache maximum in bytes after environment overrides.

effectiveImageCacheMaxSizeMb
Float!

Effective image-cache maximum in megabytes after environment overrides.

imageCacheMaxSizeEnvOverrideActive
Boolean!

Whether an environment variable overrides the configured image-cache limit.

pluginHttpCaBundlePem
String!

PEM CA bundle used for plugin HTTP requests.

pluginHttpTrustedCertificates
[PluginHttpTrustedCertificatePayload!]!

Additional trusted plugin HTTP certificates.

Result of ignoring one pending import.

Fields

NameDescription
id
ID!

Pending-import item ID.

status
PendingImportStatusValue!

Status after the ignore operation.

Persisted import record with lifecycle status, decision, IDs, and UTC timestamps.

Fields

NameDescription
id
ID!

Import record ID.

sourceSystem
String!

External system that supplied the import.

sourceRef
String!

Source-system reference identifying the download or item.

sourceTitle
String

Source title, or null when unavailable.

facet
MediaFacetValue

Media facet, or null when not yet classified.

importType
ImportTypeValue!

Import operation type.

status
ImportStatusValue!

Current import lifecycle status.

errorMessage
String

Error message, or null when no error is recorded.

decision
ImportDecisionValue

Import decision, or null before a decision is made.

skipReason
ImportSkipReasonValue

Skip reason, or null when not skipped.

titleId
ID

Bound title ID, or null when no title was selected.

sourcePath
String

Source path, or null when not recorded.

destPath
String

Destination path, or null when no destination was produced.

startedAt
DateTime

UTC start time, or null before processing begins.

finishedAt
DateTime

UTC completion time, or null while incomplete.

createdAt
DateTime!

UTC record creation time.

Result of one import operation, including decision and source/destination paths.

Fields

NameDescription
importId
ID!

Import record ID.

decision
ImportDecisionValue!

Final import decision.

skipReason
ImportSkipReasonValue

Skip reason when the decision skipped the import, or null otherwise.

titleId
ID

Imported title ID, or null when no title was bound.

sourcePath
String!

Source path examined by the import.

destPath
String

Destination path written by the import, or null when no destination was written.

errorMessage
String

Error message, or null when the operation completed without an error.

One category the indexer advertises in its caps document, used to offer indexer-specific routing categories that the standard newznab tree lacks.

Fields

NameDescription
code
String!

Category id exactly as the indexer expects it in the cat parameter.

label
String

Human-readable name from the caps document, or null when it has none.

Indexer configuration, health, capability, routing, and masked secret metadata.

Fields

NameDescription
id
ID!

Indexer configuration ID.

name
String!

User-facing indexer name.

providerType
String!

Stable provider implementation key for this indexer.

baseUrl
String!

Indexer base URL.

proxyConfigId
ID

Optional proxy configuration ID used by this indexer.

downloadClientId
ID

Optional download-client ID associated with this indexer.

seedingProfileId
ID

Optional seeding profile ID applied to torrents grabbed from this indexer.

hasProwlarrSeedCriteria
Boolean!

Whether Prowlarr supplied seed criteria for this managed child. When it did and no seeding profile is assigned, those criteria apply; assigning a profile overrides them.

prowlarrMinimumSeeders
Int

Minimum seeders Prowlarr imported for this managed child, or null when it supplied none. Zero means Prowlarr turned the seeder check off. Read-only: it is edited in Prowlarr, and an assigned seeding profile overrides it.

hasApiKey
Boolean!

Whether an API key is configured without exposing it.

isManaged
Boolean!

Whether this configuration is managed by a parent configuration.

managedParentConfigId
ID

Parent managed configuration ID, or null when independent.

supportsManagedChildrenSync
Boolean!

Whether managed child synchronization is supported.

storedSecretKeys
[String!]!

Names of stored secret fields, never their values.

rateLimitSeconds
Int

Minimum interval between requests in seconds, or null when unlimited.

rateLimitBurst
Int

Maximum burst size for rate limiting, or null when unspecified.

disabledUntil
DateTime

UTC time until which the indexer is disabled, or null when not disabled.

isEnabled
Boolean!

Whether the indexer is enabled.

enableInteractiveSearch
Boolean!

Whether interactive searches are enabled.

enableAutoSearch
Boolean!

Whether automatic searches are enabled.

lastHealthStatus
String

Most recent health status, or null before the first check.

lastErrorMessage
String

Most recent health error, or null when none is recorded.

lastErrorAt
DateTime

UTC time of the most recent health error, or null when none is recorded.

lastQueryAt
DateTime

UTC time of the most recent query, or null before the first query.

config
[ProviderConfigValuePayload!]!

Provider configuration fields with secret values masked.

capsCategories
[IndexerCapsCategoryPayload!]!

Categories from the most recent caps snapshot, sorted by code. Empty until the first successful caps refresh.

createdAt
DateTime!

UTC creation time.

updatedAt
DateTime!

UTC last-update time.

IDs created, updated, and deleted while synchronizing managed indexer configurations.

Fields

NameDescription
parentConfigId
ID!

Parent configuration ID used for synchronization.

createdIds
[ID!]!

IDs created by synchronization.

updatedIds
[ID!]!

IDs updated by synchronization.

deletedIds
[ID!]!

IDs deleted by synchronization.

IndexerDownloadClientMappingCatalogPayload

Section titled “IndexerDownloadClientMappingCatalogPayload”

Available indexers, download clients, and provider compatibility mappings.

Fields

NameDescription
clients
[IndexerDownloadClientMappingClientPayload!]!

Download clients available for mapping.

indexers
[IndexerDownloadClientMappingIndexerPayload!]!

Indexers and their current mapping state.

providerCompatibility
[IndexerDownloadClientProviderCompatibilityPayload!]!

Provider-level compatibility information used when no concrete indexer exists.

Download client option used by the indexer mapping catalog.

Fields

NameDescription
id
ID!

Download client ID.

name
String!

Download client name.

clientType
String!

Download client provider type.

isEnabled
Boolean!

Whether the client is enabled.

healthStatus
String!

Current health status string.

IndexerDownloadClientMappingIndexerPayload

Section titled “IndexerDownloadClientMappingIndexerPayload”

Indexer mapping state and compatible download-client IDs.

Fields

NameDescription
id
ID!

Indexer configuration ID.

name
String!

Indexer name.

downloadClientId
ID

Currently mapped download-client ID, or null when unmapped.

protocolFamilies
[String!]!

Protocol families supported by the indexer.

supportsMapping
Boolean!

Whether this indexer supports explicit client mapping.

compatibleClientIds
[ID!]!

Download-client IDs compatible with the indexer.

IndexerDownloadClientProviderCompatibilityPayload

Section titled “IndexerDownloadClientProviderCompatibilityPayload”

Provider-level protocol compatibility and compatible download clients.

Fields

NameDescription
providerType
String!

Stable indexer provider implementation key.

protocolFamilies
[String!]!

Protocol families supported by the provider.

supportsMapping
Boolean!

Whether the provider supports explicit mapping.

compatibleClientIds
[ID!]!

Compatible download-client IDs.

A newest-first page of persisted indexer errors.

Fields

NameDescription
items
[IndexerErrorSummaryPayload!]!

Error events in newest-first order.

nextCursor
String

Cursor for the following page, or null at the end of the result set.

A persisted error event and, when available, its complete HTTP response.

Fields

NameDescription
error
IndexerErrorSummaryPayload!

List-safe metadata for the error event.

response
IndexerErrorResponsePayload

Complete response data when the upstream returned one.

One raw response header retained for privileged diagnostics.

Fields

NameDescription
name
String!

Original response header name.

valueBase64
String!

Raw header value encoded as base64.

value
String

Raw header value when it is valid UTF-8.

Complete persisted HTTP response retained for privileged diagnostics.

Fields

NameDescription
status
Int!

Original HTTP status code.

headers
[IndexerErrorHeaderPayload!]!

Repeated raw response headers in their retained order.

bodyBase64
String!

Raw response body encoded as base64.

List-safe metadata for a persisted indexer error.

Fields

NameDescription
id
ID!

Stable error-event identifier.

indexerId
ID!

Configured indexer identifier captured with the event.

indexerName
String!

Indexer name captured when the event occurred.

operation
IndexerErrorOperationValue!

Operation that received the failed response.

occurredAt
String!

RFC 3339 time at which the response was accepted.

httpStatus
Int

HTTP response status code, when the upstream returned a response.

classification
IndexerErrorClassificationValue!

Safe error classification derived from the response.

providerErrorCode
Int

Newznab provider code when a known Newznab error was recognized.

message
String!

Canonical safe error message that excludes response-body text.

contentType
String

Response Content-Type header when it was valid UTF-8.

Query and quota counters for one indexer.

Fields

NameDescription
indexerId
ID!

ID of the indexer.

indexerName
String!

Configured indexer name.

queriesLast24H
Int!

Queries during the trailing 24 hours.

successfulLast24H
Int!

Successful queries during the trailing 24 hours.

failedLast24H
Int!

Failed queries during the trailing 24 hours.

grabsLast24H
Int!

Releases grabbed through this indexer during the trailing 24 hours, counted by Scryer rather than reported by the provider.

lastQueryAt
DateTime

UTC time of the most recent query, or null when never queried.

apiRequestsToday
Int!

Every HTTP request Scryer has sent to this indexer in the current quota window, counted at the send site: pagination, retries, RSS sweeps, caps refreshes and failures included. Persisted, so it survives a restart.

apiRequestsWindowStartedAt
DateTime

UTC time the current api_requests_today window opened, or null when the counter has never been persisted.

apiRequestsObservedSince
DateTime

UTC time corrected Scryer-owned API request observation began. The first UTC day is partial.

apiCurrent
Int

Current API request count, or null when not reported.

apiMax
Int

API request limit, or null when not reported.

grabCurrent
Int

Current grab count, or null when not reported.

grabMax
Int

Grab limit, or null when not reported.

Indexer routing behavior for one indexer.

Fields

NameDescription
indexerId
ID!

Indexer configuration ID.

enabled
Boolean!

Whether this route is enabled.

categories
[String!]!

Categories accepted by this route.

priority
Int!

Relative routing priority.

Indexer search result with parsed release metadata, scoring, and queue eligibility.

Fields

NameDescription
source
String!

Indexer source name.

indexerId
ID

Indexer configuration identity that returned the release, or null when unknown.

title
String!

Release title shown by the indexer.

link
String

Informational release link, or null when unavailable.

downloadUrl
String

Direct download URL, or null when unavailable.

sourceKind
DownloadSourceKindValue

Source kind such as Usenet or torrent, or null when unknown.

sizeBytes
Long

Release size in bytes, or null when unknown.

publishedAt
DateTime

Publication time in UTC, or null when unavailable.

thumbsUp
Int

Positive vote count, or null when not reported.

thumbsDown
Int

Negative vote count, or null when not reported.

grabs
Int

Grab count reported by the indexer, or null when not reported.

parsedRelease
ParsedReleasePayload

Parsed release fields, or null when parsing did not produce a result.

qualityProfileDecision
QualityProfileDecisionPayload

Quality-profile decision, or null when no profile was evaluated.

seeders
Int

Torrent seeder count, or null for non-torrent results.

peers
Int

Torrent peer count, or null for non-torrent results.

infoHash
String

Torrent info hash, or null for non-torrent results.

freeleech
Boolean

Whether the torrent is marked freeleech, or null for non-torrent results.

downloadVolumeFactor
Float

Torrent download volume factor, or null for non-torrent results.

candidateToken
String

Opaque token accepted when queuing this candidate, or null when unavailable.

queueScope
QueueDownloadScopePayload

Acquisition scope targeted by this result, or null when no scope was inferred.

autoEligible
Boolean

Whether automatic acquisition may select this result.

autoDecisionCode
String

Automatic acquisition decision code, or null when not evaluated.

autoDecisionSummary
String

Human-readable automatic acquisition decision summary, or null when not evaluated.

Instance-wide feature switches readable by any signed-in user.

Fields

NameDescription
apiExplorerEnabled
Boolean!

Whether the API explorer is enabled and the current user may access it.

experimentalFeaturesEnabled
Boolean!

Whether surfaces that are still being finished are shown on this instance.

personalizedDiscoveryEnabled
Boolean!

Whether this instance sends its library context to the metadata gateway for personalized discovery.

Stored integer provider configuration value.

Fields

NameDescription
value
Int!

Signed integer value.

Per-indexer progress and result count for an interactive release search.

Fields

NameDescription
indexerId
ID!

Indexer configuration ID.

name
String!

Indexer name.

priority
Int!

Routing priority for this indexer; 0 when routing states none.

status
InteractiveReleaseSearchIndexerStatusValue!

Current indexer lifecycle state.

resultCount
Int!

The indexer's own result count (before cross-indexer dedup).

elapsedMs
Int

Wall time of this indexer's own call in milliseconds, or null before it answered.

failureReason
String

Failure reason, or null when the indexer did not fail.

Pollable snapshot of an interactive release-search job with partial results.

Fields

NameDescription
id
ID!

Interactive release-search job ID.

state
InteractiveReleaseSearchStateValue!

Current search lifecycle state.

results
[IndexerSearchResultPayload!]!

Scored, cross-indexer-deduped snapshot of the merged results so far.

indexers
[InteractiveReleaseSearchIndexerPayload!]!

Per-indexer progress states.

startedAt
DateTime!

UTC search start time.

completedAt
DateTime

UTC completion time, or null while running.

User discovered on a Jellyfin server.

Fields

NameDescription
id
String!

Server-side user identity.

username
String!

Username on the server.

displayName
String

Optional display name.

avatarUrl
String

Optional avatar URL.

Metadata describing a configured job.

Fields

NameDescription
key
JobKeyValue!

Stable job key.

displayName
String!

Display name of the job.

description
String!

Human-readable job description.

category
JobCategoryValue!

Broad job category.

section
JobSectionValue!

Job section.

manualTriggerAllowed
Boolean!

Whether an explicit trigger is allowed.

usesLibraryScanProgress
Boolean!

Whether the run reports library-scan progress.

schedule
JobScheduleInfoPayload!

Configured schedule details.

Current status and progress of one job run.

Fields

NameDescription
id
ID!

ID of the job run.

jobKey
JobKeyValue!

Stable key of the job being run.

displayName
String!

Display name of the job.

category
JobCategoryValue!

Broad job category.

section
JobSectionValue!

Job section.

status
JobRunStatusValue!

Current run status.

triggerSource
JobTriggerSourceValue!

Source that started the run.

startedAt
DateTime!

UTC time when the run started.

completedAt
DateTime

UTC completion time, or null while the run is active.

summaryJson
JSON

Structured result summary, or null before completion or when unavailable.

summaryText
String

Human-readable result summary, or null when unavailable.

errorText
String

Failure detail, or null when the run has not failed.

progressJson
JSON

Structured progress data, or null when the job does not expose it.

libraryScanProgress
LibraryScanProgressPayload

Library-scan progress, or null for jobs without scan progress.

Schedule details for a job definition.

Fields

NameDescription
kind
JobScheduleKindValue!

Schedule kind.

description
String!

Human-readable schedule description.

intervalSeconds
Int

Repeat interval in seconds, or null for non-interval schedules.

initialDelaySeconds
Int

Initial delay in seconds, or null when not applicable.

nextRunAt
DateTime

Next scheduled run as a UTC timestamp, or null when no run is scheduled.

Filesystem paths used by the three supported media facets.

Fields

NameDescription
moviePath
String!

Movie library path.

seriesPath
String!

Series library path.

animePath
String!

Anime library path.

Library identity, facet, and configured storage roots.

Fields

NameDescription
id
ID!

Stable library identifier.

facet
MediaFacetValue!

Media facet managed by the library.

name
String!

Display name of the library.

slug
String!

Stable URL-friendly library key.

isDefault
Boolean!

Whether this is the configured default library for its facet.

isBootstrapDefaultRootSet
Boolean!

Whether the library was created by bootstrap root-folder setup.

roots
[LibraryRootPayload!]!

Root folders configured for the library.

qualityProfileId
ID!

Effective title quality-profile ID for this library; requires title-management or catalog-settings access.

requestQualityProfileIds
[ID!]!

Quality-profile IDs currently allowed for requests in this library; access requires request, title-management, or relevant application permission.

requestQualityProfileDefaultId
ID!

Default request quality-profile ID, selected from the library's effective allowed profiles.

settings
LibrarySettingsPayload!

Effective library settings; requires library-management permission.

Library root-folder identity, path, and default marker.

Fields

NameDescription
id
ID!

Root-folder ID.

path
String!

Filesystem path.

isDefault
Boolean!

Whether this is the default root folder.

Counts for one phase of a library scan.

Fields

NameDescription
total
Int!

Total units in this phase; zero is valid when no work was found.

completed
Int!

Units completed so far.

failed
Int!

Units that failed in this phase.

Progress snapshot for one library scan.

Fields

NameDescription
sessionId
ID!

ID of the scan session.

facet
MediaFacetValue!

Media facet being scanned.

libraryId
ID

ID of the library being scanned, or null for all libraries in the facet.

mode
LibraryScanModeValue!

Scan mode.

status
LibraryScanStatusValue!

Current scan status.

startedAt
DateTime!

UTC time when the scan started.

updatedAt
DateTime!

UTC time when the progress snapshot was updated.

foundTitles
Int!

Number of titles found so far.

titleMatchTotalKnown
Boolean!

Whether the total title-match count is known.

titleMatchProgress
LibraryScanPhaseProgressPayload!

Title matching progress counts.

hydrationTotalKnown
Boolean!

Whether the total hydration count is known.

hydrationProgress
LibraryScanPhaseProgressPayload!

Metadata hydration progress counts.

mediaAnalysisTotalKnown
Boolean!

Whether the total media-analysis count is known.

mediaAnalysisProgress
LibraryScanPhaseProgressPayload!

Media-analysis progress counts.

summary
LibraryScanSummaryPayload

Final scan summary, or null until a summary is available.

Counts produced by a library scan.

Fields

NameDescription
scanned
Int!

Number of files or records scanned.

matched
Int!

Number matched to known titles.

imported
Int!

Number imported successfully.

skipped
Int!

Number skipped by scan or import policy.

unmatched
Int!

Number left unmatched.

Effective library settings together with nullable per-library overrides.

Fields

NameDescription
requiredAudioLanguagesOverride
[String!]

Library override for required audio language codes; original resolves per title.

requiredAudioLanguages
[String!]!

Effective configured requirements after inheritance; original remains unchanged.

metadataLanguageOverride
String

Library metadata-language override; null means inherit the global default.

metadataLanguage
String!

Effective metadata language after inheritance.

useSeasonFoldersOverride
Boolean

Library override for season folders; null means inherit the facet setting.

useSeasonFolders
Boolean!

Effective season-folder setting after inheritance.

qualityProfileIdOverride
ID

Library override quality-profile ID; null means inherit.

qualityProfileId
ID!

Effective quality-profile ID.

requestQualityProfileIdsOverride
[ID!]

Library override request quality-profile IDs; null means inherit.

requestQualityProfileIds
[ID!]!

Effective request quality-profile IDs; empty means no additional profiles.

requestQualityProfileDefaultId
ID!

Effective default request quality-profile ID.

scoringPersonaOverride
ScoringPersonaValue

Library override scoring persona; null means inherit.

scoringPersona
ScoringPersonaValue!

Effective scoring persona.

fillerPolicyOverride
FillerPolicyValue

Library override filler policy; null means inherit.

fillerPolicy
FillerPolicyValue

Effective filler policy, or null when unset.

recapPolicyOverride
RecapPolicyValue

Library override recap policy; null means inherit.

recapPolicy
RecapPolicyValue

Effective recap policy, or null when unset.

monitorSpecialsOverride
Boolean

Library override for monitoring specials; null means inherit.

monitorSpecials
Boolean

Effective specials monitoring setting, or null when unset.

interSeasonMoviesOverride
Boolean

Library override for inter-season movies; null means inherit.

interSeasonMovies
Boolean

Effective inter-season movie setting, or null when unset.

monitorFillerMoviesOverride
Boolean

Library override for filler movies; null means inherit.

monitorFillerMovies
Boolean

Effective filler-movie monitoring setting, or null when unset.

nfoWriteOnImportOverride
Boolean

Library override for NFO writing; null means inherit.

nfoWriteOnImport
Boolean!

Effective NFO-on-import setting.

plexmatchWriteOnImportOverride
Boolean

Library override for Plex match writing; null means inherit.

plexmatchWriteOnImport
Boolean

Effective Plex match-on-import setting, or null when unset.

importModeOverride
ImportModeValue

Library override import mode; null means inherit.

importMode
ImportModeValue!

Effective import mode.

setPermissionsLinuxOverride
Boolean

Library override for Linux permission updates; null means inherit.

setPermissionsLinux
Boolean!

Effective Linux permission-update setting.

fileChmodOverride
String

Library override file chmod mode; null means inherit.

fileChmod
String

Effective file chmod mode, or null when unset.

folderChmodOverride
String

Library override folder chmod mode; null means inherit.

folderChmod
String

Effective folder chmod mode, or null when unset.

chownGroupOverride
String

Library override chown group; null means inherit.

chownGroup
String

Effective chown group, or null when unset.

indexerRoutingOverride
[IndexerRoutingEntryPayload!]

Library override indexer routing entries; null means inherit.

downloadClientRoutingOverride
[DownloadClientRoutingEntryPayload!]

Library override download-client routing entries; null means inherit.

External account link summary without provider credentials.

Fields

NameDescription
id
ID!

ID of the linked account.

userId
ID!

ID of the linked local user.

provider
ExternalAccountProviderValue!

External provider.

connectionId
ID!

ID of the configured media-server connection.

externalUserId
String

Provider-specific user ID, or null when unavailable.

username
String!

Provider username.

displayName
String

Provider display name, or null when unavailable.

avatarUrl
String

Provider avatar URL, or null when unavailable.

status
ExternalAccountStatusValue!

Current link status.

verifiedAt
DateTime

UTC verification time, or null when not verified.

lastLoginAt
DateTime

UTC time of the last successful login, or null when unused.

createdAt
DateTime!

UTC time when the link was created.

updatedAt
DateTime!

UTC time when the link was last changed.

LocationAmbiguousDestinationCandidatePayload

Section titled “LocationAmbiguousDestinationCandidatePayload”

One destination title an ambiguous identity points at, with what it shares.

The ids alone cannot be chosen between; the name is what the user reads and the shared identities are why the candidate is on the list at all (FR-055).

Fields

NameDescription
titleId
ID!

The candidate destination title.

titleName
String!

Its name in the destination library.

sharedIdentities
[String!]!

The identities both titles carry, as source:external_id, sorted.

One title that cannot enter a root-scoped operation, named rather than silently dropped (FR-023).

Fields

NameDescription
titleId
ID!

The title that is blocked.

titleName
String!

Its name, so the ledger reads as titles rather than as ids.

reason
String!

The sentence explaining what has to be repaired.

reasonCode
String

Machine-readable reason, for grouping and translation.

One classification group: a class, its count, and the titles in it.

Fields

NameDescription
class
TitleLocationClassValue!

Class shared by every title in this group.

count
Long!

How many selected titles fall into this class.

titles
[LocationClassifiedTitlePayload!]!

The titles in this class, in selection order.

One selected title and the class it was previewed as.

Fields

NameDescription
titleId
ID!

Selected title identity.

class
TitleLocationClassValue!

Class this title falls into for the requested destination.

sourceLibraryId
ID!

Library this title lives in today.

sourceRootId
ID!

Root this title lives on today.

sourceFolderPath
String

Folder this title owns today, or null when it owns none.

destinationLibraryId
ID!

Library this title would end up in.

destinationRootId
ID!

Root this title would end up on.

reasonCode
String

Machine-readable reason for the class, for grouping and translation.

reason
String

Human-readable explanation, always present for blocking classes.

blocksStart
Boolean!

Whether this title stops the operation from starting.

destinationIdentityMatch
LocationDestinationIdentityMatchValue

What destination-title detection concluded, or null when the title stays in its own library and no detection was run.

mergeTargetTitleId
ID

The existing destination title this title merges into, or null for a transfer into a title the destination library does not have yet.

mergeTargetTitleName
String

Name of that destination title, so the preview can say "merges into “X”" rather than printing an id. Null whenever mergeTargetTitleId is.

sameNamedDestinationTitleId
ID

A destination title carrying the same name but no shared identity, or null when there is none. It is never merged into automatically.

sameNamedDestinationTitleName
String

Name of that same-named destination title, when there is one.

ambiguousDestinationTitleIds
[ID!]!

The destination titles the user is choosing between, for an ambiguous identity. Empty for every other outcome.

ambiguousDestinationCandidates
[LocationAmbiguousDestinationCandidatePayload!]!

The same titles with the names and shared identities the user needs to tell them apart. Empty for every outcome that is not ambiguous.

facetConversion
LocationFacetConversionPayload

The series↔anime facet conversion this destination performs, or null when the destination library's facet is the title's own (FR-057).

LocationConsolidationClassificationPayload

Section titled “LocationConsolidationClassificationPayload”

FR-024’s seven groups, counted off the same decisions that built the plan items. This is the consolidation preview (US5.1).

Fields

NameDescription
movingIntoUnusedFolders
Long!

Titles moving into destination folders nothing occupies.

mergingWithDestinationTitles
Long!

Titles merging with a destination title they share an identity with.

folderNameCollisions
Long!

Folder names already taken at the destination, so the incoming folder gets a unique previewed name.

mediaCollisions
Long!

Media files whose destination name is already taken.

dedupEligibleFiles
Long!

Source files proven identical to destination content, so they are recycled rather than copied.

companionCollisions
Long!

Companion assets whose destination name is already taken.

untrackedSourceEntries
Long!

Entries beneath the source root that no title accounts for.

catalogOnly
Long!

Titles with no tracked files: catalog reassignment only (FR-076).

blocked
Long!

Titles that cannot enter the operation.

Which root new content lands on after a consolidation (FR-022).

Fields

NameDescription
sourceWasDefault
Boolean!

Whether the root being folded away was the library default.

destinationWasDefault
Boolean!

Whether the destination root was already the library default.

destinationBecomesDefault
Boolean!

Whether the destination root is the library default afterwards.

transfersTheDefault
Boolean!

Whether the default actually moves. Say so out loud when it does.

The series↔anime conversion a cross-library transfer performs, with every setting it affects (FR-057) and the folder-only scope of the rename (FR-058).

Fields

NameDescription
fromFacet
MediaFacetValue!

The facet the title carries today.

toFacet
MediaFacetValue!

The facet it carries after the transfer.

settings
[LocationFacetConvertedSettingPayload!]!

Every affected setting, in a stable order. Empty when the conversion touches nothing the title has set.

filesKeepTheirNames
String!

FR-058, as the sentence the preview shows: the conversion recalculates the folder name only.

One title-level setting the facet conversion affects, named individually so the client lists them rather than showing a blanket sentence (FR-057).

Fields

NameDescription
setting
String!

Stable machine key for the setting, for grouping and translation.

label
String!

Human-readable name of the setting.

value
String

The value the title carries today, or null when it carries none explicitly and the conversion changes which default applies.

disposition
LocationFacetSettingDispositionValue!

Whether the setting becomes invalid, resets, or changes meaning.

detail
String!

The sentence explaining the consequence.

Estimated free space the operation needs, including recycle-copy cost.

Fields

NameDescription
destinationRequiredBytes
Long!

Bytes that must be free on the destination volume.

destinationTotalRequiredBytes
Long!

Destination requirement including the recycle cost when the bin shares that volume.

destinationAvailableBytes
Long

Bytes free on the destination volume, or null when it was not probed.

recycleRequiredBytes
Long!

Bytes that must be free wherever the recycle bin lives.

recycleAvailableBytes
Long

Bytes free on the recycle volume, or null when it was not probed.

sameVolumeMove
Boolean!

Whether the move is a same-volume rename that needs no destination space.

recycleOnOtherVolume
Boolean!

Whether recycling copies bytes because the bin is on another volume.

recycleSharesDestinationVolume
Boolean!

Whether the recycle bin shares the destination volume.

recyclingAvailable
Boolean!

Whether recycling is configured and available for this operation.

probed
Boolean!

Whether the volumes behind this estimate were actually probed.

sufficient
Boolean

Whether the space suffices, or null when it could not be determined.

One record the merge engine could not map, so the merge cannot run (FR-066).

Fields

NameDescription
table
String!

The table whose source rows cannot be carried.

reason
LocationMergeBlockReasonValue!

Why the record blocks the merge.

sourceId
ID!

The source identity that could not be mapped.

detail
String!

The sentence explaining what would otherwise be guessed at.

What merging one title into an existing destination title would do (FR-071).

The destination wins everything except the merging title’s media file records and its history; every other row recorded against it retires with it. This is the same decision the merge itself is built from, so the preview can never describe a merge the engine would not perform.

Fields

NameDescription
sourceTitleId
ID!

The title that merges away.

destinationTitleId
ID!

The title that survives.

destinationTitleName
String

Name of the surviving title, read with the rest of its catalog row when the merge was planned. Null only when that row could not name it.

sourceLibraryId
ID

Library the merging title comes from.

destinationLibraryId
ID

Library the surviving title lives in.

blocked
Boolean!

Whether unmappable records stop this merge from running.

blockedRecords
[LocationMergeBlockedRecordPayload!]!

The records that block it, one per line the user can act on.

mediaFilesRepointed
Long!

Media file records repointed onto the surviving title.

roleChanges
[LocationMergeRoleChangePayload!]!

Every media-file role the merge changes.

roleDemotions
Long!

How many of those role changes demote an incoming primary.

historyRowsCarried
Long!

History rows carried onto the surviving title.

sourceRecordsDropped
Long!

Everything else recorded against the merging title, as one count. Those rows retire with it.

One media-file role the merge resolves, never silently (FR-068 to FR-070).

Fields

NameDescription
fileId
ID!

The media file whose role changes.

sourceEpisodeId
ID

The source episode the file was attached to. Null for a movie, whose only slot is the title itself.

destinationEpisodeId
ID

The destination episode it is attached to after the merge. Null for a movie.

previousRole
LocationMergeMediaRoleValue!

The role it held.

newRole
LocationMergeMediaRoleValue!

The role it holds after the merge.

reason
LocationMergeRoleChangeReasonValue!

Why the role changed.

detail
String!

The sentence the preview shows for this change.

episodeLabel
String

The destination episode as a person would say it (S01E03, or #12 for an absolute-numbered catalog). Null for a movie, or when the episode carries no usable number.

fileName
String

The file's name on disk, without its folder. Null when the catalog row could not name it.

Which files an operation renames and deduplicates, split per title and by whether the work has happened yet.

Read from the plan the user confirmed, so a canceled or failed title still reports what it would have done rather than dropping the files from view.

Fields

NameDescription
operationId
ID!

Operation this listing describes.

titles
[LocationOperationTitleAssetsPayload!]!

Titles carrying at least one rename or deduplication, in confirmed-plan order. A title with neither is not listed.

renamesTotal
Long!

Renames the confirmed plan carries across every title.

renamesDone
Long!

How many of those have happened.

dedupsTotal
Long!

Deduplications the confirmed plan carries across every title.

dedupsDone
Long!

How many of those have happened.

Aggregate counters for a running or finished operation.

Fields

NameDescription
titlesTotal
Long!

Titles the confirmed plan covers.

titlesProcessed
Long!

Titles the operation has finished processing.

titlesBlocked
Long!

Titles that could not enter the operation.

filesTotal
Long!

Files the confirmed plan covers.

filesProcessed
Long!

Files the operation has finished processing.

bytesTotal
Long!

Bytes the confirmed plan covers.

bytesProcessed
Long!

Bytes the operation has finished processing.

merges
Long!

Titles merged into an existing destination title.

dedups
Long!

Files recycled as proven duplicates.

renames
Long!

Files renamed to avoid a collision.

noOps
Long!

Titles that needed no change.

unresolved
Long!

Items still needing a user decision.

One source file proven identical to destination content, so it is recycled instead of copied.

Fields

NameDescription
sourcePath
String!

Path of the redundant source copy.

sourceName
String!

Its file name.

survivingPath
String

Path of the destination copy that survives, or null when the plan does not carry enough placement to name it.

survivingName
String

File name of that survivor.

done
Boolean!

Whether this deduplication has happened. False means the title carrying it has not settled yet, so the source copy is still in place.

A confirmed location operation and everything Activity shows about it.

Fields

NameDescription
id
ID!

Operation identity.

operationType
LocationOperationTypeValue!

Which location workflow this operation belongs to.

mode
LocationExecutionModeValue!

How the filesystem side is performed.

state
LocationOperationStateValue!

Lifecycle state.

initiatedByUserId
ID

User who confirmed the operation, or null once that user is deleted.

sourceLibraryId
ID

Source library, when the operation is scoped to one.

destinationLibraryId
ID

Destination library; differs from the source only for transfers.

sourceRootId
ID

Source root, for root-scoped operations.

destinationRootId
ID

Destination root.

planFingerprint
String!

Fingerprint of the full confirmed plan.

verificationDepth
VerificationDepthValue!

Depth the user's preference asked for at confirmation time.

verificationFallbackCount
Long!

Files that could only be proven at the quick floor.

counters
LocationOperationCountersPayload!

Aggregate counters shown in Activity.

detail
String

Concise failure or warning explanation.

reasonCode
String

Machine-readable reason the operation stopped short, for guidance and translation: ownership_conflict, storage_error, verification_mismatch, stale_plan, merge_unavailable, catalog_write_failed, source_cleanup_failed, stranded, canceled, abandoned, or root_unavailable. Null while it is running or when it finished.

jobRunId
ID

The Activity job run this operation reports through, when it has one.

workflowOperationId
ID

The workflow-operation row this operation reports through, when it has one.

cancelRequested
Boolean!

Whether a cancel was requested.

cancelRequestedAt
DateTime

When the cancel was requested.

confirmedAt
DateTime

When the user confirmed the fingerprinted plan.

startedAt
DateTime

When the runner first left the queued state.

createdAt
DateTime!

When the operation row was created.

updatedAt
DateTime!

When the operation row was last written.

completedAt
DateTime

When the operation reached a terminal state.

titleCheckpoints
[LocationTitleCheckpointPayload!]!

Per-title checkpoints in plan order.

A read-only preview of a location operation; nothing is changed.

Fields

NameDescription
folders
[LocationTitleFoldersPayload!]!

Source and destination folder per previewed title, in selection order.

planFingerprint
String!

Fingerprint over the full plan, echoed back to confirm it.

operationType
LocationOperationTypeValue!

Which location workflow this plan belongs to.

mode
LocationExecutionModeValue!

How the filesystem side would be performed.

sourceLibraryId
ID

Source library, when the whole selection shares one.

destinationLibraryId
ID

Destination library for the selection.

sourceRootId
ID

Source root, when the whole selection shares one.

destinationRootId
ID

Destination root, when the request named one.

selection
[ID!]!

The selection this plan was built for, in a stable order.

counts
LocationPlanCountsPayload!

Complete counts across the whole plan.

sections
[LocationPlanSectionPayload!]!

Plan sections in a stable kind order, each a complete count plus a sample.

classification
LocationSelectionClassificationPayload!

Every selected title grouped by class.

freeSpace
LocationFreeSpaceEstimatePayload!

Estimated free space the operation needs.

verification
LocationVerificationStatementPayload!

The verification depth that will apply.

confirmation
LocationPlanConfirmationPayload!

The confirmation this plan demands.

warnings
[String!]!

Warnings the user must see before confirming.

blocksStart
Boolean!

Whether blocking items or classes stop this plan from starting.

merges
[LocationMergePreviewPayload!]!

One summary per title that merges into an existing destination title. Empty for every plan with no merge in it.

One file the operation lands under a different name so destination content keeps its own.

Fields

NameDescription
sourcePath
String

Path the file is read from, or null when the stored plan no longer carries the file this destination came from.

sourceName
String

File name at the source.

destinationPath
String!

Path the file lands under.

destinationName
String!

File name it lands under.

provenanceLabel
String

Source library named inside the rename suffix, or null when the rename only had a number appended.

mediaFileId
ID

Tracked media file, or null for a companion asset.

sizeBytes
Long!

Size of the file being renamed.

done
Boolean!

Whether this rename has happened. False means the title carrying it has not settled yet, so the rename is still only planned.

One title’s renamed and deduplicated files inside an operation.

Fields

NameDescription
titleId
ID!

Title these assets belong to.

titleName
String!

Title name as the confirmed plan recorded it.

sequence
Long!

Position of this title in the confirmed plan.

settled
Boolean!

Whether this title finished, which is what turns its planned renames and deduplications into things that actually happened.

checkpointState
LocationTitleCheckpointStateValue

The title's checkpoint state, or null when it has not entered the run.

renames
[LocationOperationRenamedAssetPayload!]!

Files renamed around a destination collision.

dedups
[LocationOperationDeduplicatedAssetPayload!]!

Source files recycled as proven duplicates.

The confirmation this plan demands before it may start.

Fields

NameDescription
requirement
LocationConfirmationRequirementValue!

How much consent the operation demands.

typedPhrase
String

The phrase the user must type, when typed confirmation applies.

typedPrompt
String

The prompt shown beside the typed-confirmation field.

Complete counts across the whole plan, independent of sampling.

Fields

NameDescription
itemsTotal
Long!

Every plan item, of every kind.

titlesTotal
Long!

Titles the plan covers.

filesTotal
Long!

Files the plan covers.

bytesTotal
Long!

Bytes the plan covers.

byKind
[LocationPlanKindCountPayload!]!

Per-kind complete counts, including kinds with no sampled items.

One previewed change, in the vocabulary every location workflow shares.

Fields

NameDescription
kind
LocationPlanItemKindValue!

What kind of change this item describes.

titleId
ID

Title this item belongs to, or null when it belongs to none.

mediaFileId
ID

Media file this item acts on, or null for untracked content.

sourcePath
String

Source path, or null when the item has no source.

destinationPath
String

Destination path, or null when the item has no destination.

sizeBytes
Long!

Bytes this item accounts for; zero for catalog-only items.

sameVolume
Boolean

Whether source and destination share a volume, or null when undetermined.

reasonCode
String

Machine-readable reason, for grouping and translation.

detail
String

Human-readable explanation, always present for blocking and warning items.

Complete item count for one plan-item kind.

Fields

NameDescription
kind
LocationPlanItemKindValue!

The kind being counted.

count
Long!

How many items of that kind the whole plan contains.

One section of a plan: the complete count for a kind plus a sample of its items.

Fields

NameDescription
kind
LocationPlanItemKindValue!

Kind every item in this section shares.

itemsTotal
Long!

Complete count for this section across the whole plan.

bytesTotal
Long!

Complete byte total for this section, not just the sampled items.

complete
Boolean!

Whether the sampled items are the complete section.

items
[LocationPlanItemPayload!]!

The sampled items the client renders.

The start-dialog prefill for planning an operation’s unfinished work again: the same destination, mode and verification depth, and the titles the operation did not finish. Finished titles are left out; a fresh preview reclassifies the rest.

Fields

NameDescription
operationId
ID!

Operation the selection was read from.

mode
LocationExecutionModeValue!

Who moved the files last time.

verificationDepth
VerificationDepthValue!

Verification depth the operation ran at.

destinationLibraryId
ID

Library the unfinished titles were headed for, when the operation had one.

destinationRootId
ID

Root the unfinished titles were headed for, when the operation had one.

titles
[LocationRetryTitlePayload!]!

Titles a fresh plan should select, in plan order.

catalogBlockedTitleIds
[ID!]!

Unfinished titles a fresh plan must not select: their files were verified on the destination but the catalog update failed, and only a retry of this operation finishes that.

One title a fresh plan should select, with where it is now.

Fields

NameDescription
titleId
ID!

Title identity.

titleName
String!

Title name as the plan recorded it.

sourceLibraryId
ID!

Library the title is in.

sourceRootId
ID!

Root the title is in.

sourceFolderPath
String

Folder the title owns, when the plan recorded one.

One of FR-027’s three content buckets: the complete counts plus a sample.

Fields

NameDescription
class
LocationRootContentClassValue!

Which bucket this is.

total
Long!

Complete count of files in this bucket, not just the sampled ones.

bytesTotal
Long!

Complete byte total for this bucket.

complete
Boolean!

Whether the sampled entries are the complete bucket.

entries
[LocationRootContentEntryPayload!]!

The sampled entries the client lists.

One file found beneath the root, with what the catalog could say about it.

Fields

NameDescription
path
String!

Where the file is today.

sizeBytes
Long!

Its size.

class
LocationRootContentClassValue!

Which of FR-027's three buckets it fell into.

canonicalSidecar
Boolean!

Whether it is a canonical folder-level sidecar such as movie.nfo.

Everything found beneath the source root, in FR-027’s three buckets, plus the directory facts cleanup is allowed to act on (FR-028).

Fields

NameDescription
managed
LocationRootContentBucketPayload!

Files the catalog tracks for titles assigned to this root.

companions
LocationRootContentBucketPayload!

Untracked files inside a title's folder; they travel with their title.

unknown
LocationRootContentBucketPayload!

Everything else. Listed separately because it is what keeps the old location standing.

unknownBytes
Long!

Bytes of unexplained content.

blocksSourceRemoval
Boolean!

Whether unexplained content stops the source location from being removed.

entryCount
Long!

Every scanned file across the three buckets.

prunableDirectories
LocationSampledPathsPayload!

Directories outside every title folder that hold nothing unexplained, so cleanup may remove them once they are empty.

retainedDirectories
LocationSampledPathsPayload!

Directories that hold unexplained content and are therefore left standing, with their contents.

What the root keeps when its path changes or it absorbs another root (FR-021, FR-022, FR-078).

For a root change this describes the changed root; for a consolidation it describes the destination root, the one that survives.

Fields

NameDescription
rootId
ID!

The root whose identity is retained.

keepsRootId
Boolean!

Whether the synthetic root id survives. It always does.

wasLibraryDefault
Boolean!

Whether the root was the library default before the operation.

remainsLibraryDefault
Boolean!

Whether it is the library default after the operation.

retainedRole
String

The role the root carried, when it carries one. Roots have no role concept yet, so this is always null today.

retainedTitleAssignments
Long!

Title assignments the root keeps pointing at it.

One reason the source location cannot be retired (FR-028).

Fields

NameDescription
code
String!

Machine-readable code, for grouping and translation.

detail
String!

The sentence explaining what has to be resolved.

What happens to the old location after every title has settled (FR-028, FR-031, FR-087).

Fields

NameDescription
sourceRootPath
String!

The path being retired.

destinationRootPath
String!

The path the root points at afterwards. For a consolidation this is the destination root's own configured path.

retireConfigurationAfterRecycling
Boolean!

Whether the source configuration is retired only after all recycling for the operation completes.

recycleAllowlistPaths
LocationSampledPathsPayload!

Paths that stay allowlisted for recycling while the retirement runs.

requiresVerificationBeforeSourceRemoval
Boolean!

Whether verification has to succeed before anything at the source is removed.

emptyDirectoriesOnly
Boolean!

Whether only empty directories may be removed automatically.

removableDirectories
LocationSampledPathsPayload!

Directories cleanup may remove once they are empty, deepest first.

retainedDirectories
LocationSampledPathsPayload!

Directories that are left standing with their contents.

permitsSourceRemoval
Boolean!

Whether the source location may be removed at all.

blockers
[LocationRootRetirementBlockerPayload!]!

Every reason it may not be, when there are any.

A read-only preview of a root-scoped operation: replacing one root’s path, or folding one root into another (US4 + US5, FR-020 to FR-029).

One payload for both branches of Change root. The sections both branches share are always present; the variant-only ones are null for the other branch.

Fields

NameDescription
plan
LocationOperationPreviewPayload!

The fingerprinted plan, in the vocabulary every location workflow shares. Root-scoped plans have no title selection, so the plan's classification carries per-class counts with no per-title entries; the titles that need naming are in accounting.blockedTitles, and every changed folder name is a RENAME plan item.

accounting
LocationTitleAccountingPayload!

Every title assigned to the source root, with no way to exclude one.

retention
LocationRootIdentityRetentionPayload

What the root keeps when only its path changes. Null when the root is being folded into another root instead.

classification
LocationConsolidationClassificationPayload

FR-024's seven groups with their counts. Null for a change to a new, unconfigured path, whose destination holds nothing to classify against.

defaultTransfer
LocationDefaultRootTransferPayload

Which root new content lands on afterwards. Null for a path change, which never moves the library default.

content
LocationRootContentInventoryPayload!

Everything found beneath the source root, in three buckets.

retirement
LocationRootRetirementContractPayload!

What happens to the old location afterwards.

A complete count of paths beside the sample the client renders.

Fields

NameDescription
total
Long!

How many paths there are in total.

complete
Boolean!

Whether the sampled paths are the complete list.

paths
[String!]!

The sampled paths.

Every selected title grouped by class, with no title omitted.

Fields

NameDescription
groups
[LocationClassificationGroupPayload!]!

One group per class, always all six, including empty ones.

titlesTotal
Long!

Selected titles across every group.

blocksStart
Boolean!

Whether any title in the selection blocks the start.

Every title assigned to the root being changed or consolidated, in one closed ledger (FR-023).

There is no way to exclude a title from a root-scoped operation, so this is an accounting rather than a selection: the four counts close against assignedTotal, and a blocked title stops the operation until it is repaired.

Fields

NameDescription
assignedTotal
Long!

Every title assigned to the root.

relocating
Long!

Titles whose files move.

catalogOnly
Long!

Titles with no tracked files: catalog reassignment only (FR-076).

blocked
Long!

Titles that cannot enter the operation.

accountsForEveryTitle
Boolean!

Whether the three counts close against assignedTotal.

blocksStart
Boolean!

Whether any blocked title stops the operation from starting.

blockedTitles
[LocationBlockedTitlePayload!]!

Every blocked title, named. Rendered with no exclude affordance.

Per-title progress inside an operation; the unit a resume restarts from.

Fields

NameDescription
titleId
ID!

Title this checkpoint tracks.

sequence
Long!

Position of this title in the confirmed plan.

state
LocationTitleCheckpointStateValue!

How far this title has progressed.

classification
TitleLocationClassValue

Class this title was previewed as, or null for workflows that do not classify.

sourceLibraryId
ID

Library the title started in.

sourceRootId
ID

Root the title started on.

sourceFolderPath
String

Folder the title started in.

destinationLibraryId
ID

Library the title ends up in.

destinationRootId
ID

Root the title ends up on.

destinationFolderPath
String

Folder the title ends up in.

mergedIntoTitleId
ID

Destination title this one merges into, when it merges.

mergedIntoTitleName
String

Name of that surviving title, resolved from the catalog when the checkpoint is read. Null when it merged into a title that has since been deleted, in which case the id still identifies it.

filesTotal
Long!

Files planned for this title.

filesVerified
Long!

Files whose destination is verified.

bytesTotal
Long!

Bytes planned for this title.

bytesVerified
Long!

Bytes whose destination is verified.

detail
String

Warning or failure explanation for this title.

reasonCode
String

Machine-readable reason the title failed, for guidance and translation: storage_error, verification_mismatch, stale_plan, merge_unavailable, catalog_write_failed, or source_cleanup_failed. Null while the title is still working or when it finished.

startedAt
DateTime

When this title entered the operation.

updatedAt
DateTime!

When this checkpoint was last written.

completedAt
DateTime

When this title settled.

Where one previewed title’s folder is now and where the plan puts it.

Fields

NameDescription
titleId
ID!

Identity of the previewed title.

source
String

The folder the title occupies today, when it owns one.

destination
String

The folder the plan moves or adopts the title into, when it has one.

One file’s progress inside a location transfer, listed per title.

Fields

NameDescription
reasonCode
String

Machine-readable reason for a file that did not simply move: a conflict resolution or a transfer failure.

originalDestinationPath
String!

Destination path the plan assigned before any conflict resolution renamed it.

verificationTotalBytes
Long!

Bytes the current comparison has to read; the file size unless a comparison is in flight.

sourcePath
String!

Path the file is read from.

destinationPath
String!

Path the file lands at, after any conflict resolution.

sizeBytes
Long!

Size of the file in bytes.

state
String!

Lifecycle of this file: QUEUED, MOVING, VERIFYING, COMPARING, WAITING_FOR_STORAGE, DONE, DUPLICATE, FAILED, BLOCKED, CANCELED, or NOT_PROCESSED.

copyBytes
Long!

Bytes copied so far.

verificationBytes
Long!

Bytes read back and compared so far.

detail
String

Operator-facing explanation of an exception on this file, when there is one.

A bounded view of a running or finished transfer: the operation, its aggregate progress, and one page of titles or files.

Fields

NameDescription
generation
Long!

Server generation the revision counts within; a restart starts a new one.

revision
Long!

Monotonic change counter within the generation. Reads never advance it; progress does.

operation
LocationOperationPayload!

The operation the snapshot describes.

progressBasisPoints
Int!

Overall progress in hundredths of a percent, 0 to 10000.

etaSeconds
Long

Estimated seconds until completion, once enough progress exists to estimate.

titles
[LocationTransferTitlePayload!]!

The page of titles requested; empty for a summary read.

files
[LocationTransferFilePayload!]!

The page of files requested for one title; empty otherwise.

totalCount
Long!

Total number of rows the page is drawn from.

hasMore
Boolean!

True when rows beyond this page remain.

One title’s live progress inside a location transfer, as Activity shows it.

Fields

NameDescription
titleId
ID!

Identity of the title this row tracks.

name
String!

Display name of the title.

state
LocationTitleCheckpointStateValue!

The title's checkpoint state at the time of the snapshot.

filesTotal
Long!

Number of files the plan walks for this title.

filesDone
Long!

Files verified at the destination so far.

bytesTotal
Long!

Bytes the title's files add up to.

copyBytes
Long!

Bytes copied so far across the title's files.

verificationBytes
Long!

Bytes read back and compared so far across the title's files.

copying
Int!

Files currently being copied.

verifying
Int!

Files currently being verified.

currentFile
String

Path of the file the runner is working on, when one is in flight.

hasException
Boolean!

True when the title carries a detail worth reading; fetch it with locationTransferTitleDetail.

The verification depth this plan will apply, stated before anything moves.

Fields

NameDescription
depth
VerificationDepthValue!

Depth resolved from the user preference at preview time.

files
Long!

Files this depth will be applied to.

bytes
Long!

Bytes this depth will be applied to.

applies
Boolean!

Whether any file in this plan will actually be verified.

Result of completing MFA enrollment during login.

Fields

NameDescription
status
TotpStatusPayload!

Updated TOTP status without the shared secret.

recoveryCodes
[String!]!

Newly generated one-time recovery codes.

login
LoginPayload!

Authenticated login payload issued after enrollment completes.

Result of completing passkey enrollment during a restricted login enrollment session.

Fields

NameDescription
passkey
PasskeySummaryPayload!

Registered passkey summary.

login
LoginPayload!

Authenticated login payload issued after enrollment completes.

Session or restricted authentication result returned after authentication.

Fields

NameDescription
token
String!

Access token or short-lived MFA-enrollment token; clients must treat it as secret.

user
UserPayload!

Authenticated user summary without password or credential secrets.

expiresAt
DateTime!

Token expiry as a UTC timestamp.

mfaVerifiedUntil
DateTime

UTC time through which MFA verification remains fresh, or null when not verified.

securityActionVerifiedUntil
DateTime

UTC time through which account-security changes may be authorized.

mfaEnrollmentRequired
Boolean!

True when the token can only complete MFA enrollment.

passwordChangeRequired
Boolean!

True when the token can only replace an administrator-provided temporary password.

persistSession
Boolean!

Whether the session was requested to persist.

Static registry entry describing one maintenance action to the rule builder.

Fields

NameDescription
supportedRuleScopes
[MaintenanceRuleSubjectKind!]!

Scopes for which this build implements the action.

kind
MaintenanceActionKind!

Catalog action this descriptor describes.

supportedSubjects
[MaintenanceActionSubject!]!

Subjects the action may be configured against.

riskClass
MaintenanceRiskClass!

Risk class governing the controls the action requires.

effectClasses
[String!]!

Effect classes the action declares for conflict arbitration.

timingMode
String!

When a due action becomes eligible to execute.

allowedRepeatModes
[String!]!

Repeat semantics the registry allows for the action.

requiresTargetQualityProfile
Boolean!

Whether configuring the action requires a target quality profile.

requiresTags
Boolean!

Whether configuring the action requires at least one title tag.

supportsStorageScope
Boolean!

Whether this action remains valid when a configured storage root limits the files it may affect.

Durable receipt for an external job requested by a schema-2 action step.

Fields

NameDescription
dispatchAttempt
Int!

Dispatch ordinal for this durable external-job request.

logicalRequestKey
String!

Idempotent key identifying the requested external job.

jobRunId
ID

External job-run identifier after the request is accepted.

state
String!

Latest reconciliation state of the external job request.

createdAt
DateTime!

UTC time this receipt was created.

updatedAt
DateTime!

UTC time this receipt was last reconciled.

One recorded action-handler attempt on one candidate, holds included.

Fields

NameDescription
subjectLabel
String!

Exact subject display label from execution evidence or the current catalog.

detail
String!

Persisted per-file outcomes and policy provenance.

subjectKind
String!

Persisted subject scope: title, season, or episode.

subjectId
ID!

Persisted Scryer title, collection, or episode ID targeted by this attempt.

id
ID!

Action-run ID.

ruleSetId
ID!

Rule set the attempt belongs to.

candidateId
ID!

Candidate the attempt acted on.

titleId
ID!

Title the attempt acted on.

titleName
String!

Display name of the title, or its stored ID when the title is gone.

actionKind
MaintenanceActionKind!

Action the attempt performed or refused.

actionSequence
MaintenanceActionSequence

The immutable schema-2 sequence this attempt executed. Legacy attempts retain their original actionKind and leave this null.

sequenceSteps
[MaintenanceActionStepProgress!]!

Ordered latest evidence for every step in the immutable sequence.

matchGeneration
Int!

Match generation of the candidate at attempt time.

attempt
Int!

Attempt number for this candidate generation, starting at one.

status
String!

Outcome: running, succeeded, already_satisfied, failed, or held.

holdReason
String

Why a held attempt was refused; null otherwise.

error
String

Error text of a failed attempt; null otherwise.

startedAt
DateTime!

UTC start time of the attempt.

finishedAt
DateTime

UTC finish time; null while the attempt is running.

The authoritative, schema-versioned sequence a revision authorizes.

Fields

NameDescription
schemaVersion
Int!

Schema version that defines the accepted step representation.

steps
[MaintenanceActionStep!]!

Ordered steps that make up the revision's action sequence.

The closed, schema-versioned action configuration a rule revision stores.

Fields

NameDescription
kind
MaintenanceActionKind!

Catalog action the revision authorizes.

schemaVersion
Int!

Schema version the stored parameters were validated against.

targetQualityProfileId
String

Target quality profile, set only for the quality-profile action and null for every other kind.

tags
[String!]!

Tags the action writes, set only for the tag actions and empty for every other kind. Labels are registry-defined and stored lowercase.

One ordered action in a revision-bound sequence.

Fields

NameDescription
id
ID!

Stable identifier used by durable execution receipts and history.

kind
MaintenanceActionStepKind!

Catalog primitive this ordered step executes.

parameters
MaintenanceActionStepParameters!

Typed parameters accepted by this step's catalog primitive.

Backend-owned capabilities for one schema-2 primitive.

Fields

NameDescription
id
String!

Stable catalog identifier for this primitive.

kind
MaintenanceActionStepKind!

Primitive represented by this descriptor.

label
String!

Operator-facing label for the primitive.

supportedSubjects
[MaintenanceActionSubject!]!

Subjects that may use this primitive.

parameterSchema
String!

Name of the typed parameter shape accepted by this primitive.

effectClasses
[String!]!

Effects used when arbitrating conflicts with other steps.

riskClass
MaintenanceRiskClass!

Risk class that determines the required arming level.

requires
[String!]!

Preconditions this primitive requires before it can execute.

terminal
Boolean!

Whether this primitive ends the sequence when it succeeds.

completionPolicy
String!

How completion for this primitive is determined.

storageRootAllowed
Boolean!

Whether this primitive is permitted for a storage-root-scoped rule.

One typed parameter set for a sequence step. The action catalog decides which fields are meaningful for each kind; the application rejects every other shape before the sequence can be stored.

Fields

NameDescription
includeDescendants
Boolean

Whether a title-level unmonitor step also unmonitors its seasons and episodes. This is required before a title file-deletion step can cover a show completely.

targetQualityProfileId
String

Target profile for a quality-profile step.

searchCondition
MaintenanceSearchCondition

Dispatch condition for a search step.

tags
[String!]!

Tags written by an add-tags or remove-tags step.

One configured step with the latest outcome and any durable job receipts.

Fields

NameDescription
step
MaintenanceActionStep!

Immutable step definition from the sequence revision.

run
MaintenanceActionStepRun

Latest durable checkpoint for this step, or null before execution starts.

receipts
[MaintenanceActionJobReceipt!]!

Durable external-job receipts associated with this step.

The latest durable checkpoint for one ordered schema-2 step.

Fields

NameDescription
stepId
ID!

Stable identifier of the sequence step this checkpoint belongs to.

stepKind
String!

Stored catalog kind for the step checkpoint.

state
String!

Latest durable state for this step.

attempt
Int!

Number of durable attempts made for this step.

holdReason
String

Reason execution is waiting, when the step is held.

error
String

Failure message for the latest step attempt, when any.

createdAt
DateTime!

UTC time the step checkpoint was created.

updatedAt
DateTime!

UTC time the step checkpoint was last updated.

finishedAt
DateTime

UTC time the latest step attempt finished, or null while active.

One subject’s durable membership in one maintenance rule set.

A candidate records that a rule matched the subject, how long its grace period still has to run, and, once the handler has acted, what happened. state is the authority on which of those a given row is: opening a candidate never acts on anything, and only EXECUTING, SUCCEEDED, and FAILED mean an action was attempted.

Fields

NameDescription
fileCount
Int

Number of current subject files, or null if the subject is unavailable.

totalSizeBytes
Int

Current subject file size in bytes, or null if the subject is unavailable.

storageRootFileCount
Int

Number of unambiguously owned current subject files on the root selected by this candidate's pinned revision, or null when no root is selected or exact root ownership cannot be established.

storageRootTotalSizeBytes
Int

Total bytes of unambiguously owned current subject files on the root selected by this candidate's pinned revision. It is null under the same conditions as storageRootFileCount.

subjectLabel
String!

Exact subject display label, falling back to its ID if unavailable.

subjectKind
String!

Subject scope: title, season, or episode.

subjectId
ID!

Scryer title, collection, or episode ID identifying this candidate's subject.

id
ID!

Candidate ID.

ruleSetId
ID!

Rule set that produced the candidate.

ruleName
String!

Name of that rule set.

revisionNumber
Int!

Rule revision in force when the candidate was opened.

titleId
ID!

Subject title ID.

titleName
String!

Subject title name, or the stored title ID when the title is gone.

libraryId
String!

Library the subject belonged to when the candidate was opened.

facet
String!

Media facet of the subject.

state
MaintenanceCandidateState!

Current lifecycle state.

stateReason
String!

Why the candidate is in that state.

reasonCodes
[String!]!

Reason codes the matcher emitted on the most recent match.

actionKind
MaintenanceActionKind!

Action the rule revision authorizes, and the one the handler will run if this candidate becomes due while the rule is in OBSERVE mode, armed for the action's risk class, and its instance effect gate is on.

actionSequence
MaintenanceActionSequence

The immutable schema-2 sequence that opened this candidate. Legacy candidates retain their original actionKind and leave this null.

sequenceSteps
[MaintenanceActionStepProgress!]!

Ordered latest evidence for each schema-2 step. An empty sequence is an observe-only candidate rather than a missing action.

graceDays
Int!

Days the subject must match continuously before the action is due.

matchGeneration
Int!

Increments each time a fresh candidate is opened for this subject, so a cancel-then-rematch is distinguishable from a continuing membership.

firstMatchedAt
DateTime!

When the subject started matching. Never reset while the candidate lives.

lastMatchedAt
DateTime!

When the subject most recently matched.

dueAt
DateTime!

When the grace period elapses, equal to firstMatchedAt for a zero-day grace period.

heldSince
DateTime

Set while the latest evaluation could not decide, and null otherwise.

updatedAt
DateTime!

UTC last-update time.

One rule set’s pass through one evaluation run.

Fields

NameDescription
id
ID!

Evaluation-run ID.

ruleSetId
ID!

Rule set that was evaluated.

revisionNumber
Int!

Rule revision that was evaluated.

status
String!

One of running, succeeded, or failed. A run left running is the trace of an interrupted pass.

startedAt
DateTime!

When the pass started.

finishedAt
DateTime

When the pass finished, or null while it is still running.

evaluatedCount
Int!

Subjects the matcher was run against.

matchedCount
Int!

Subjects the matcher matched.

noMatchCount
Int!

Subjects the matcher did not match.

unknownCount
Int!

Subjects the matcher could not decide, which are held.

errorCount
Int!

Subjects whose evaluation failed, which are also held.

durationMs
Int

How long the pass took, or null while it is still running.

error
String

Why the pass failed, or null when it did not.

Outcome of asking for an immediate evaluation pass.

Fields

NameDescription
started
Boolean!

Whether a pass was started. False when a gate, a disabled rule, or a run already in progress stopped it.

message
String

What happened, suitable for showing to an operator.

A subject a maintenance rule must never act on.

Fields

NameDescription
subjectLabel
String!

Exact excluded subject label, falling back to its ID if unavailable.

subjectKind
String!

Excluded scope: title, season, or episode. Parent exclusions cover descendants.

subjectId
ID!

Scryer title, collection, or episode ID of the excluded subject.

id
ID!

Exclusion ID.

ruleSetId
ID

Rule the exclusion is confined to, or null when it is global.

titleId
ID!

Excluded title ID.

titleName
String!

Excluded title name, or the stored title ID when the title is gone.

reason
String!

Why the subject was excluded; empty when the author gave no reason.

createdBy
ID

ID of the user who added the exclusion, or null when unattributed.

createdAt
DateTime!

UTC creation time.

The five independent instance-wide maintenance gates. Every one of them defaults off, an unconfigured instance therefore evaluates nothing and acts on nothing, and each gate is read at the start of every scheduled pass so a change takes effect on the next run without a restart.

A gate is only ever the instance half of a permission. Executing an action additionally requires the individual rule to be in OBSERVE mode and armed for that action’s risk class, so opening a gate cannot by itself start anything.

Fields

NameDescription
evaluationEnabled
Boolean!

Whether the scheduled evaluator may run at all. While this is off no rule is evaluated, no candidate is opened or closed, and no evaluation run is recorded.

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, such as unmonitoring a title or changing its quality profile. A rule armed as REVERSIBLE or DESTRUCTIVE starts running those actions on its due candidates while this is on.

destructiveEffectsEnabled
Boolean!

Whether high risk actions may execute, meaning the ones that delete media files. Turning this on lets every rule already armed as DESTRUCTIVE begin deleting its due candidates on the next handler pass, without any further confirmation.

Outcome of running one matcher against a bounded subject selection. Preview persists nothing.

Fields

NameDescription
ruleSetId
String!

Stored rule set the preview ran, or the throwaway ID an unsaved draft compiled under.

matcherContentHash
String!

Hash of the exact source that produced these outcomes.

evaluatedAt
DateTime!

UTC time the preview evaluated the selection.

titles
[MaintenancePreviewTitle!]!

One entry per evaluated subject, including its owning title.

One subject’s preview outcome. outcome is null exactly when error is set: a rule that failed produced no decision, and a failure is never rendered as a no-match.

Fields

NameDescription
excluded
Boolean!

Whether a direct or inherited exclusion protects this subject.

dueAt
DateTime

Existing grace deadline, or an estimated deadline for a new match.

dueAtIsEstimate
Boolean!

True when the deadline is estimated rather than persisted on a candidate.

subjectLabel
String!

Display label for the exact title, season, or episode being evaluated.

fileCount
Int!

Number of current files associated with this subject.

totalSizeBytes
Int!

Combined size in bytes of this subject's current files.

storageRootFileCount
Int

Number of files eligible for deletion on the selected storage root, or null when this matcher does not select a resolvable root.

storageRootTotalSizeBytes
Int

Combined bytes eligible for deletion on the selected storage root, or null when this matcher does not select a resolvable root.

subjectKind
String!

Subject scope: title, season, or episode.

subjectId
ID!

Scryer title, collection, or episode ID for the selected scope.

titleId
ID!

Evaluated title ID.

titleName
String!

Evaluated title name.

facet
String!

Media facet of the evaluated title.

libraryId
String!

Library containing the evaluated title.

outcome
MaintenanceOutcome

Decision the matcher reached, or null when evaluation failed.

reasonCodes
[String!]!

Reason codes the matcher emitted; empty when it emitted none.

error
String

Why evaluation failed for this subject, or null when it succeeded.

One immutable revision of a maintenance rule set’s matcher and action.

Fields

NameDescription
id
ID!

Revision ID.

ruleSetId
ID!

ID of the rule set this revision belongs to.

revisionNumber
Int!

Revision number, starting at one and incremented on every matcher edit.

regoSource
String!

Rego source as the editor should show it, with the package declaration and the rego.v1 import stripped.

graceDays
Int!

Days a subject must match continuously before the action becomes due.

storageRootId
String

Configured library root whose capacity and owned files this revision uses, or null when it is not storage-scoped.

matcherContentHash
String!

Hash of the exact stored source, used to attribute a decision to the revision that produced it.

createdBy
ID

ID of the user who wrote the revision, or null when unattributed.

createdAt
DateTime!

UTC creation time.

A maintenance rule set: identity, scope, and evaluation state. The matcher and the action it authorizes live on the revision, never here.

Fields

NameDescription
id
ID!

Rule-set ID.

name
String!

Rule-set name.

description
String!

Rule-set description; empty when the author supplied none.

enabled
Boolean!

Whether the rule set is enabled. Derived from evaluationMode rather than set independently: false for DISABLED, true for SHADOW and OBSERVE.

evaluationMode
MaintenanceEvaluationMode!

Evaluation mode currently stored for the rule set.

effectArming
MaintenanceEffectArming!

How far this rule's effects are armed, independent of its mode.

destructiveRearmRequired
Boolean!

This rule was disarmed because new show facts can change its destructive title matches. Review the matcher and arm it again to acknowledge them.

libraryIds
[String!]!

Libraries the rule is confined to. Empty means every library.

subjectKind
MaintenanceRuleSubjectKind!

Granularity the rule is scoped to.

currentRevisionNumber
Int!

Revision number of the matcher currently in force.

graceDays
Int!

Grace period of the revision currently in force, in days.

actionSpec
MaintenanceActionSpec!

Action the revision currently in force authorizes.

actionSequence
MaintenanceActionSequence

Ordered schema-2 actions for the revision currently in force. Legacy rows expose their unchanged action spec and leave this null.

createdAt
DateTime!

UTC creation time.

updatedAt
DateTime!

UTC last-update time.

A rule set together with the revision currently in force.

Fields

NameDescription
ruleSet
MaintenanceRuleSet!

The rule set itself.

revision
MaintenanceRuleRevision!

The revision currently in force.

actionSpec
MaintenanceActionSpec!

The action that revision authorizes, already decoded.

actionSequence
MaintenanceActionSequence

Ordered actions for a schema-2 revision. Legacy revisions keep this null and continue to expose their original actionSpec unchanged.

Result of validating maintenance rule source without saving it.

Fields

NameDescription
valid
Boolean!

Whether the source is valid.

errors
[String!]!

Validation errors; empty when valid.

Candidate file details used to preview a manual import selection.

Fields

NameDescription
candidateId
ID!

Candidate ID within the persisted manual-import selection; use it only with that selection.

fileName
String!

Candidate file name.

sizeBytes
Long!

Candidate file size in bytes.

videoFacts
ManualImportVideoFactsPayload

Media facts when the native content probe can identify the file.

quality
String

Parsed quality label, or null when unavailable.

parsedSeason
Int

Parsed season number, or null when unavailable.

parsedEpisodes
[Int!]!

Parsed episode numbers; empty means none were detected.

suggestedEpisodeId
ID

Suggested episode ID, or null when no single suggestion is available.

suggestedEpisodeIds
[ID!]!

Every suggested episode ID for this file, in parsed order; empty means no suggestion. A multi-episode file suggests more than one.

suggestedEpisodeLabel
String

Label for the suggested episode, or null when no suggestion exists.

suggestedSeriesMovieLinkId
String

Suggested series-movie link, or null when this is not a grabbed series movie.

Persisted manual-import selection that can be submitted for execution.

Fields

NameDescription
selectionId
ID!

Identifier of the persisted selection.

archiveExtractionNeeded
Boolean!

The download contains archives and must be explicitly extracted before files can be mapped.

files
[ManualImportFilePreviewPayload!]!

Files included in the selection.

availableEpisodes
[EpisodePayload!]!

Episodes eligible as import targets for the selection.

availableSeriesMovies
[ManualImportSeriesMovieTargetPayload!]!

Series-movie links eligible as import targets for the selection.

Series-movie target candidate for a manual import.

Fields

NameDescription
seriesMovieLinkId
String!

Series-movie link identity targeted by the candidate.

movieTitle
String!

Movie title associated with the target.

year
Int

Release year, or null when unavailable.

runtimeMinutes
Int

Runtime in minutes, or null when unavailable.

Media facts obtained while qualifying a manual-import candidate.

Fields

NameDescription
containerFormat
String

Detected container format, or null when unavailable.

videoCodec
String

Detected video codec, or null when unavailable.

audioCodec
String

Detected audio codec, or null when unavailable.

videoWidth
Int

Detected video width in pixels, or null when unavailable.

videoHeight
Int

Detected video height in pixels, or null when unavailable.

durationSeconds
Int

Detected runtime in seconds, or null when unavailable.

disc
MediaDiscMetadataPayload

Detected disc structure and authored titles for an ISO image.

report
MediaProbeReportPayload!

Probe status, limits, and reasons for incomplete qualification.

Preview of a manually supplied plugin repository.

Fields

NameDescription
githubRepoUrl
String!

GitHub repository URL used for the preview.

plugin
RegistryPluginPayload!

Resolved registry metadata.

Latest analysis attempt, retained separately from the last successful metadata.

Fields

NameDescription
revision
Int!

Analysis schema revision; zero denotes legacy metadata.

attemptedAt
String!

Timestamp of the analysis attempt in RFC 3339 form.

succeeded
Boolean!

Whether this attempt published successful metadata.

report
MediaProbeReportPayload!

Inspection status, coverage counters, and warnings.

disc
MediaDiscMetadataPayload

Detected disc metadata, when this source is a disc image.

Versioned native analysis shared by imports, scans, rules, and media details.

Fields

NameDescription
is3D
Boolean!

Explicit media metadata detected stereoscopic video.

revision
Int!

Analysis schema revision; zero denotes legacy metadata.

durationSeconds
Float

Playback duration in seconds, when established.

durationProvenance
MediaProvenanceValue!

Evidence source for playback duration.

overallBitrateBps
Long

Overall source bitrate in bits per second, distinct from video bitrate.

selectedVideoId
String

Container ID of the primary non-cover video stream.

selectedProgramId
Int

Program used for summary and scoring facts.

streams
[MediaStreamDetailPayload!]!

Detected streams in container order, including supplementary tracks.

programs
[MediaProgramPayload!]!

Detected programs, including programs excluded from summary scoring.

chapters
[MediaChapterPayload!]!

Authored chapter titles and timing.

attachments
[MediaAttachmentPayload!]!

Embedded attachment inventory without extracted payloads.

captionServices
[MediaCaptionServicePayload!]!

Caption services detected within the inspected headers.

disc
MediaDiscMetadataPayload

Detected disc metadata, when this source is a disc image.

report
MediaProbeReportPayload!

Inspection status, coverage counters, and warnings.

Embedded attachment inventory without extracting the attachment.

Fields

NameDescription
id
String!

Identifier within the source metadata.

name
String

Name supplied by the container metadata.

mediaType
String

Attachment media type, when supplied.

sizeBytes
Long!

Attachment size in bytes.

Caption service detected in sampled headers; no transcription is performed.

Fields

NameDescription
streamId
String!

Container stream ID associated with this result.

standard
String!

Caption standard, such as CEA-608 or CEA-708.

serviceNumber
Int

Caption service number, when available.

language
String

Normalized language tag, when known.

Chapter timing on the relevant media or selected-title timeline.

Fields

NameDescription
id
String!

Identifier within the source metadata.

title
String

Authored chapter title, when supplied.

startSeconds
Float!

Chapter start time in seconds.

endSeconds
Float

Chapter end time in seconds, when known.

Color signaling and static HDR metadata, with evidence provenance.

Fields

NameDescription
primaries
Int

Numeric color primaries code.

transfer
Int

Numeric transfer characteristic code.

matrix
Int

Numeric matrix coefficients code.

fullRange
Boolean

Whether full-range samples are explicitly signaled.

provenance
MediaProvenanceValue!

Evidence source used for these values.

masteringDisplay
MediaMasteringDisplayPayload

Static mastering display metadata, when present.

contentLight
MediaContentLightPayload

Static content light metadata, when present.

Content light level metadata in candelas per square metre.

Fields

NameDescription
maxCll
Int

Maximum content light level in candelas per square metre.

maxFall
Int

Maximum frame-average light level in candelas per square metre.

Byte range read during structural diagnostics.

Fields

NameDescription
offset
Long!

Byte offset from the start of the inspected source.

length
Long!

Length of this inspected range in bytes.

Persisted association between an authored disc title and catalogued episodes.

Fields

NameDescription
discTitleId
String!

Authored disc title or playlist ID.

episodeIds
[String!]!

Catalogued episodes explicitly associated with this authored title.

An episode eligible for explicit disc-title mapping.

Fields

NameDescription
episodeId
ID!

Catalogued episode ID.

label
String!

Display label for this episode.

durationSeconds
Long

Playback duration in seconds, when established.

Detected disc structure, title inventory, and current selection.

Fields

NameDescription
discType
String!

Detected disc type, independent of the physical file extension.

filesystem
String!

Detected image filesystem.

volumeLabel
String

Filesystem volume label, when present.

titles
[MediaDiscTitlePayload!]!

Distinct authored titles retained by bounded inspection.

selectedTitleId
String

Currently resolved authored title ID; null means no valid selection.

automaticSelection
Boolean!

Whether the current title was chosen automatically.

selection
MediaDiscSelectionPayload!

Persisted override and explicit episode mappings.

One ordered segment and trim range in an authored playback sequence.

Fields

NameDescription
path
String!

Referenced media path inside the disc image.

inSeconds
Float!

Playback trim start in seconds.

outSeconds
Float!

Playback trim end in seconds.

angle
Int!

Selected authored angle number.

sequenceId
Int

Authored sequence identifier used to preserve playback ordering.

Saved manual title override and episode mappings.

Fields

NameDescription
titleId
String

Manual authored title ID; null requests automatic selection.

episodeMappings
[MediaDiscEpisodeMappingPayload!]!

Explicit authored-title-to-episode associations for this physical image.

Distinct authored playback title, its timeline, and inspected stream facts.

Fields

NameDescription
id
String!

Identifier within the source metadata.

aliases
[String!]!

Other title IDs with the same ordered segment and trim sequence.

durationSeconds
Float

Playback duration in seconds, when established.

angleCount
Int!

Number of authored angles reported for this title.

segments
[MediaDiscSegmentPayload!]!

Ordered playback segments including trims.

chapters
[MediaChapterPayload!]!

Authored chapter titles and timing.

streams
[MediaStreamDetailPayload!]!

Detected streams in container order, including supplementary tracks.

report
MediaProbeReportPayload!

Inspection status, coverage counters, and warnings.

Dolby Vision configuration reported by the container or bitstream.

Fields

NameDescription
profile
Int

Codec profile reported for this stream.

level
Int

Codec-specific level identifier.

baseLayerCompatibilityId
Int

Dolby Vision base layer compatibility identifier.

rpuPresent
Boolean

Whether Dolby Vision reference processing metadata is signaled.

enhancementLayerPresent
Boolean

Whether a Dolby Vision enhancement layer is signaled.

baseLayerPresent
Boolean

Whether a Dolby Vision base layer is signaled.

Independent HDR capabilities; combinations are preserved and null means unknown.

Fields

NameDescription
dolbyVision
Boolean

Whether Dolby Vision is established by the available evidence.

hdr10Plus
Boolean

Whether HDR10+ dynamic metadata was detected.

hdr10
Boolean

Whether the available bit-depth and color evidence establishes HDR10.

hlg
Boolean

Whether Hybrid Log-Gamma transfer is signaled.

pq
Boolean

Whether Perceptual Quantizer transfer is signaled; this alone does not establish HDR10.

dovi
MediaDolbyVisionPayload

Dolby Vision configuration details.

Mastering display chromaticity coordinates and luminance.

Fields

NameDescription
redX
Float

X chromaticity coordinate of the red primary.

redY
Float

Y chromaticity coordinate of the red primary.

greenX
Float

X chromaticity coordinate of the green primary.

greenY
Float

Y chromaticity coordinate of the green primary.

blueX
Float

X chromaticity coordinate of the blue primary.

blueY
Float

Y chromaticity coordinate of the blue primary.

whiteX
Float

X chromaticity coordinate of the white point.

whiteY
Float

Y chromaticity coordinate of the white point.

minLuminance
Float

Minimum mastering display luminance in candelas per square metre.

maxLuminance
Float

Maximum mastering display luminance in candelas per square metre.

Probe coverage, resource usage, and reasons for incomplete metadata.

Fields

NameDescription
status
MediaProbeStatusValue!

Outcome of this bounded inspection.

bytesRead
Long!

Total bytes read while probing, including repeated reads.

seeks
Long!

Number of seek operations performed.

elapsedMs
Long!

Elapsed probe time in milliseconds.

budgetExhausted
Boolean!

Whether any configured inspection budget was exhausted.

warnings
[MediaProbeWarningPayload!]!

Structured warnings explaining conflicts, unsupported features, or incomplete coverage.

A structured warning from bounded media inspection.

Fields

NameDescription
code
String!

Stable warning code.

message
String!

Human-readable warning details.

streamId
String

Container stream ID associated with this result.

offset
Long

Byte offset from the start of the inspected source.

Container program and its member streams.

Fields

NameDescription
id
Int!

Identifier within the source metadata.

name
String

Name supplied by the container metadata.

streamIds
[String!]!

Container stream IDs belonging to this program.

durationSeconds
Float

Playback duration in seconds, when established.

Exact rational value with a nonzero denominator.

Fields

NameDescription
numerator
Long!

Signed numerator.

denominator
Long!

Positive denominator.

Result for one applied media rename plan item.

Fields

NameDescription
collectionId
ID

Collection ID, or null when not part of a collection.

seriesMovieLinkIds
[ID!]!

Series-movie link IDs associated with the item.

currentPath
String!

Path before the apply operation.

proposedPath
String

Planned path, or null when no rename was proposed.

finalPath
String

Final path after application, or null when not moved.

writeAction
String!

Write action attempted.

status
String!

Apply status.

reasonCode
String!

Machine-readable reason for the outcome.

errorMessage
String

Error message, or null when the item succeeded or was skipped without error.

Aggregate result of applying a previously generated rename plan.

Fields

NameDescription
planFingerprint
String!

Fingerprint of the plan that was applied.

total
Int!

Total plan-item count.

applied
Int!

Number of items applied.

skipped
Int!

Number of items skipped.

failed
Int!

Number of items that failed.

items
[MediaRenameApplyItemPayload!]!

Per-item apply results.

One media rename plan item with current and proposed paths and decision details.

Fields

NameDescription
collectionId
ID

Collection ID, or null when not part of a collection.

seriesMovieLinkIds
[ID!]!

Series-movie link IDs associated with the item.

currentPath
String!

Current filesystem path.

proposedPath
String

Proposed filesystem path, or null when no rename is possible.

normalizedFilename
String

Normalized filename, or null when metadata is insufficient.

collision
Boolean!

Whether the proposed path collides with another path.

reasonCode
String!

Machine-readable reason for the plan decision.

writeAction
String!

Planned write action.

sourceSizeBytes
Long

Source file size in bytes, or null when unavailable.

sourceMtimeUnixMs
Long

Source modification time as Unix milliseconds, or null when unavailable.

Read-only media rename plan and stable fingerprint for later application.

Fields

NameDescription
facet
MediaFacetValue!

Media facet covered by the plan.

titleId
ID

Target title ID, or null when the plan covers the whole facet.

template
String!

Rename template used to generate proposed paths.

collisionPolicy
RenameCollisionPolicyValue!

Collision policy used by the plan.

missingMetadataPolicy
RenameMissingMetadataPolicyValue!

Missing-metadata policy used by the plan.

fingerprint
String!

Stable fingerprint required to apply this exact plan.

total
Int!

Total plan-item count.

renamable
Int!

Number of items eligible for rename.

noop
Int!

Number of items already matching the desired path.

conflicts
Int!

Number of collision items.

errors
Int!

Number of items with planning errors.

items
[MediaRenamePlanItemPayload!]!

Plan items in deterministic service order.

Identifier returned after a media-request action.

Fields

NameDescription
requestId
ID!

The media request the action applied to.

Event payload identifying a changed media request.

Fields

NameDescription
eventId
ID!

ID of the event.

eventType
DomainEventTypeValue!

Domain event type that caused the notification.

requestId
ID!

ID of the changed media request.

libraryId
ID!

ID of the library containing the request.

Media-request counts grouped by media facet.

Fields

NameDescription
movie
Int!

Movie request count.

series
Int!

Series request count.

anime
Int!

Anime request count.

One provider-specific rating captured when a media request was submitted.

Fields

NameDescription
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.

The lease one media request holds, derived from the live claim it produced. Null on the request payload until an approval creates that claim.

Fields

NameDescription
requestedDays
Int

Days the requester asked for; null means forever.

approvedDays
Int

Days the approver granted; null means forever.

state
LifecycleClaimStateValue!

State of the claim holding the title.

startsAt
DateTime

When the lease started running, which is the title's first import. Null while the claim is dormant.

expiresAt
DateTime

When the lease runs out. Null while dormant and for a forever request.

The metadata a media request was decided against, read back out of the snapshot captured when it was submitted.

partial is the load-bearing field: it separates “the source says this title has no content rating” from “we could not ask the source”, and a fact derived from a missing group reads as unknown rather than absent.

Fields

NameDescription
partial
Boolean!

True when enrichment did not fully succeed.

missing
[String!]!

Groups that could not be established (content_ratings, genres, mdblist, ratings, awards, or all).

genres
[String!]!

Genres captured at submit time.

contentRatings
[DiscoveryContentRatingPayload!]!

Content ratings captured at submit time, one entry per country.

ageRating
Int

Minimum age the captured ratings imply, or null when none of them said.

certificationLabel
String

US certification label, or null when the title has no US certification.

certificationRank
Int

That label's rank on Scryer's US ladder, or null when the label is not on it. A label off the ladder is an absence of a rank, not an unknown.

isAdult
Boolean!

True when any captured canonical tag is flagged adult.

tmdbVoteAverage
Float

TMDB vote average, published for movies only.

tmdbVoteCount
Int

TMDB vote count, published for movies only.

popularity
Float

TMDB popularity, published for movies only.

awardCount
Int!

How many awards the snapshot captured.

Media request with current status, title identity, and resolution metadata.

Fields

NameDescription
id
ID!

ID of the media request.

libraryId
ID!

ID of the library targeted by the request.

facet
MediaFacetValue!

Media facet targeted by the request.

status
MediaRequestStatusValue!

Current request lifecycle status.

identityFingerprint
String!

Stable identity fingerprint used to deduplicate requests.

title
String!

Display title at request time.

sortTitle
String

Sort title, or null when unavailable.

slug
String

Provider slug, or null when unavailable.

posterUrl
String

Poster URL, or null when unavailable.

backgroundUrl
String

Background art URL captured at submit time, or null when unavailable.

year
Int

Release year, or null when unknown.

overview
String

Overview text, or null when unavailable.

runtimeMinutes
Int

Runtime in minutes, or null when unknown.

language
String

Original language code, or null when unknown.

contentStatus
String

Provider content status, or null when unavailable.

rating
Float

Combined metadata rating, or null when unavailable.

ratingSources
[String!]!

Sources contributing to the combined metadata rating.

externalRatings
[MediaRequestExternalRatingPayload!]!

Provider-specific metadata ratings.

requestedQualityProfileId
ID

ID of the quality profile requested, or null when none was selected.

requestedQualityProfileName
String

Name of the requested quality profile, or null when none was selected.

requestedMonitorType
MonitorTypeValue

Requested monitoring mode, or null when not specified.

requestedMonitorSelection
MonitorSelectionPayload

Seasons and series movies requested under ADVANCED monitoring, or null.

resolvedByUserId
ID

ID of the user who resolved the request, or null while unresolved.

resolvedAt
DateTime

UTC time when the request was resolved, or null while unresolved.

createdTitleId
ID

ID of the title created from the request, or null when not created.

approvedQualityProfileId
ID

ID of the approved quality profile, or null before approval.

approvedQualityProfileName
String

Name of the approved quality profile, or null before approval.

externalIds
[ExternalIdPayload!]!

Provider identifiers associated with the request.

requesters
[MediaRequestRequesterPayload!]!

Users who submitted or joined the request.

createdByUserId
ID!

ID of the user who created the request.

createdAt
DateTime!

UTC time when the request was created.

updatedAt
DateTime!

UTC time when the request was last changed.

requestedLeaseDays
Int

Days the requester asked the media to be kept for; null means forever.

approvedLeaseDays
Int

Days the approver granted; null means forever, and it stays null until the request is approved.

lease
MediaRequestLease

The lease actually holding the created title, or null until an approval creates the claim.

decision
RequestRuleDecision

The decision request rules recorded for this request, or null when it was never evaluated. A requester reading their own request gets it with votes emptied.

policyTags
[String!]!

Tags the policy emitted for this request. Stamped on the title only when the request is approved.

metadata
MediaRequestMetadataPayload!

The metadata the request was decided against, as captured at submit time.

User who submitted a media request.

Fields

NameDescription
userId
ID!

ID of the requesting user.

username
String!

Requesting user's username.

avatarUrl
String

Avatar URL, or null when unavailable.

requestedAt
DateTime!

UTC time when this user submitted the request.

Configured media-server connection with secrets represented by presence flags.

Fields

NameDescription
id
ID!

Connection identity.

provider
MediaServerProviderValue!

Media-server provider type.

displayName
String!

Display name of the connection.

baseUrl
String!

Server base URL.

externalUrl
String

Browser-facing URL used for playback deep links.

enabled
Boolean!

Whether the connection is active.

loginEnabled
Boolean!

Whether login through this server is enabled.

linkingEnabled
Boolean!

Whether account linking through this server is enabled.

autoAddEnabled
Boolean!

Whether automatic account addition is enabled.

defaultAppPermissions
[AppPermissionValue!]!

Default application permissions for auto-added users.

defaultLibraryGrants
[MediaServerDefaultLibraryGrantPayload!]!

Default library grants for auto-added users.

machineIdPresent
Boolean!

Whether a machine identity is configured.

apiKeyPresent
Boolean!

Whether an API key is configured.

embyServerIdPresent
Boolean!

Whether an Emby server id is configured.

embyConnectEnabled
Boolean!

Whether Emby Connect is enabled.

pathMappings
[MediaServerPathMappingPayload!]!

Configured external-to-local path mappings.

createdAt
DateTime!

Creation timestamp in RFC 3339 format.

updatedAt
DateTime!

Last update timestamp in RFC 3339 format.

Result of a media-server connection test.

Fields

NameDescription
status
String!

Machine-readable test status.

message
String

Optional human-readable detail.

Default library permission grant for a media-server connection.

Fields

NameDescription
libraryId
ID!

Library identity receiving the grant.

permissions
[LibraryPermissionValue!]!

Permissions granted by default.

Mapping from an external media-server path to a local path.

Fields

NameDescription
sourcePath
String!

Path reported by the external server.

destinationPath
String!

Corresponding local filesystem path.

A provider-native playback link for a server linked to the current user.

Fields

NameDescription
connectionId
ID!

Connection identity. This is not a credential or provider token.

displayName
String!

User-configured server name.

provider
MediaServerProviderValue!

Provider that owns the destination item.

href
String!

Browser URL for the exact provider media item.

Grouped media-server users and discovery status.

Fields

NameDescription
connectionId
ID!

Media-server connection identity.

connectionName
String!

Connection display name.

provider
ExternalAccountProviderValue!

External provider type.

status
MediaServerUserGroupStatusValue!

Discovery status.

errorMessage
String

Error detail when discovery failed.

users
[MediaServerUserPayload!]!

Users discovered from the server.

User returned from a media-server account discovery operation.

Fields

NameDescription
id
String!

Server-side user identity.

username
String!

Username on the server.

displayName
String

Optional display name.

avatarUrl
String

Optional avatar URL.

Effective media path, naming, import, permission, and monitoring settings for one content scope.

Fields

NameDescription
scope
ContentScopeValue!

Content scope to which these settings apply.

libraryPath
String!

Primary library path.

rootFolders
[RootFolderPayload!]!

Configured root folders.

requiredAudioLanguages
[String!]!

Effective configured requirements; original remains unchanged.

useSeasonFolders
Boolean!

Whether episodic titles use season folders.

folderTemplate
String!

Folder naming template.

seasonFolderTemplate
String

Season-folder template, or null for facets without seasons.

specialsFolderTemplate
String

Specials-folder template, or null when not configured.

renameEnabled
Boolean!

Whether automatic renaming is enabled.

renameTemplate
String!

Rename filename template.

renameCollisionPolicy
RenameCollisionPolicyValue!

Collision policy for renames.

renameMissingMetadataPolicy
RenameMissingMetadataPolicyValue!

Missing-metadata policy for renames.

fillerPolicy
FillerPolicyValue

Effective filler policy, or null when unset.

recapPolicy
RecapPolicyValue

Effective recap policy, or null when unset.

monitorSpecials
Boolean

Whether specials are monitored, or null when unset.

interSeasonMovies
Boolean

Whether inter-season movies are monitored, or null when unset.

monitorFillerMovies
Boolean

Whether filler movies are monitored, or null when unset.

nfoWriteOnImport
Boolean!

Whether NFO files are written on import.

plexmatchWriteOnImport
Boolean

Whether Plex match files are written on import, or null when unset.

importMode
ImportModeValue!

Import mode applied to this scope.

setPermissionsLinux
Boolean!

Whether Linux permissions are updated after import.

fileChmod
String

File chmod mode, or null when unset.

folderChmod
String

Folder chmod mode, or null when unset.

chownGroup
String

Chown group, or null when unset.

One detected stream, including supplementary streams excluded from scoring.

Fields

NameDescription
kind
MediaStreamKindValue!

Video, audio, or subtitle stream kind.

codec
String

Normalized codec name.

width
Int

Video width in pixels.

height
Int

Video height in pixels.

channels
Int

Number of audio channels; this does not imply a speaker layout.

language
String

Normalized language tag, when known.

inferredLanguage
String

Language inferred from the track name when an audio stream has no language field in the container; null when the stream is tagged or nothing can be inferred.

name
String

Name supplied by the container metadata.

metadata
MediaStreamMetadataPayload!

Precise stream properties and evidence.

Declared stream roles; null means the role is unknown.

Fields

NameDescription
default
Boolean

Whether the container marks this stream as the default.

forced
Boolean

Whether the container marks this stream as forced.

original
Boolean

Whether the container marks this as the original track.

commentary
Boolean

Whether this track is explicitly marked as commentary.

hearingImpaired
Boolean

Whether this track is marked for viewers with hearing impairments.

visualImpaired
Boolean

Whether this track is marked as audio description.

attachedPicture
Boolean

Whether this stream is an attached cover picture.

stillImage
Boolean

Whether this stream is explicitly marked as a still image.

Precise properties of one stream; missing values remain unknown.

Fields

NameDescription
id
String

Identifier within the source metadata.

programId
Int

Program containing this stream, when known.

originalLanguage
String

Original container language tag before normalization.

languageProvenance
MediaProvenanceValue!

Evidence source for the language tag.

disposition
MediaStreamDispositionPayload!

Declared stream roles and accessibility flags.

durationSeconds
Float

Playback duration in seconds, when established.

bitrateBps
Long

Declared or completely accounted stream bitrate in bits per second.

bitrateProvenance
MediaProvenanceValue!

Evidence source for the stream bitrate.

estimatedBitrateBps
Long

Bounded stream bitrate estimate in bits per second, separate from measured bitrate.

sampleRate
Int

Audio sample rate in samples per second.

sampleFormat
String

Encoded sample representation, when known; no decoder output format is inferred.

sampleBitDepth
Int

Encoded audio sample precision in bits.

channelLayout
String

Declared speaker layout; unknown layouts remain null.

pixelFormat
String

Video pixel sampling and component representation.

profile
String

Codec profile reported for this stream.

level
Int

Codec-specific level identifier.

bitDepth
Int

Video component precision in bits.

fieldOrder
String

Declared or observed field order.

sampleAspectRatio
MediaRationalPayload

Pixel width-to-height ratio.

displayAspectRatio
MediaRationalPayload

Displayed image width-to-height ratio.

rotationDegrees
Float

Display rotation in degrees.

declaredFrameRate
MediaRationalPayload

Container or bitstream frame-rate declaration in frames per second.

observedFrameRate
MediaRationalPayload

Rational frame rate from bounded timestamp observations.

variableFrameRate
Boolean

Whether bounded timing observations establish variable frame rate; null is inconclusive.

color
MediaColorMetadataPayload!

Color signaling and static HDR metadata.

hdr
MediaHdrCapabilitiesPayload!

Independent HDR capability evidence.

Opt-in packet and frame-header sampling without decoding media.

Fields

NameDescription
report
MediaProbeReportPayload!

Inspection status, coverage counters, and warnings.

sourceLength
Long!

Length of the complete physical source in bytes.

coverage
[MediaDiagnosticCoveragePayload!]!

Recorded byte ranges read during diagnostics.

coverageTruncated
Boolean!

Whether the bounded coverage inventory omitted additional ranges.

warningsTruncated
Boolean!

Whether additional diagnostic warnings exceeded the inventory limit.

packetsSampled
Long!

Number of packet headers inspected.

frameHeadersSampled
Long!

Number of elementary frame headers inspected.

checks
[String!]!

Names of structural checks performed.

Metadata gateway companion-movie record for an anime series.

Fields

NameDescription
name
String!

Movie name.

year
Int

Release year, or null when unavailable.

associationConfidence
String!

How confidently the provider associates the movie with the series.

continuityStatus
String!

Whether the movie is canon to the series.

placement
String!

Where the movie sits relative to the series seasons.

externalIds
[ExternalIdPayload!]!

Provider identifiers for the movie.

Metadata gateway episode record.

Fields

NameDescription
tvdbId
String!

TVDB episode ID.

episodeNumber
Int!

Episode number within the season.

seasonNumber
Int!

Numeric season containing this episode.

name
String!

Episode title.

aired
Date!

Original air date.

runtimeMinutes
Int!

Runtime in minutes.

isFiller
Boolean!

Whether the episode is marked filler.

imageUrl
String!

Episode image URL.

Full metadata gateway movie record.

Fields

NameDescription
tvdbId
String!

TVDB movie ID.

smgId
Int

SMG canonical movie title ID, or null when unavailable.

tmdbId
Int

TMDB movie ID, or null when unavailable.

name
String!

Movie title.

slug
String!

Provider slug.

year
Int

Release year, or null when unavailable.

status
String!

Provider status.

overview
String!

Overview text.

posterUrl
String!

Metadata-provider URL for the poster image.

language
String!

Metadata language code.

runtimeMinutes
Int!

Runtime in minutes.

sortTitle
String!

Normalized sort title.

imdbId
String!

IMDb title identifier.

studio
String!

Studio name.

tmdbReleaseDate
Date

TMDB release date, or null when unavailable.

Search result from the metadata gateway with nullable provider metadata.

Fields

NameDescription
tvdbId
String!

TVDB provider ID.

smgId
Int

SMG canonical title ID, or null for legacy-only results.

tmdbId
Int

TMDB provider ID, or null when unavailable.

primarySource
String

Primary metadata-provider source, or null for legacy-only results.

externalIds
[ExternalIdPayload!]!

Every external identity supplied by the metadata provider.

name
String!

Metadata title.

imdbId
String

IMDb ID, or null when unavailable.

slug
String

Provider slug, or null when unavailable.

type
String

Provider content-type hint, or null when unavailable.

year
Int

Release year, or null when unavailable.

status
String

Provider status, or null when unavailable.

overview
String

Overview text, or null when unavailable.

popularity
Float

Popularity score, or null when unavailable.

posterUrl
String

Poster URL, or null when unavailable.

language
String

Metadata language, or null when unavailable.

runtimeMinutes
Int

Runtime in minutes, or null when unavailable.

sortTitle
String

Normalized sort title, or null when unavailable.

existingTitleId
ID

Id of the title that already carries this identity in the pending import's library and facet, or null. Only the pending-import title search populates it; every other metadata-search surface returns null.

Metadata search results grouped by content facet.

Fields

NameDescription
movies
[MetadataSearchItemPayload!]!

Movie results; empty when no movies matched.

series
[MetadataSearchItemPayload!]!

Series results; empty when no series matched.

anime
[MetadataSearchItemPayload!]!

Anime results; empty when no anime matched.

Metadata gateway season record.

Fields

NameDescription
tvdbId
String!

TVDB season ID.

number
Int!

Numeric season number assigned by the metadata provider.

label
String!

Season label.

episodeType
String!

Episode classification.

Full metadata gateway series record with seasons and optional episodes.

Fields

NameDescription
tvdbId
String!

TVDB series ID.

name
String!

Series title.

sortName
String!

Normalized sort name.

slug
String!

Provider slug.

year
Int

First release year, or null when unavailable.

status
String!

Provider status.

firstAired
Date!

First-air date.

overview
String!

Overview text.

network
String!

Network name.

runtimeMinutes
Int!

Runtime in minutes.

posterUrl
String!

Metadata-provider URL for the poster image.

country
String!

Country code.

aliases
[String!]!

Alternate titles.

seasons
[MetadataSeasonPayload!]!

Season metadata.

episodes
[MetadataEpisodePayload!]!

Episode metadata; empty when not requested or unavailable.

animeMovies
[MetadataAnimeMoviePayload!]!

Companion movies reported for an anime series; empty for other series.

One canon series movie inside an advanced monitoring selection.

Fields

NameDescription
name
String!

Movie name as it was presented when the selection was made.

externalIds
[ExternalIdPayload!]!

Provider identifiers for the selected movie.

Seasons and canon series movies chosen under the ADVANCED monitor type. Anything absent from the selection stays unmonitored.

Fields

NameDescription
seasonNumbers
[Int!]!

Season numbers to monitor; 0 is specials.

seriesMovies
[MonitorSelectionMoviePayload!]!

Canon series movies to monitor.

Persisted movie metadata.

Fields

NameDescription
id
ID!

Stable movie identifier.

title
String!

Movie title.

slug
String

URL-friendly movie key, or null when unavailable.

year
Int

Release year, or null when unknown.

overview
String

Plot or synopsis text, or null before metadata provides it.

posterUrl
String

Poster URL, or null when no poster source is available.

runtimeMinutes
Int

Runtime in minutes, or null when unknown.

contentStatus
String

Catalog content status, or null when unavailable.

imdbId
String

IMDb identifier, or null when unmatched.

tvdbId
String

TVDB identifier, or null when unmatched.

tmdbId
String

TMDB identifier, or null when unmatched.

malId
String

MyAnimeList identifier, or null when unmatched.

anidbId
String

AniDB identifier, or null when unmatched.

ratings
TitleRatingPayload!

Aggregated ratings cached during the movie's latest metadata hydration.

credits
[TitleCreditPayload!]!

Cast and crew cached during the movie's latest metadata hydration.

Fields

NameDescription
startApplicationUpgrade
ApplicationUpgradeStartPayload!

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

Arguments

NameDescription
input
StartApplicationUpgradeInput!

The update tag and version currently advertised by SMG.

addTitle
AddTitleResult!

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

Arguments

NameDescription
input
AddTitleInput!

Title metadata, library selection, and optional tri-state title settings.

addTitleAndQueueDownload
AddTitleResult!

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

Arguments

NameDescription
input
AddTitleInput!

Title metadata, library selection, title settings, and optional source release details.

updateTitle
TitlePayload!

Patch title metadata and settings while preserving omitted fields.

Arguments

NameDescription
input
UpdateTitleInput!

Title identity and optional metadata or tri-state settings changes.

updateTitleTags
[TitlePayload!]!

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

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

Arguments

NameDescription
input
UpdateTitleTagsInput!

Titles to patch and the tag labels to add and remove.

setPrimaryMovieFile
TitlePayload!

Set the primary media file for a movie title.

Arguments

NameDescription
input
SetPrimaryMovieFileInput!

Movie title identity and media-file identity to make primary.

applyTitleFolderChange
ChangeTitleFolderPayload!

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

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

Arguments

NameDescription
input
ApplyTitleFolderChangeInput!

Title, chosen folder inside its library roots, and how to settle ownership.

fixTitleMatch
FixTitleMatchPayload!

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

Arguments

NameDescription
input
FixTitleMatchInput!

Title identity and metadata identity used for the rematch.

deleteTitle
DeleteTitlePayload!

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

Arguments

NameDescription
input
DeleteTitleInput!

Title identity, disk-deletion choice, and optional preview fingerprint and typed confirmation.

deleteTitles
DeleteTitlesPayload!

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

Arguments

NameDescription
input
DeleteTitlesInput!

Title deletion items, optional disk-deletion choice, and typed confirmation.

clearTitleReleaseBlocklistEntry
ClearTitleReleaseBlocklistEntryPayload!

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

Arguments

NameDescription
id
ID!

Title release blocklist entry identity to clear.

setTitleMonitored
TitlePayload!

Replace a title's monitored state.

Arguments

NameDescription
input
SetTitleMonitoredInput!

Title identity and desired monitored state.

setCollectionMonitored
SetCollectionMonitoredPayload!

Set collection monitoring and return the affected collection episodes.

Arguments

NameDescription
input
SetCollectionMonitoredInput!

Collection identity and desired monitored state.

setEpisodeMonitored
EpisodePayload!

Set episode monitoring and return the updated episode.

Arguments

NameDescription
input
SetEpisodeMonitoredInput!

Episode identity and desired monitored state.

setSeriesMovieMonitored
SeriesMovieLinkPayload!

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

Arguments

NameDescription
input
SetSeriesMovieMonitoredInput!

Series-movie link identity and desired monitored state.

updateSeriesMovieTags
[SeriesMovieLinkPayload!]!

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

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

Arguments

NameDescription
input
UpdateSeriesMovieTagsInput!

Series movies to patch plus the labels to add and remove.

queueExistingTitleDownload
QueueDownloadPayload!

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

Arguments

NameDescription
input
QueueDownloadInput!

Signed candidate token and submission options; the token supplies the release identity.

queueReplacementRelease
QueueDownloadPayload!

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

Arguments

NameDescription
input
QueueDownloadInput!

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

queueBestRelease
QueueDownloadPayload!

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

Arguments

NameDescription
input
QueueBestReleaseInput!

Title, scope, and optional replacement policy for the best-release submission.

queueManualImport
DownloadQueueActionPayload!

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

Arguments

NameDescription
input
QueueManualImportInput!

Selection id and candidate mappings chosen from a prior manual-import preview.

beginManualImportSelection
ManualImportSelectionPayload!

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

Arguments

NameDescription
input
BeginManualImportSelectionInput!

Download client identity and title used to build the manual-import preview.

retryImport
ImportResultPayload!

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

Arguments

NameDescription
input
RetryImportInput!

Failed import identity and optional archive password used for the retry.

cancelActiveImport
Boolean!

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

Arguments

NameDescription
streamId
ID!

Opaque identity of the queued or active import stream.

ignoreTrackedDownload
DownloadQueueActionPayload!

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

Arguments

NameDescription
input
IgnoreTrackedDownloadInput!

Download client identity used to locate the tracked item.

markTrackedDownloadFailed
DownloadQueueActionPayload!

Mark a tracked download failed and optionally suppress automatic reacquisition.

Arguments

NameDescription
input
MarkTrackedDownloadFailedInput!

Download client identity and the failure handling option.

assignTrackedDownloadTitle
DownloadQueueActionPayload!

Attach a tracked download to a title and acquisition scope.

Arguments

NameDescription
input
AssignTrackedDownloadTitleInput!

Download client identity, title identity, and target scope.

pauseDownload
DownloadQueueActionPayload!

Pause a tracked download through its configured download client.

Arguments

NameDescription
input
PauseDownloadInput!

Download client item identity to pause.

resumeDownload
DownloadQueueActionPayload!

Resume a paused tracked download through its configured download client.

Arguments

NameDescription
input
ResumeDownloadInput!

Download client item identity to resume.

deleteDownload
DownloadQueueActionPayload!

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

Arguments

NameDescription
input
DeleteDownloadInput!

Download client identity and whether the item should be treated as history.

triggerJob
JobRunPayload!

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

Arguments

NameDescription
jobKey
JobKeyValue!

Job key identifying the server-side job to start.

createIndexerConfig
IndexerConfigPayload!

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

Arguments

NameDescription
input
CreateIndexerConfigInput!

Indexer provider configuration, optional proxy and download-client identities, and search defaults.

updateIndexerConfig
IndexerConfigPayload!

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

Arguments

NameDescription
input
UpdateIndexerConfigInput!

Indexer configuration identity and optional replacement fields; omitted provider secrets remain stored.

setIndexerDownloadClientMapping
IndexerConfigPayload!

Set or clear the download client associated with an indexer.

Arguments

NameDescription
input
SetIndexerDownloadClientMappingInput!

Indexer identity and optional download-client identity; null clears the mapping.

setIndexerSeedingProfile
IndexerConfigPayload!

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

Arguments

NameDescription
input
SetIndexerSeedingProfileInput!

Indexer identity and optional seeding profile identity; null clears the assignment.

createSeedingProfile
SeedingProfilePayload!

Create a torrent seeding profile.

Arguments

NameDescription
input
CreateSeedingProfileInput!

Seeding profile name, goals, and removal behavior.

updateSeedingProfile
SeedingProfilePayload!

Patch a torrent seeding profile.

Arguments

NameDescription
input
UpdateSeedingProfileInput!

Seeding profile identity and optional replacement fields; explicit nulls clear goals.

deleteSeedingProfile
DeleteSeedingProfilePayload!

Delete a seeding profile that nothing references.

Arguments

NameDescription
id
ID!

Seeding profile identity to delete.

setDefaultSeedingProfile
DefaultSeedingProfilePayload!

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

Arguments

NameDescription
input
SetDefaultSeedingProfileInput!

Seeding profile identity to use as the default, or null to clear it.

setMinimumSeedersFloor
DefaultSeedingProfilePayload!

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

Arguments

NameDescription
input
SetMinimumSeedersFloorInput!

Fewest seeders a torrent candidate may report when no seeding profile resolves; 0 disables the check.

createProxyConfig
ProxyConfigPayload!

Create a proxy configuration.

Arguments

NameDescription
input
CreateProxyConfigInput!

Proxy provider, base URL, timeout, and enabled state.

updateProxyConfig
ProxyConfigPayload!

Patch a proxy configuration while preserving omitted fields.

Arguments

NameDescription
input
UpdateProxyConfigInput!

Proxy configuration identity and optional replacement fields.

deleteProxyConfig
DeleteProxyConfigPayload!

Delete a proxy configuration.

Arguments

NameDescription
id
ID!

Proxy configuration identity to delete.

testProxyConfig
ProxyTestResultPayload!

Test a proxy connection and return provider validation details.

Arguments

NameDescription
id
ID!

Proxy configuration identity to test.

url
String

HTTP(S) URL to fetch through this proxy or solver. Omit for the existing health check.

resetProxyHostKey
ProxyConfigPayload!

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

Arguments

NameDescription
id
ID!

Tunnel proxy configuration identity whose pinned host key to forget.

deleteIndexerConfig
DeleteIndexerConfigPayload!

Delete an indexer configuration.

Arguments

NameDescription
id
ID!

Indexer configuration identity to delete.

createDownloadClientConfig
DownloadClientConfigPayload!

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

Arguments

NameDescription
input
CreateDownloadClientConfigInput!

Download-client provider, configuration values, and enabled state.

updateDownloadClientConfig
DownloadClientConfigPayload!

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

Arguments

NameDescription
input
UpdateDownloadClientConfigInput!

Download-client identity and optional replacement fields; omitted provider secrets remain stored.

deleteDownloadClientConfig
DeleteDownloadClientConfigPayload!

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

Arguments

NameDescription
id
ID!

Download-client configuration identity to delete.

reorderDownloadClientConfigs
ReorderDownloadClientConfigsPayload!

Persist the ordering of download-client configurations.

Arguments

NameDescription
input
ReorderDownloadClientConfigsInput!

Download-client identities in their desired order.

testDownloadClientConnection
ProviderValidationPayload!

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

Arguments

NameDescription
input
TestDownloadClientConnectionInput!

Optional stored client identity, provider type, and connection values to test.

createSubtitleProviderConfig
SubtitleProviderConfigPayload!

Create a subtitle-provider configuration.

Arguments

NameDescription
input
CreateSubtitleProviderConfigInput!

Subtitle provider, configuration values, enabled facets, and enabled state.

updateSubtitleProviderConfig
SubtitleProviderConfigPayload!

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

Arguments

NameDescription
input
UpdateSubtitleProviderConfigInput!

Subtitle-provider identity and optional replacement fields; omitted secrets remain stored.

deleteSubtitleProviderConfig
DeleteSubtitleProviderConfigPayload!

Delete a subtitle-provider configuration.

Arguments

NameDescription
id
ID!

Subtitle-provider configuration identity to delete.

testSubtitleProviderConnection
ProviderValidationPayload!

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

Arguments

NameDescription
input
TestSubtitleProviderConnectionInput!

Optional stored provider identity, provider type, and connection values to test.

testIndexerConnection
ProviderValidationPayload!

Test an indexer connection and return provider validation details.

Arguments

NameDescription
input
TestIndexerConnectionInput!

Provider type, optional values, optional indexer identity, and tri-state proxy identity.

syncIndexerConfig
IndexerConfigSyncPayload!

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

Arguments

NameDescription
id
ID!

Indexer configuration identity to synchronize.

triggerRssSync
RssSyncReportPayload!

Run RSS synchronization for accessible indexers and return its report.

setMyUiSettings
UiSettingsPayload!

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

Arguments

NameDescription
input
SetMyUiSettingsInput!

Complete UI settings to save; omitted or null date_time_format keeps its current value.

updateSubtitleSettings
SubtitleSettingsPayload!

Saves subtitle preferences after checking the catalog-settings permission.

Arguments

NameDescription
input
UpdateSubtitleSettingsInput!

Subtitle settings to validate and save; language flags default to false when omitted.

updateAcquisitionSettings
AcquisitionSettingsPayload!

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

Arguments

NameDescription
input
UpdateAcquisitionSettingsInput!

Acquisition settings with hour, second, day, count, and score values validated by the application.

updateGeneralSettings
GeneralSettingsPayload!

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

Arguments

NameDescription
input
UpdateGeneralSettingsInput!

General settings including history retention, image-cache size in MB, and plugin CA bundle text.

clearTitleImageCache
ClearTitleImageCachePayload!

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

updateRecycleBinSettings
RecycleBinSettingsPayload!

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

Arguments

NameDescription
input
UpdateRecycleBinSettingsInput!

Recycle-bin settings to save.

updateVerificationSettings
VerificationSettingsPayload!

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

Arguments

NameDescription
input
UpdateVerificationSettingsInput!

Verification depth to save.

updatePluginAutoUpdateSettings
PluginAutoUpdateSettingsPayload!

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

Arguments

NameDescription
input
UpdatePluginAutoUpdateSettingsInput!

Whether the scheduled plugin catalog refresh installs official patch updates automatically.

updateAutoBackupSettings
AutoBackupSettingsPayload!

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

Arguments

NameDescription
input
UpdateAutoBackupSettingsInput!

Auto-backup settings; key fields change or clear the stored secret according to their flags.

updateBackupSettings
BackupSettingsPayload!

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

Arguments

NameDescription
input
UpdateBackupSettingsInput!

Backup path settings to save.

acknowledgeAutoBackupDisabledMissingKeyNotice
AutoBackupSettingsPayload!

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

updateSecuritySettings
SecuritySettingsPayload!

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

Arguments

NameDescription
input
UpdateSecuritySettingsInput!

Security settings with password length and MFA requirements validated by the application.

createOauthClientRegistration
OauthClientRegistrationPayload!

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

Arguments

NameDescription
input
CreateOAuthClientRegistrationInput!

Display name and exact HTTPS callback allowlist for the application.

updateOauthClientRegistration
OauthClientRegistrationPayload!

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

Arguments

NameDescription
clientId
String!

Immutable client identifier returned during registration.

input
UpdateOAuthClientRegistrationInput!

Replacement public-client configuration.

deleteOauthClientRegistration
DeleteOAuthClientRegistrationPayload!

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

Arguments

NameDescription
clientId
String!

Immutable client identifier returned during registration.

createMediaServerConnection
MediaServerConnectionPayload!

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

Arguments

NameDescription
input
CreateMediaServerConnectionInput!

Connection details and optional credentials; omitted enabled defaults true while login and linking default false.

updateMediaServerConnection
MediaServerConnectionPayload!

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

Arguments

NameDescription
input
UpdateMediaServerConnectionInput!

Connection ID and optional patch fields; omitted fields remain unchanged and clear flags remove stored secrets.

deleteMediaServerConnection
DeleteMediaServerConnectionPayload!

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

Arguments

NameDescription
id
ID!

ID of the media-server connection to delete.

testMediaServerConnection
ProviderValidationPayload!

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

Arguments

NameDescription
input
TestMediaServerConnectionInput!

Connection ID and optional Plex token used only for this validation request.

discoverPlexMediaServers
[PlexServerDiscoveryPayload!]!

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

Arguments

NameDescription
plexAuthToken
String!

Plex authentication token used for discovery and not returned by this field.

discoverEmbyConnectServers
[EmbyConnectServerPayload!]!

Discovers Emby Connect servers using credentials without saving a connection.

Arguments

NameDescription
input
DiscoverEmbyConnectServersInput!

Emby Connect credentials used only for discovery.

testEmbyConnect
MediaServerConnectionTestPayload!

Validates an Emby Connect configuration without changing saved settings.

Arguments

NameDescription
input
TestEmbyConnectInput!

Connection ID and Emby Connect credentials used only for this validation request.

upsertDelayProfile
DelayProfilePayload!

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

Arguments

NameDescription
input
DelayProfileInput!

Delay profile; delay and age values are expressed in minutes and the ID selects create versus update.

deleteDelayProfile
DelayProfileDeletionPayload!

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

Arguments

NameDescription
id
ID!

ID of the delay profile to delete.

createTitleTagDefinition
TitleTagDefinitionMutationPayload!

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

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

Arguments

NameDescription
input
CreateTitleTagDefinitionInput!

Label to define and an optional note; the label is normalized before it is stored.

updateTitleTagDefinition
TitleTagDefinitionMutationPayload!

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

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

Arguments

NameDescription
input
UpdateTitleTagDefinitionInput!

Tag identity plus the replacement label or description; omitted fields keep their current values.

deleteTitleTagDefinition
TitleTagDefinitionDeletionPayload!

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

Arguments

NameDescription
id
ID!

ID of the title tag to delete.

updateMediaSettings
MediaSettingsPayload!

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

Arguments

NameDescription
input
UpdateMediaSettingsInput!

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

updateLibraryPaths
LibraryPathsPayload!

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

Arguments

NameDescription
input
UpdateLibraryPathsInput!

Default facet root paths; blank movie or series values and a null or blank anime value leave that facet unchanged.

updateServiceSettings
ServiceSettingsPayload!

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

Arguments

NameDescription
input
UpdateServiceSettingsInput!

TLS certificate and key paths to save.

saveQualityProfileSettings
QualityProfileSettingsPayload!

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

Arguments

NameDescription
input
SaveQualityProfileSettingsInput!

Quality profiles and selections; replace_existing controls replacement while profile IDs match existing records.

updateDownloadClientRouting
[DownloadClientRoutingEntryPayload!]!

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

Arguments

NameDescription
input
UpdateDownloadClientRoutingInput!

Content scope and complete routing entry list; an empty list clears entries for that scope.

updateIndexerRouting
[IndexerRoutingEntryPayload!]!

Replaces indexer routing entries for one content scope after authorization.

Arguments

NameDescription
input
UpdateIndexerRoutingInput!

Content scope and complete routing entry list; an empty list clears entries for that scope.

deleteQualityProfile
QualityProfileSettingsPayload!

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

Arguments

NameDescription
id
ID!

ID of the quality profile to delete.

webauthnRegisterStart
WebauthnChallengePayload!

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

webauthnRegisterComplete
PasskeySummaryPayload!

Completes passkey registration using the authorized enrollment challenge.

Arguments

NameDescription
input
WebauthnRegisterCompleteInput!

Challenge ID and WebAuthn response used to complete the pending registration.

webauthnLoginEnrollmentStart
WebauthnChallengePayload!

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

webauthnLoginEnrollmentComplete
LoginPasskeyEnrollmentCompletePayload!

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

Arguments

NameDescription
input
WebauthnRegisterCompleteInput!

Passkey registration challenge and browser response for login enrollment.

totpEnrollmentStart
TotpEnrollmentStartPayload!

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

totpEnrollmentComplete
TotpEnrollmentCompletePayload!

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

Arguments

NameDescription
input
TotpEnrollmentCompleteInput!

Enrollment challenge ID and current TOTP code.

completeLoginMfaEnrollment
LoginMfaEnrollmentCompletePayload!

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

Arguments

NameDescription
input
TotpEnrollmentCompleteInput!

MFA-enrollment challenge ID and current TOTP code.

mfaVerifyStepUp
LoginPayload!

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

Arguments

NameDescription
input
TotpVerifyInput!

Current TOTP code used for step-up verification.

accountSecurityPasswordVerify
LoginPayload!

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

Arguments

NameDescription
currentPassword
String!

Current local password used to reauthenticate this interactive session.

accountSecurityPasskeyStart
WebauthnChallengePayload!

Starts a passkey assertion that reauthenticates the current interactive session.

accountSecurityPasskeyComplete
LoginPayload!

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

Arguments

NameDescription
input
WebauthnCompleteInput!

Passkey assertion response for the current account-security challenge.

totpDisable
TotpStatusPayload!

Disables TOTP after verifying the current TOTP code.

Arguments

NameDescription
input
TotpVerifyInput!

Current TOTP code required to disable TOTP.

totpRegenerateRecoveryCodes
TotpEnrollmentCompletePayload!

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

Arguments

NameDescription
input
TotpVerifyInput!

Current TOTP code required to generate a new recovery-code set.

webauthnAuthenticateStart
WebauthnChallengePayload!

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

Arguments

NameDescription
username
String

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

webauthnAuthenticateComplete
LoginPayload!

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

Arguments

NameDescription
input
WebauthnCompleteInput!

Challenge ID and WebAuthn assertion response from the authentication start request.

loginVerificationPasskeyStart
WebauthnChallengePayload!

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

Arguments

NameDescription
challengeId
ID!

Opaque login verification challenge ID returned after primary authentication.

loginVerificationPasskeyComplete
LoginPayload!

Completes the passkey assertion required after primary credentials succeed.

Arguments

NameDescription
input
LoginVerificationPasskeyCompleteInput!

Pending login verification and browser assertion response.

loginVerificationTotpComplete
LoginPayload!

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

Arguments

NameDescription
input
LoginVerificationTotpCompleteInput!

Pending login verification challenge and current authenticator or recovery code.

deleteMyPasskey
DeleteMyPasskeyPayload!

Deletes the authenticated actor's passkey identified by id.

Arguments

NameDescription
id
ID!

ID of the authenticated actor's passkey to delete.

revokeMyOauthApp
RevokeMyOauthAppPayload!

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

Arguments

NameDescription
grantId
ID!

Grant ID of the OAuth app authorization to revoke.

createMyApiKey
CreateMyApiKeyPayload!

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

Arguments

NameDescription
input
CreateMyApiKeyInput!

Label and expiration policy for the new API key.

revokeMyApiKey
RevokeMyApiKeyPayload!

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

Arguments

NameDescription
id
ID!

API-key record ID to revoke.

login
LoginPayload!

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

Arguments

NameDescription
input
LoginInput!

Username, password, and optional TOTP code for local authentication.

completeRequiredPasswordChange
LoginPayload!

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

Arguments

NameDescription
input
CompleteRequiredPasswordChangeInput!

New password selected by the authenticated user.

completeSetup
CompleteSetupPayload!

Mark the setup wizard as complete.

createUser
UserPayload!

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

Arguments

NameDescription
input
CreateUserInput!

Username, password, and initial app and library permissions for the new user.

setUserPassword
UserPayload!

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

Arguments

NameDescription
input
SetUserPasswordInput!

Target user ID, new password, and optional current password for a self-service change.

setUserAppPermissions
UserPayload!

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

Arguments

NameDescription
input
SetUserAppPermissionsInput!

Target user ID and complete app-permission set; an empty set removes app permissions.

setUserLibraryPermissions
UserPayload!

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

Arguments

NameDescription
input
SetUserLibraryPermissionsInput!

Target user ID and complete library-grant set; an empty set removes library grants.

setUserLoginEnabled
UserPayload!

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

Arguments

NameDescription
input
SetUserLoginEnabledInput!

Target user ID and desired login-enabled state.

deleteUser
DeleteUserPayload!

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

Arguments

NameDescription
id
ID!

ID of the user to delete.

resetUserMfa
UserPayload!

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

Arguments

NameDescription
id
ID!

ID of the user whose authentication factors should be reset.

createExternalAccountInvite
LinkedAccountPayload!

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

Arguments

NameDescription
input
CreateExternalAccountInviteInput!

Target user, media-server connection, provider, and provider account identifiers for the invite.

linkPlexAccount
LinkedAccountPayload!

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

Arguments

NameDescription
input
LinkPlexAccountInput!

Plex connection ID and authentication token used for linking.

linkJellyfinAccount
LinkedAccountPayload!

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

Arguments

NameDescription
input
LinkJellyfinAccountInput!

Jellyfin connection ID, username, and password used for linking.

linkCurrentOAuthJellyfinAccount
LinkedAccountPayload!

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

Arguments

NameDescription
jellyfinUserId
String!

Canonical Jellyfin user GUID reported by the Jellyfin client.

linkEmbyAccount
LinkedAccountPayload!

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

Arguments

NameDescription
input
LinkEmbyAccountInput!

Emby connection ID, local or Connect mode, and credentials used for linking.

unlinkExternalAccount
UnlinkExternalAccountPayload!

Unlinks the external account identified by linked_account_id.

Arguments

NameDescription
linkedAccountId
ID!

ID of the linked external account to remove.

loginWithPlex
LoginPayload!

Authenticates through Plex and issues a session token.

Arguments

NameDescription
input
LoginWithPlexInput!

Plex connection ID, authentication token, and optional session-persistence preference.

loginWithJellyfin
LoginPayload!

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

Arguments

NameDescription
input
LoginWithJellyfinInput!

Jellyfin connection ID, credentials, optional TOTP code, and optional session-persistence preference.

loginWithEmby
LoginPayload!

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

Arguments

NameDescription
input
LoginWithEmbyInput!

Emby connection ID, mode, credentials, optional TOTP code, and optional session-persistence preference.

createLibrary
LibraryPayload!

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

Arguments

NameDescription
input
CreateLibraryInput!

Library facet, name, root paths, and optional settings.

updateLibrary
LibraryPayload!

Patch a library while preserving omitted fields.

Arguments

NameDescription
input
UpdateLibraryInput!

Library identity and optional replacement name, roots, or settings.

deleteLibrary
DeleteLibraryPayload!

Delete the library configuration identified by the supplied ID.

Arguments

NameDescription
id
ID!

Library identity to delete.

scanLibrary
LibraryScanProgressPayload!

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

Arguments

NameDescription
input
ScanLibraryInput!

Library identity and optional completed import-warmup session for scan hints.

scanTitleLibrary
LibraryScanSummaryPayload!

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

Arguments

NameDescription
titleId
ID!

Title identity whose library paths should be scanned.

cancelLibraryScan
CancelLibraryScanPayload!

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

Arguments

NameDescription
sessionId
ID!

Library scan session identity to cancel.

resolvePendingImport
ResolvePendingImportPayload!

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

Arguments

NameDescription
input
ResolvePendingImportInput!

Pending-import identity and title metadata used to resolve it.

bindPendingImport
ResolvePendingImportPayload!

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

Arguments

NameDescription
input
BindPendingImportInput!

Pending-import identity, optional collection identity, and episode identities to bind.

ignorePendingImport
IgnorePendingImportPayload!

Mark a pending import ignored without importing its files.

Arguments

NameDescription
pendingImportId
ID!

Pending-import identity to ignore.

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

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

Arguments

NameDescription
input
MediaRenameApplyInput!

Facet, title identity, preview fingerprint, and optional idempotency key.

mediaFileDiscEpisodeTargets
[MediaDiscEpisodeTargetPayload!]!

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

Arguments

NameDescription
fileId
ID!

Registered physical media file ID.

mapMediaFileDiscEpisodes
TitleMediaFilePayload!

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

Arguments

NameDescription
fileId
ID!

Registered physical media file ID.

mappings
[MediaDiscEpisodeMappingInput!]!

Complete replacement set of authored-title-to-episode associations.

diagnoseMediaFile
MediaStructuralDiagnosticsPayload!

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

Arguments

NameDescription
fileId
ID!

Registered physical media file ID to inspect.

selectMediaFileDiscTitle
TitleMediaFilePayload!

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

Arguments

NameDescription
fileId
ID!

Registered physical media file ID.

discTitleId
String

Authored title ID; null restores automatic selection.

deleteMediaFile
DeleteMediaFilePayload!

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

Arguments

NameDescription
input
DeleteMediaFileInput!

Media-file identity, disk-deletion choice, and optional preview fingerprint and typed confirmation.

deleteEpisodeFiles
DeleteEpisodeFilesPayload!

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

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

Arguments

NameDescription
input
DeleteEpisodeFilesInput!

Title and episode identities, disk-deletion choice, and the aggregate preview fingerprint with optional typed confirmation.

renameTitles
RenameTitlesPayload!

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

Arguments

NameDescription
input
RenameTitlesInput!

Facet and titles whose files are renamed; the work runs in the background.

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

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

Arguments

NameDescription
input
MediaRenameBulkApplyInput!

Facet, preview fingerprint, and optional idempotency key.

rehydrateAllMetadata
RehydrateAllMetadataPayload!

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

Arguments

NameDescription
input
RehydrateAllMetadataInput!

Metadata language code used for rehydration.

startLocationOperation
StartLocationOperationPayload!

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

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

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

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

Arguments

NameDescription
input
StartLocationOperationInput!

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

cancelLocationOperation
CancelLocationOperationPayload!

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

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

Arguments

NameDescription
id
ID!

Location-operation identity to stop at its next title checkpoint.

abandonLocationOperation
AbandonLocationOperationPayload!

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

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

Arguments

NameDescription
id
ID!

Location-operation identity to mark failed and release.

resumeLocationOperation
ResumeLocationOperationPayload!

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

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

Arguments

NameDescription
id
ID!

Location-operation identity to resume from its checkpoints.

submitMediaRequest
SubmitMediaRequestPayload!

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

Arguments

NameDescription
input
SubmitMediaRequestInput!

Library, facet, title metadata, and optional quality and monitoring preferences.

approveMediaRequest
ApproveMediaRequestPayload!

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

Arguments

NameDescription
input
ApproveMediaRequestInput!

Request identity and optional quality and monitoring overrides.

dismissMediaRequest
MediaRequestActionPayload!

Dismiss a media request without creating a catalog title.

Arguments

NameDescription
requestId
ID!

Request identity to dismiss.

updateMyMediaRequest
MediaRequestPayload!

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

Arguments

NameDescription
input
UpdateMediaRequestInput!

Request identity and the replacement quality and monitoring preferences.

cancelMyMediaRequest
MediaRequestActionPayload!

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

Arguments

NameDescription
requestId
ID!

Request identity to cancel.

triggerTitleMismatchRecoverySearch
TriggerTitleMismatchRecoverySearchPayload!

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

Arguments

NameDescription
titleId
ID!

Title identity whose changed match scopes should be searched again.

pauseWantedItem
PauseWantedItemPayload!

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

Arguments

NameDescription
id
ID!

Wanted-state row id or convergence scope key to pause.

resumeWantedItem
ResumeWantedItemPayload!

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

Arguments

NameDescription
id
ID!

Wanted-state row id or convergence scope key to resume.

forceGrabPendingRelease
ForceGrabPendingReleasePayload!

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

Arguments

NameDescription
id
ID!

Pending-release identity to grab.

dismissPendingRelease
DismissPendingReleasePayload!

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

Arguments

NameDescription
id
ID!

Pending-release identity to dismiss.

triggerAcquisitionSearch
AcquisitionSearchJobPayload!

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

Arguments

NameDescription
input
TriggerAcquisitionSearchInput!

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

cancelAcquisitionSearch
CancelAcquisitionSearchPayload!

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

Arguments

NameDescription
id
ID!

Acquisition-search job identity to cancel.

createRuleSet
RuleSetPayload!

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

Arguments

NameDescription
input
CreateRuleSetInput!

Rule name, source, optional description and facet scope, priority, and enabled state.

updateRuleSet
RuleSetPayload!

Patch a rule set while preserving omitted fields.

Arguments

NameDescription
input
UpdateRuleSetInput!

Rule-set identity and optional replacement source, metadata, facet scope, priority, or managed tag filter.

deleteRuleSet
DeleteRuleSetPayload!

Delete a rule set.

Arguments

NameDescription
id
ID!

Rule-set identity to delete.

toggleRuleSet
RuleSetPayload!

Set whether a rule set is enabled.

Arguments

NameDescription
input
ToggleRuleSetInput!

Rule-set identity and desired enabled state.

setTitleRequiredAudio
SetTitleRequiredAudioPayload!

Replace required audio languages for one title and facet.

Arguments

NameDescription
input
SetTitleRequiredAudioInput!

Title identity, facet, and required audio-language codes.

validateRuleSet
RuleValidationResultPayload!

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

Arguments

NameDescription
input
ValidateRuleSetInput!

Rule source and optional rule-set identity used for validation.

testRuleSet
TestRuleSetPayload!

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

Arguments

NameDescription
input
TestRuleSetInput!

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

installTrackedRulePack
TrackedRulePackPayload!

Install the whole verified pack with selected templates enabled.

Arguments

NameDescription
packId
String!

Immutable registry rule-pack ID.

templateIds
[String!]!

Template IDs to enable. An empty list installs every rule disabled.

previewTrackedRulePackUpdate
TrackedRulePackPreviewPayload!

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

Arguments

NameDescription
packId
String!

Installed rule-pack ID to compare with the registry.

updateTrackedRulePack
TrackedRulePackPayload!

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

Arguments

NameDescription
packId
String!

Installed rule-pack ID to update.

version
String!

Reviewed immutable source version.

digest
String!

Verified digest for the reviewed source version.

revision
Long!

Revision returned by the update preview.

setTrackedRulePackSettings
TrackedRulePackPayload!

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

Arguments

NameDescription
packId
String!

Installed rule-pack ID.

enabledTemplateIds
[String!]!

Template IDs that should be enabled.

priorities
[TrackedRulePackPriorityInput!]!

Local priority for each template whose priority changes.

autoUpdate
Boolean!

Whether the scheduled registry refresh may update this pack.

expectedRevision
Long!

Current pack revision required for this mutation.

copyTrackedRulePackRule
RuleSetPayload!

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

Arguments

NameDescription
ruleSetId
ID!

Tracked local rule-set ID to copy.

name
String!

Name for the editable copy.

description
String!

Description for the editable copy.

regoSource
String!

Complete Rego source for the editable copy.

appliedFacets
[String!]!

Facet scope for the editable copy.

priority
Int!

Evaluation priority for the editable copy.

uninstallTrackedRulePack
DeleteTrackedRulePackPayload!

Uninstall a tracked rule pack and its owned rules.

Arguments

NameDescription
packId
String!

Installed rule-pack ID to remove.

revision
Long!

Current pack revision required for this mutation.

createMaintenanceRuleSet
MaintenanceRuleSetDetail!

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

Arguments

NameDescription
input
CreateMaintenanceRuleSetInput!

Rule name, matcher source, action, and optional description, grace period, and library scope.

updateMaintenanceRuleMatcher
MaintenanceRuleSetDetail!

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

Arguments

NameDescription
input
UpdateMaintenanceRuleMatcherInput!

Rule-set identity, replacement matcher source and action, and optional grace period.

updateMaintenanceRuleMetadata
MaintenanceRuleSet!

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

Arguments

NameDescription
input
UpdateMaintenanceRuleMetadataInput!

Rule-set identity, replacement name, and optional description and library scope.

deleteMaintenanceRuleSet
DeleteMaintenanceRuleSetPayload!

Delete a maintenance rule set and every revision it owns.

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

Arguments

NameDescription
id
ID!

Maintenance rule-set identity to delete.

validateMaintenanceRule
MaintenanceRuleValidationPayload!

Compile and check maintenance rule source without saving it.

Arguments

NameDescription
input
ValidateMaintenanceRuleInput!

Matcher source to validate.

previewMaintenanceRule
MaintenancePreviewPayload!

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

Arguments

NameDescription
input
PreviewMaintenanceRuleInput!

Either a stored rule set or an unsaved matcher, plus either the titles or the library to evaluate.

setMaintenanceRuleMode
MaintenanceRuleSet!

Move a maintenance rule set between evaluation modes.

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

Arguments

NameDescription
input
SetMaintenanceRuleModeInput!

Rule-set identity and the evaluation mode to store.

setMaintenanceRuleArming
MaintenanceRuleSet!

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

Arguments

NameDescription
input
SetMaintenanceRuleArmingInput!

Rule-set identity, the arming level, and the acknowledged candidate count for destructive arming.

runMaintenanceActionHandlerNow
MaintenanceEvaluationTriggerPayload!

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

setMaintenanceInstanceGates
MaintenanceInstanceGates!

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

Arguments

NameDescription
input
SetMaintenanceInstanceGatesInput!

The gates to change; omit a field to leave that gate alone.

excludeMaintenanceSubject
MaintenanceExclusion!

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

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

Arguments

NameDescription
input
ExcludeMaintenanceSubjectInput!

Subject to exclude, the optional rule to confine it to, and a reason.

removeMaintenanceExclusion
DeleteMaintenanceExclusionPayload!

Remove a maintenance exclusion.

Arguments

NameDescription
id
ID!

Exclusion identity to remove.

runMaintenanceEvaluationNow
MaintenanceEvaluationTriggerPayload!

Run maintenance evaluation now.

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

Arguments

NameDescription
ruleSetId
ID

Evaluate only this rule set; omit to evaluate every enabled rule.

createRequestRuleSet
RequestRuleSetDetail!

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

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

Arguments

NameDescription
input
CreateRequestRuleSetInput!

Rule name, matcher source, and optional description and library scope.

updateRequestRuleMatcher
RequestRuleSetDetail!

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

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

Arguments

NameDescription
input
UpdateRequestRuleMatcherInput!

Rule-set identity and the replacement matcher source.

updateRequestRuleMetadata
RequestRuleSet!

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

Arguments

NameDescription
input
UpdateRequestRuleMetadataInput!

Rule-set identity, replacement name, and optional description and library scope.

setRequestRuleMode
RequestRuleSetDetail!

Move a request rule set between evaluation modes.

Arguments

NameDescription
input
SetRequestRuleModeInput!

Rule-set identity and the evaluation mode to store.

deleteRequestRuleSet
DeleteRequestRuleSetPayload!

Delete a request rule set and every revision it owns.

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

Arguments

NameDescription
id
ID!

Request rule-set identity to delete.

validateRequestRule
RequestRuleValidationPayload!

Compile and check request rule source without saving it.

Arguments

NameDescription
input
ValidateRequestRuleInput!

Matcher source to validate.

previewRequestRule
RequestRulePreviewPayload!

Evaluate one matcher against one hypothetical request without saving anything.

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

Arguments

NameDescription
input
PreviewRequestRuleInput!

Either a stored rule set or an unsaved matcher, plus the sample request to evaluate it against.

setRequestRuleInstanceGates
RequestRuleInstanceGates!

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

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

Arguments

NameDescription
input
SetRequestRuleInstanceGatesInput!

The gate to change; omit the field to leave it alone.

extendTitleClaim
TitleClaim!

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

Arguments

NameDescription
input
ExtendTitleClaimInput!

Claim identity and its new expiry.

convertTitleClaimToPermanent
TitleClaim!

Replace a live claim with a permanent operator keep.

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

Arguments

NameDescription
input
ConvertTitleClaimToPermanentInput!

Claim identity to convert.

releaseTitleClaim
TitleClaim!

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

Arguments

NameDescription
input
ReleaseTitleClaimInput!

Claim identity and why it is being released.

refreshPluginCatalog
[RegistryPluginPayload!]!

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

beginInstallPlugin
PluginInstallProgressPayload!

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

Arguments

NameDescription
pluginId
ID!

Catalog plugin ID to install.

uninstallPlugin
UninstallPluginPayload!

Uninstall a plugin and remove its installation record.

Arguments

NameDescription
pluginId
ID!

Installed plugin ID to remove.

togglePlugin
PluginInstallationPayload!

Enable or disable an installed plugin.

Arguments

NameDescription
input
TogglePluginInput!

Installed plugin ID and desired enabled state.

beginUpgradePlugin
PluginInstallProgressPayload!

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

Arguments

NameDescription
pluginId
ID!

Installed plugin ID to upgrade.

inspectManualPluginRepo
ManualPluginPreviewPayload!

Inspect a GitHub plugin repository without installing its artifact.

Arguments

NameDescription
input
ManualPluginRepoInput!

GitHub repository URL containing the plugin manifest and artifact.

installManualPlugin
PluginInstallationPayload!

Install a plugin directly from an inspected GitHub repository.

Arguments

NameDescription
input
ManualPluginRepoInput!

GitHub repository URL containing the plugin manifest and artifact.

installUploadedPlugin
PluginInstallationPayload!

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

Arguments

NameDescription
input
ManualPluginUploadInput!

Plugin filename, base64-encoded WebAssembly bytes, and required risk acknowledgement.

createNotificationChannel
NotificationChannelPayload!

Create an enabled notification channel with provider configuration.

Arguments

NameDescription
input
CreateNotificationChannelInput!

Channel name, provider type, configuration values, optional media-server identity, and enabled state.

updateNotificationChannel
NotificationChannelPayload!

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

Arguments

NameDescription
input
UpdateNotificationChannelInput!

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

deleteNotificationChannel
DeleteNotificationChannelPayload!

Delete a notification channel.

Arguments

NameDescription
id
ID!

Notification-channel identity to delete.

testNotificationChannel
NotificationChannelTestPayload!

Test a notification channel and return the delivery result.

Arguments

NameDescription
id
ID!

Notification-channel identity to test.

createNotificationSubscription
NotificationSubscriptionPayload!

Create an enabled notification subscription for a target and event.

Arguments

NameDescription
input
CreateNotificationSubscriptionInput!

Optional channel and target identities, event type, scope, and enabled state.

updateNotificationSubscription
NotificationSubscriptionPayload!

Patch a notification subscription while preserving omitted fields.

Arguments

NameDescription
input
UpdateNotificationSubscriptionInput!

Subscription identity and optional target, event, scope, or enabled-state replacements.

deleteNotificationSubscription
DeleteNotificationSubscriptionPayload!

Delete a notification subscription.

Arguments

NameDescription
id
ID!

Notification-subscription identity to delete.

createBackup
BackupInfoPayload!

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

Arguments

NameDescription
input
CreateBackupInput!

Password used to encrypt the new backup bundle.

prepareBackupDownload
BackupDownloadUrlPayload!

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

Arguments

NameDescription
input
PrepareBackupDownloadInput!

Stored backup filename to authorize for download.

deleteBackup
DeleteBackupPayload!

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

Arguments

NameDescription
input
DeleteBackupInput!

Stored backup filename to delete.

inspectRestoreBundle
RestoreInspectPayload!

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

Arguments

NameDescription
bundleUpload
Upload!

Backup bundle supplied through GraphQL multipart upload.

password
String

Bundle password; null or blank selects an unencrypted bundle.

applyRestoreBundle
RestoreApplyPayload!

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

Arguments

NameDescription
uploadId
ID!

Temporary upload ID returned by inspectRestoreBundle.

password
String

Bundle password; null or blank selects an unencrypted bundle.

saveExternalImportSetupSecretDraft
SaveExternalImportSetupSecretDraftPayload!

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

Arguments

NameDescription
input
SaveExternalImportSetupSecretDraftInput!

Instance secrets and masked provider credentials keyed by their import deduplication keys.

clearExternalImportSetupSecretDraft
ClearExternalImportSetupSecretDraftPayload!

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

startExternalImportArrSourceWarmup
ExternalImportMonitorWarmupProgressPayload!

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

Arguments

NameDescription
input
StartExternalImportArrSourceWarmupInput!

Arr source kind and connection credentials used to identify the warmup session.

startExternalImportProwlarrWarmup
ExternalImportMonitorWarmupProgressPayload!

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

Arguments

NameDescription
input
StartExternalImportProwlarrWarmupInput!

Prowlarr connection credentials used to identify the warmup session.

cancelExternalImportArrSourceWarmup
CancelExternalImportMonitorWarmupPayload!

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

Arguments

NameDescription
sessionId
ID!

Warmup session identity to cancel.

validateExternalImportConnection
ExternalImportConnectionValidationPayload!

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

Arguments

NameDescription
input
ValidateExternalImportConnectionInput!

External application kind and connection credentials to validate.

previewExternalImport
ExternalImportPreviewPayload!

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

Arguments

NameDescription
input
PreviewExternalImportInput!

Completed or running warmup sessions and optional direct Prowlarr credentials.

finalizeExternalImport
FinalizeExternalImportPayload!

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

Arguments

NameDescription
input
FinalizeExternalImportInput!

Warmup sessions and validated library root mappings to reconcile into the catalog.

executeExternalImport
ExternalImportResultPayload!

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

Arguments

NameDescription
input
ExecuteExternalImportInput!

Selected imported clients and indexers plus any credentials needed to create them.

createPostProcessingScript
PostProcessingScriptPayload!

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

Arguments

NameDescription
input
CreatePostProcessingScriptInput!

Script definition, execution settings, and required acknowledgement for inline shell code.

updatePostProcessingScript
PostProcessingScriptPayload!

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

Arguments

NameDescription
input
UpdatePostProcessingScriptInput!

Script identity and optional fields to replace; omitted fields retain their values.

deletePostProcessingScript
DeletePostProcessingScriptPayload!

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

Arguments

NameDescription
id
ID!

Script identity to delete.

togglePostProcessingScript
PostProcessingScriptPayload!

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

Arguments

NameDescription
id
ID!

Script identity to toggle.

inlineShellAcknowledged
Boolean

Must be true when enabling an inline shell script; ignored otherwise.

searchSubtitles
SubtitleSearchPayload!

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

Arguments

NameDescription
input
SearchSubtitlesInput!

Media file ID and, optionally, the subtitle language to search for.

downloadSubtitle
DownloadSubtitlePayload!

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

Arguments

NameDescription
input
DownloadSubtitleInput!

Provider result, media file ID, language, and matching metadata to retain.

deleteExternalSubtitle
DeleteExternalSubtitlePayload!

Delete an external subtitle file and its tracked record.

Arguments

NameDescription
input
DeleteExternalSubtitleInput!

External subtitle ID plus the required preview fingerprint and any confirmation text.

blocklistExternalSubtitle
BlocklistExternalSubtitlePayload!

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

Arguments

NameDescription
input
BlocklistExternalSubtitleInput!

External subtitle ID, optional reason, required preview fingerprint, and any confirmation text.

restoreRecycledItem
RestoreRecycledItemPayload!

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

Arguments

NameDescription
id
ID!

Recycled-item identity to restore to its original path.

restoreRecycledItems
RestoreRecycledItemsPayload!

Restore selected recycled items using one background job.

Arguments

NameDescription
input
RestoreRecycledItemsInput!

Recycled-item identities, conflict policy, and preview fingerprint for the restore job.

deleteRecycledItem
DeleteRecycledItemPayload!

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

Arguments

NameDescription
id
ID!

Recycled-item identity to permanently delete.

deleteRecycledItems
DeleteRecycledItemsPayload!

Permanently delete selected recycled items using one background job.

Arguments

NameDescription
input
DeleteRecycledItemsInput!

Recycled-item identities to permanently delete.

emptyRecycleBin
EmptyRecycleBinPayload!

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

Arguments

NameDescription
libraryIds
[ID!]

Optional library identities to purge; null targets all accessible recycle bins.

startInteractiveReleaseSearch
InteractiveReleaseSearchPayload!

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

Arguments

NameDescription
input
SearchReleasesInput!

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

cancelInteractiveReleaseSearch
CancelInteractiveReleaseSearchPayload!

Cancel a running interactive release-search job.

Arguments

NameDescription
id
ID!

Interactive release-search job identity to cancel.

issueInteractiveReleaseCandidateToken
IndexerSearchResultPayload!

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

Arguments

NameDescription
input
IssueInteractiveReleaseCandidateTokenInput!

Search job, release download URL, and the title (with optional season and episode) the release is assigned to.

queueUnlinkedRelease
QueueUnlinkedReleasePayload!

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

Arguments

NameDescription
input
QueueUnlinkedReleaseInput!

Search job, release download URL, and the enabled download client the release is handed to.

Authorization-filtered counts used for application navigation indicators.

Fields

NameDescription
pendingImportCounts
PendingImportCountsPayload!

Pending imports visible to the caller.

pendingMediaRequestCounts
MediaRequestCountsPayload!

Pending media requests visible to the caller.

activityImportCount
Int!

Count of imports awaiting operator attention and visible to the caller.

pluginUpdateCount
Int!

Count of available plugin updates visible to the caller.

pluginBlockedCount
Int!

Count of installed plugins blocked on this version of Scryer and visible to the caller.

Configured notification channel and its redacted provider settings.

Fields

NameDescription
id
ID!

Notification channel ID.

name
String!

Channel display name.

channelType
String!

Provider channel type.

config
[ProviderConfigValuePayload!]!

Non-secret channel configuration values.

storedSecretKeys
[String!]!

Configuration keys whose secret values are stored but not returned.

mediaServerConnectionId
ID

Media-server connection used by this channel, when applicable.

isEnabled
Boolean!

Whether notifications are enabled for this channel.

blockedReason
String

Why the channel's plugin is blocked on this version of Scryer, or null when it is running.

createdAt
DateTime!

Channel creation time in UTC.

updatedAt
DateTime!

Time of the latest channel update in UTC.

Result of testing a notification channel configuration.

Fields

NameDescription
id
ID!

Tested notification channel ID.

status
String!

Test outcome status.

message
String

Provider response or failure detail, when available.

retryAfterSeconds
Int

Suggested retry delay in seconds, when the provider requests one.

Subscription connecting a notification channel to an event target and scope.

Fields

NameDescription
id
ID!

Subscription ID.

channelId
ID

Notification channel ID, or null when the subscription has no channel.

targetKind
String!

Target category for the subscription.

targetId
ID!

ID of the subscribed target.

eventType
String!

Event type that triggers delivery.

scope
String!

Scope category used to limit matching events.

scopeId
String

Scope key, or null when the scope is global.

isEnabled
Boolean!

Whether this subscription is enabled.

createdAt
DateTime!

Subscription creation time in UTC.

updatedAt
DateTime!

Time of the latest subscription update in UTC.

Enabled notification target available for subscription.

Fields

NameDescription
id
ID!

Target ID.

targetKind
String!

Target category.

name
String!

Target display name.

providerType
String!

Provider type associated with the target.

mediaServerProvider
MediaServerProviderValue

Media-server provider, when the target is a media-server connection.

mediaServerConnectionId
ID

Media-server connection ID, when applicable.

isEnabled
Boolean!

Whether this target can receive notifications.

Public authorization-screen identity for a validated OAuth request.

Fields

NameDescription
clientId
String!

Requested OAuth client identifier.

displayName
String!

Client name safe to display after callback validation.

scope
String!

Server-validated, canonical requested scope set for this authorization decision.

An OAuth application allowed to receive Scryer authorization codes.

Fields

NameDescription
clientId
String!

Immutable OAuth client identifier.

displayName
String!

Name shown to users on the authorization screen.

redirectUris
[String!]!

Exact callback URL allowlist. Managed native clients may use an empty list.

enabled
Boolean!

Whether the application can authorize or refresh tokens.

source
OauthClientSourceValue!

Whether the application is managed by Scryer or an administrator.

kind
OauthClientKindValue!

What the application is for. Immutable after creation.

Non-secret summary of an OAuth grant.

Fields

NameDescription
grantId
ID!

Grant ID used to revoke this authorization.

clientId
String!

OAuth client identifier.

clientName
String!

OAuth client display name.

authorizedAt
DateTime!

UTC time when authorization was granted.

lastUsedAt
DateTime

UTC time when the grant was last used, or null when unused.

Union member indicating that no known acquisition scope is attached.

Fields

NameDescription
orphaned
Boolean!

Always true when this marker is emitted.

Parsed episode numbering extracted from a release title.

Fields

NameDescription
season
Int

Season number, or null when no season was parsed.

episodeNumbers
[Int!]!

Parsed episode numbers; empty means none were detected.

Parsed release title metadata and parser confidence.

Fields

NameDescription
rawTitle
String!

Original release title before normalization.

normalizedTitle
String!

Normalized title used for matching.

releaseGroup
String

Release group, or null when not detected.

quality
String

Quality label, or null when not detected.

source
String

Source label, or null when not detected.

videoCodec
String

Video codec, or null when not detected.

videoEncoding
String

Video encoding, or null when not detected.

stereoscopy
ParsedStereoscopyPayload

Null means no reliable presentation claim, not verified 2D.

audio
String

Audio description, or null when not detected.

isDualAudio
Boolean!

Whether dual audio was detected.

isAtmos
Boolean!

Whether Atmos audio was detected.

isDolbyVision
Boolean!

Whether Dolby Vision was detected.

detectedHdr
Boolean!

Whether HDR was detected.

isProperUpload
Boolean!

Whether the release is marked as a proper upload.

isRemux
Boolean!

Whether the release is a remux.

isBdDisk
Boolean!

Whether the release is a Blu-ray disc image.

isAiEnhanced
Boolean!

Whether an AI-enhanced marker was detected.

parseConfidence
Float!

Parser confidence on the service's 0 through 1 scale.

parseHints
[String!]!

Parser hints retained for diagnostics.

episode
ParsedEpisodePayload

Parsed episode numbering, or null for non-episodic releases.

Stereoscopic claims in the release name, not verified stream properties.

Fields

NameDescription
presentation
StereoPresentationValue!

Whether the release claims 2D, 3D, or a bundle containing both presentations.

layout
StereoLayoutValue

Null when not stated, conflicting, or scoped to an unspecified bundle member.

sampling
StereoSamplingValue

Half/full sampling for side-by-side or top/bottom packing.

encoding
StereoEncodingValue

Optional stereoscopic encoding, independent of packing layout.

Non-secret summary of a registered passkey.

Fields

NameDescription
id
ID!

ID of the passkey.

friendlyName
String

Optional user-assigned passkey name; null when none was saved.

createdAt
DateTime!

UTC time when the passkey was created.

lastUsedAt
DateTime

UTC time when the passkey was last used, or null when unused.

Identifier returned after pausing a wanted state row or convergence scope.

Fields

NameDescription
id
ID!

State-row ID or convergence scope key that was paused.

Parsed file details and suggested episode bindings for a pending import.

Fields

NameDescription
filePath
String!

Full file path.

fileName
String!

File name component.

sizeBytes
Long!

File size in bytes.

parsedSeason
Int

Parsed season number, or null when unavailable.

parsedEpisodes
[Int!]!

Parsed episode numbers; empty means none were detected.

parsedAbsoluteNumbers
[Int!]!

Parsed absolute episode numbers; empty means none were detected.

suggestedEpisodeIds
[ID!]!

Suggested episode IDs; empty means no suggestions were found.

Preview of binding an unmatched imported file to a title and episode.

Fields

NameDescription
title
TitlePayload!

Title selected for the pending import.

file
PendingImportBindingFilePreviewPayload!

File identity and parsed metadata available for binding.

availableEpisodes
[EpisodePayload!]!

Episodes eligible for binding under the selected title.

Offset-paginated pending-import connection.

Fields

NameDescription
items
[PendingImportItemPayload!]!

Items in the requested page; empty means no items matched.

totalCount
Int!

Total matching items before pagination.

hasMore
Boolean!

Whether more matching items exist after this page.

Pending-import counts grouped by media facet.

Fields

NameDescription
movie
Int!

Pending movie count.

series
Int!

Pending series count.

anime
Int!

Pending anime count.

One unmatched library item awaiting import resolution.

Fields

NameDescription
id
ID!

Pending-import item ID.

libraryId
ID!

Library ID containing the item.

facet
MediaFacetValue!

Media facet inferred for the item.

status
PendingImportStatusValue!

Current pending-import status.

titleId
ID

Bound title ID, or null before resolution.

titleName
String

Bound title name, or null before resolution.

titleSlug
String

Bound title slug, or null before resolution.

titleFolderPath
String

Folder currently owned by the bound title, or null before resolution.

displayName
String!

Display name derived from the unmatched item.

path
String!

Full source path.

folderPath
String

Containing folder path, or null when not applicable.

query
String!

Metadata query suggested for resolution.

yearHint
Int

Parsed year hint, or null when unavailable.

reason
String!

Explanation for the pending state.

reasonClass
PendingImportReasonClassValue!

Coarse bucket for reason, stable across scanner reason-code changes.

searchAttempts
[PendingImportSearchAttemptPayload!]!

Metadata search attempts made for this item.

sizeBytes
Long

Size of the pending file; null for folder items and unreadable files.

createdAt
DateTime!

When the scanner first recorded this item.

One metadata search attempt made while resolving a pending import.

Fields

NameDescription
query
String!

Search query submitted.

resultCount
Int!

Number of metadata results returned.

topResults
[String!]!

Top result titles retained for diagnostics.

summary
String!

Human-readable attempt summary.

A release held for delayed acquisition evaluation.

Fields

NameDescription
id
ID!

Stable pending-release identifier.

wantedItemId
ID!

Identifier of the wanted scope awaiting this release.

titleId
ID!

Identifier of the title targeted by the pending release.

releaseTitle
String!

Release title held for later evaluation.

releaseUrl
String

Release URL, or null when the provider did not supply one.

releaseSizeBytes
Long

Release size in bytes, or null when unavailable.

releaseScore
Int!

Score assigned to the pending release.

scoringLogJson
JSON

Structured scoring explanation, or null when unavailable.

indexerSource
String

Provider label, or null when unavailable.

indexerId
ID

Provider identifier, or null when the source is not linked.

publishedAt
DateTime

RFC3339 publication time reported by the indexer, or null when unavailable.

seeders
Int

Number of torrent seeders reported when this release was saved, or null when unknown.

addedAt
DateTime!

Time when the release entered the pending set, in UTC.

delayUntil
DateTime!

Time before which the release is held, in UTC.

lastDecisionCode
String

Current machine-readable reason this release is held, or null when none was recorded.

role
PendingReleaseRoleValue!

Arbitration role independent of the release lifecycle state.

status
PendingReleaseStatusValue!

Lifecycle state of the pending release.

title
TitlePayload

Title associated with this pending release, or null when it is no longer available to the caller.

wantedItem
WantedItemPayload

Wanted scope holding this release, or null when it is no longer available to the caller.

A page of pending releases with count and continuation metadata.

Fields

NameDescription
items
[PendingReleasePayload!]!

Pending releases in stable order.

hasMore
Boolean!

Whether another page exists after this page.

totalCount
Int!

Number of matching pending releases across all pages.

Count of pending releases grouped by lifecycle status.

Fields

NameDescription
status
PendingReleaseStatusValue!

Pending-release status.

count
Int!

Number of releases with this status.

A media server discovered through Plex.

Fields

NameDescription
id
String!

Discovered server identity.

name
String!

Discovered server name.

Automatic official-plugin patch update setting.

Fields

NameDescription
enabled
Boolean!

Whether the scheduled plugin catalog refresh installs official patch updates automatically.

Plugin catalog refresh state, trust warnings, and blocked actions.

Fields

NameDescription
refreshState
CatalogRefreshStateValue!

Catalog refresh lifecycle state.

githubAvailable
Boolean!

Whether the remote catalog source is reachable.

lastCheckedAt
DateTime

UTC time of the last catalog check, or null when never checked.

outageMessage
String

Current outage message, or null when no outage is reported.

blockedActions
[String!]!

Actions blocked by trust or catalog state.

restoreWarnings
[String!]!

Restore warnings that require operator attention.

lastError
String

Last catalog error, or null when none is recorded.

One selectable value for a plugin configuration field.

Fields

NameDescription
value
String!

Machine-readable option value.

label
String!

Display label for the option.

configOverrides
[PluginConfigFieldOverridePayload!]!

Other configuration fields populated when this option is selected.

One field value supplied by a selected plugin configuration preset.

Fields

NameDescription
key
String!

Configuration field key to populate.

value
String!

Configuration field value to populate.

Provider configuration field schema.

Fields

NameDescription
key
String!

Stable field key.

label
String!

Human-readable field label.

fieldType
PluginConfigFieldTypeValue!

Value type that controls field validation and presentation.

required
Boolean!

Whether a value is required.

defaultValue
String

Default value, or null when none is defined.

valueSource
PluginConfigValueSourceValue!

Source of the effective value.

role
PluginConfigFieldRoleValue

Optional semantic role.

hostBinding
String

Host binding name, or null when not applicable.

options
[PluginConfigFieldOptionPayload!]!

Enumerated options, empty for non-select fields.

helpText
String

Help text, or null when unavailable.

visibleWhen
PluginFieldConditionPayload

Condition gating visibility, or null when always shown.

requiredWhen
PluginFieldConditionPayload

Condition that makes the field required, or null when it never applies.

advanced
Boolean!

Whether the field belongs behind the form's advanced disclosure.

Predicate over another configuration field’s current value.

Fields

NameDescription
key
String!

Key of the field whose value is tested.

op
PluginConditionOpValue!

Comparison applied to that field's value.

values
[String!]!

Values compared against; empty for NON_EMPTY.

Trusted plugin HTTP certificate identified by SHA-256 fingerprint.

Fields

NameDescription
fingerprintSha256
String!

Lower-level certificate SHA-256 fingerprint.

pem
String!

PEM-encoded certificate body.

Installed plugin identity, trust metadata, artifact digests, and timestamps.

Fields

NameDescription
id
ID!

Installation record ID.

pluginId
ID!

Registry plugin ID.

name
String!

Installed plugin name.

description
String!

Installed plugin description.

version
String!

Installed plugin version.

sdkVersion
String!

Plugin SDK version.

sdkConstraint
String!

SDK compatibility constraint.

pluginType
String!

Manifest classification of the installed plugin.

providerType
String!

Provider type exposed by the plugin.

isEnabled
Boolean!

Whether the plugin is enabled.

isBuiltin
Boolean!

Whether the plugin is built in.

sourceKind
String!

Installation source kind.

sourceUrl
String

Installation source URL, or null when unavailable.

publisher
String

Publisher identity, or null when unavailable.

supportTier
String!

Trust or support tier.

docsUrl
String

Documentation URL, or null when unavailable.

sourceRepo
String

Source repository URL, or null when unavailable.

manifestUrl
String

Manifest URL, or null when unavailable.

wasmDigest
String

Verified WASM digest, or null when unavailable.

artifactDigest
String

Verified artifact digest, or null when unavailable.

installedAt
DateTime!

UTC installation time.

updatedAt
DateTime!

UTC last-update time.

Progress snapshot for a background plugin installation or upgrade.

Fields

NameDescription
pluginId
ID!

Plugin ID being installed or upgraded.

operationKind
PluginInstallOperationKindValue!

Installation operation kind.

state
PluginInstallStateValue!

Current installation state.

label
String!

Current progress label.

stepIndex
Int!

Current step number, from 1 through the total step count.

stepCount
Int!

Total step count.

message
String

Progress message, or null when none is available.

error
String

Error message, or null when the operation has not failed.

Configured post-processing script and execution policy.

Fields

NameDescription
id
ID!

Post-processing script ID.

name
String!

Script display name.

description
String!

Script description.

scriptType
String!

Script source type.

scriptContent
String!

Source text executed by the post-processing runtime.

appliedFacets
[String!]!

Media facets to which the script applies.

executionMode
ExecutionModeValue!

Workflow phase in which the script runs.

timeoutSecs
Int!

Maximum runtime in seconds.

priority
Int!

Relative execution priority.

enabled
Boolean!

Whether execution is enabled.

debug
Boolean!

Whether debug output is enabled.

createdAt
DateTime!

Creation time in UTC.

updatedAt
DateTime!

Last update time in UTC.

Result of one post-processing script execution.

Fields

NameDescription
id
ID!

Script run ID.

scriptId
ID!

ID of the configured script that produced this run.

scriptName
String!

Script name at execution time.

titleId
ID

Associated title ID, or null when not title-specific.

titleName
String

Associated title name, or null when not title-specific.

facet
MediaFacetValue

Media facet processed, or null when not facet-specific.

filePath
String

File path processed, or null when no file path applied.

status
String!

Run status.

exitCode
Int

Process exit code, or null when the process did not exit normally.

stdoutTail
String

Tail of standard output, when captured.

stderrTail
String

Tail of standard error, when captured.

durationMs
Int

Runtime in milliseconds.

startedAt
DateTime!

Start time in UTC.

completedAt
DateTime

Completion time in UTC, or null while the run is active.

Provider configuration field metadata and its masked stored value.

Fields

NameDescription
key
String!

Stable provider configuration key.

label
String

Human-readable field label, or null when the provider supplies none.

fieldType
PluginConfigFieldTypeValue

Configuration field type, or null when unspecified.

required
Boolean!

Whether a value is required by the provider.

defaultValue
String

Provider default value, or null when no default exists.

valueSource
PluginConfigValueSourceValue

Source of the effective value, or null when no source is recorded.

role
PluginConfigFieldRoleValue

Semantic role of the field, or null when unspecified.

hostBinding
String

Host binding required by the field, or null when not applicable.

options
[PluginConfigFieldOptionPayload!]!

Allowed field options; empty means the field has no enumerated options.

helpText
String

Provider help text, or null when unavailable.

value
ProviderConfigFieldValue

The stored value as a typed union; null when the field is unset.

Provider type metadata and configuration schema.

Fields

NameDescription
providerType
String!

Provider implementation identifier.

name
String!

Provider display name.

configFields
[PluginConfigFieldPayload!]!

Configuration field schemas.

defaultBaseUrl
String

Default base URL, or null when not applicable.

availableHostBindings
[String!]!

Host binding names accepted as configuration value sources.

recommendedFacets
[MediaFacetValue!]!

Recommended media facets.

supportedEvents
[String!]!

Supported notification events.

supportsTest
Boolean!

Whether a connection test is supported.

Provider connection validation result.

Fields

NameDescription
status
String!

Machine-readable validation status.

message
String

Diagnostic message, or null when unavailable.

retryAfterSeconds
Int

Retry delay in seconds, or null when no retry delay applies.

Proxy configuration and latest health state.

Fields

NameDescription
id
ID!

Proxy configuration ID.

name
String!

Proxy configuration name.

providerType
String!

Proxy provider type.

protocol
String

Challenge-solver protocol, or null for transport proxies, which speak no protocol of their own.

baseUrl
String!

Proxy base URL.

requestTimeoutSeconds
Int!

Request timeout in seconds.

hasCredentials
Boolean!

Whether a username or password is stored for this proxy, without exposing either value. Always false for challenge solvers, which take no credentials.

remoteDns
Boolean!

Whether destination hostnames are resolved at the proxy (socks5h). Always false outside SOCKS5.

hasPrivateKey
Boolean!

Whether a private key is stored for this tunnel, without exposing it. Always false outside the tunnel providers.

peerPublicKey
String

WireGuard peer public key, from the [Peer] section, or null outside WireGuard. A public key is public, so this value is shown rather than masked.

hasPresharedKey
Boolean!

Whether a WireGuard preshared key is stored, without exposing it. Always false outside WireGuard.

tunnelPublicKey
String

This tunnel's own public key, derived from its private key, or null when no private key is stored. It is the line the operator must paste into the server's [Peer] section, so it is shown rather than masked.

tunnelAddresses
[String!]!

WireGuard interface addresses, from the [Interface] Address line. Empty outside WireGuard.

tunnelDnsServers
[String!]!

WireGuard resolvers reached through the tunnel, from the [Interface] DNS line. Empty when none are configured.

tunnelMtu
Int

WireGuard tunnel MTU, or null to use the engine's default.

tunnelKeepaliveSeconds
Int

WireGuard persistent keepalive in seconds, or null to use the engine's default. Zero means keepalive is switched off.

hostKeyFingerprint
String

Host key pinned on the first successful tunnel connect, formatted as OpenSSH prints it, or null before the first connect. A host key is public, so this value is shown rather than masked.

hostKeyPinnedAt
DateTime

UTC time the host key above was pinned, or null when none is pinned.

isEnabled
Boolean!

Whether the proxy is enabled.

lastHealthStatus
String

Most recent health status, or null before the first check.

lastErrorMessage
String

Most recent health error, or null when none is recorded.

lastErrorAt
DateTime

UTC time of the most recent health error, or null when none is recorded.

createdAt
DateTime!

UTC creation time.

updatedAt
DateTime!

UTC last-update time.

Result of testing a proxy connection.

Fields

NameDescription
ok
Boolean!

Whether the connection test succeeded.

status
String!

Machine-readable test status.

message
String

Optional diagnostic message.

durationMs
Int

Test duration in milliseconds, or null when unavailable.

observedIp
String

Public outbound IP reported by the destination, or null when unrecognized.

httpStatus
Int

Destination HTTP status, or null when no destination response was received.

Quality acceptance criteria and scoring controls.

Fields

NameDescription
qualityTiers
[String!]!

Ordered quality tiers accepted by the profile.

archivalQuality
String

Archival quality label, or null when not configured.

allowUnknownQuality
Boolean!

Whether unknown quality values are accepted.

sourceAllowlist
[String!]!

Allowed source labels.

sourceBlocklist
[String!]!

Blocked source labels.

videoCodecAllowlist
[String!]!

Allowed video codec labels.

videoCodecBlocklist
[String!]!

Blocked video codec labels.

audioCodecAllowlist
[String!]!

Allowed audio codec labels.

audioCodecBlocklist
[String!]!

Blocked audio codec labels.

dolbyVisionAllowed
Boolean!

Whether Dolby Vision is accepted.

detectedHdrAllowed
Boolean!

Whether detected HDR is accepted.

preferRemux
Boolean!

Whether remux releases are preferred.

allowBdDisk
Boolean!

Whether Blu-ray disc releases are accepted.

allowUpgrades
Boolean!

Whether quality upgrades are allowed.

scoringOverrides
ScoringOverridesPayload!

Optional boolean scoring overrides.

cutoffTier
String

Cutoff quality tier, or null when no cutoff is configured.

minScoreToGrab
Int

Minimum score required to grab, or null when no threshold is configured (Sonarr's MinFormatScore).

cutoffScore
Int

Score past which a file is good enough and same-tier upgrades stop, or null when upgrades never stop (Sonarr's CutoffFormatScore).

Quality-profile acceptance and score breakdown for a release.

Fields

NameDescription
allowed
Boolean!

Whether the release passed the profile decision.

blockCodes
[String!]!

Blocking rule codes that prevented acceptance.

releaseScore
Int!

Aggregate release score.

preferenceScore
Int!

Aggregate preference score.

scoringLog
[ScoringEntryPayload!]!

Ordered scoring contributions used to compute the decision.

Named quality profile and its acceptance criteria.

Fields

NameDescription
id
ID!

Quality-profile ID.

name
String!

Quality-profile name.

criteria
QualityProfileCriteriaPayload!

Acceptance criteria and scoring controls.

Effective quality-profile selection for one content scope.

Fields

NameDescription
scope
ContentScopeValue!

Content scope to which the selection applies.

overrideProfileId
ID

Scope-specific profile override ID, or null when inherited.

effectiveProfileId
ID!

Quality-profile ID selected after applying inheritance and overrides.

inheritsGlobal
Boolean!

Whether the effective profile comes from the global setting.

Quality profiles, global defaults, and per-content-scope selections.

Fields

NameDescription
profiles
[QualityProfilePayload!]!

Available quality profiles.

globalProfileId
ID!

Global quality-profile ID.

globalScoringPersona
ScoringPersonaValue!

Scoring persona inherited by content scopes without an override.

categorySelections
[QualityProfileSelectionPayload!]!

Effective profile selection by content scope.

categoryPersonaSelections
[FacetScoringPersonaSelectionPayload!]!

Effective scoring-persona selection by content scope.

Read-only GraphQL query root for authenticated HTTP requests.

Fields

NameDescription
titles
TitleCatalogPayload!

List a permission-filtered title catalog page with optional facet, filter, search, sort, and pagination controls.

Arguments

NameDescription
facet
MediaFacetValue

Restrict results to one media facet; omitted includes all facets visible to the caller.

libraryIds
[ID!]

Restrict results to these library IDs; omitted or empty uses all libraries visible to the caller.

query
String

Optional title search text; omitted applies no text filter.

filter
TitleCatalogFilterInput

Optional catalog filters for monitoring, content status, roots, tags, year, and rating.

sort
TitleCatalogSortInput

Optional sort key and direction; omitted uses the application default.

limit
Int

Requested page size; defaults to 300 and is clamped to 1 through 300.

offset
Int

Zero-based page offset; defaults to 0 and negative values are treated as 0.

titleCatalogFilterOptions
TitleCatalogFilterOptionsPayload!

Return available catalog filter values for the requested facet and library scope.

Arguments

NameDescription
facet
MediaFacetValue

Restrict options to one media facet; omitted includes all facets visible to the caller.

libraryIds
[ID!]

Restrict options to these library IDs; omitted or empty uses all libraries visible to the caller.

rootFolderIds
[ID!]

Restrict options to these root-folder IDs; omitted or empty uses all roots, and blank or duplicate values are ignored.

libraries
[LibraryPayload!]!

List libraries visible to the caller that grant at least the requested permission.

Arguments

NameDescription
facet
MediaFacetValue

Restrict results to one media facet; omitted includes all facets.

permission
LibraryPermissionValue

Minimum library permission required; defaults to View.

storageRoots
[StorageRootUsagePayload!]!

List root folders of libraries the caller can view, with the disk usage of each backing filesystem.

mediaRequests
[MediaRequestPayload!]!

List media requests visible to the caller, optionally filtered by facet, libraries, and status.

Arguments

NameDescription
facet
MediaFacetValue

Restrict requests to one media facet; omitted includes all facets.

libraryIds
[ID!]

Restrict requests to these library IDs; omitted uses all permitted libraries and an empty list returns no rows.

status
MediaRequestStatusValue

Restrict requests to one status; omitted includes all statuses.

myMediaRequests
[MediaRequestPayload!]!

List only the caller's media requests, optionally filtered by facet, libraries, and status.

Arguments

NameDescription
facet
MediaFacetValue

Restrict requests to one media facet; omitted includes all facets.

libraryIds
[ID!]

Restrict requests to these library IDs; omitted uses all permitted libraries and an empty list returns no rows.

status
MediaRequestStatusValue

Restrict requests to one status; omitted includes all statuses.

librarySettings
LibrarySettingsPayload!

Read settings for a library by ID, subject to the caller's library-settings permission.

Arguments

NameDescription
libraryId
ID!

Library ID whose settings are returned.

titlesByExternalIds
[TitlePayload!]!

Find visible titles by external IDs from a named metadata source.

Arguments

NameDescription
source
String!

Metadata-provider namespace used to interpret the external IDs.

values
[String!]!

External ID values to match; an empty list returns no titles.

title
TitlePayload

Fetch a visible title by ID, returning null when it does not exist or is not accessible.

Arguments

NameDescription
id
ID!

Title ID to fetch.

movieEntity
MovieEntityPayload

Fetch locally cached movie metadata through a visible title relationship.

Arguments

NameDescription
titleId
ID!

Title used to authorize access to the movie.

id
ID!

Movie entity ID to fetch.

episode
EpisodePayload

Fetch an episode by ID while verifying that it belongs to the supplied parent title.

Arguments

NameDescription
titleId
ID!

Parent title ID used to verify the episode belongs to that title.

episodeId
ID!

Episode ID to fetch and verify against title_id.

episodeById
EpisodePayload

Fetch an episode by globally unique ID without requiring a parent title ID.

Arguments

NameDescription
id
ID!

Episode ID to fetch.

collectionById
CollectionPayload

Fetch a collection by globally unique ID, returning null when it is absent or inaccessible.

Arguments

NameDescription
id
ID!

Collection ID to fetch.

titleBySlug
TitlePayload

Fetch a visible title by facet, optional library slug, and title slug.

Arguments

NameDescription
facet
MediaFacetValue!

Media facet used to scope the slug lookup.

librarySlug
String

Optional library slug used to disambiguate the title.

slug
String!

Title slug to look up within the facet and optional library.

mediaRenamePreview
MediaRenamePlanPayload!

Preview the rename plan for a title or an entire facet without changing files.

Arguments

NameDescription
input
MediaRenamePreviewInput!

Title or facet whose rename plan is returned; no files are changed.

mediaRenamePreviewBulk
[MediaRenamePlanPayload!]!

Preview rename plans for several titles of one facet without changing files.

Arguments

NameDescription
input
MediaRenamePreviewBulkInput!

Titles whose rename plans are returned, in the order supplied; no files are changed.

changeTitleFolderPreview
ChangeTitleFolderPreviewPayload!

Preview correcting which existing folder a title owns; no files are moved.

Arguments

NameDescription
input
ChangeTitleFolderPreviewInput!

Title and candidate folder whose ownership change is described; nothing is changed.

locationOperationPreview
LocationOperationPreviewPayload!

Preview moving selected titles to another library or root; nothing is moved.

The returned fingerprint is what startLocationOperation confirms. A changed filesystem, catalog, selection, destination, or mode produces a different fingerprint and voids the confirmation.

The mode picks which preview runs: the managed move plans the copy, and USER_MOVED_FILES re-points the catalog at a move the user already made themselves. The reported mode can still come back as CATALOG_ONLY when the selection has no files on disk (FR-076).

Arguments

NameDescription
input
LocationOperationPreviewInput!

Titles to move, the destination library or root they would move to, and how the files get there.

locationRootScopePreview
LocationRootScopePreviewPayload!

Preview a Change root (US4 + US5): moving one root's content to a new path, or folding it into another root of the same library.

FR-020 is one settings action with two destinations, so it is one query with two destinations. Name destinationPath for a new location, or destinationRootId for a root that already exists; a destinationPath that resolves to a configured root of this library is the same request as naming that root, and is planned as a fold either way. Naming both, or neither, is refused.

Root scoped, so there is no selection: every title assigned to the root goes, and the ledger says so rather than offering a way to exclude one (FR-023). The returned fingerprint is what startLocationOperation confirms with its rootScope target.

Arguments

NameDescription
input
LocationRootScopePreviewInput!

The root being moved, the destination it moves to, and how the files get there.

locationTransferSummary
LocationTransferSnapshotPayload

Aggregate progress of one transfer with no title rows; poll this for the operation header.

Arguments

NameDescription
id
ID!

Location-operation identity.

locationTransferPage
LocationTransferSnapshotPayload

One page of up to 50 title rows of a transfer, exceptions first.

Arguments

NameDescription
id
ID!

Location-operation identity.

offset
Int!

Zero-based index of the first title row to return.

locationTransferFiles
LocationTransferSnapshotPayload

One page of up to 50 file rows for one title of a transfer.

Arguments

NameDescription
id
ID!

Location-operation identity.

titleId
ID!

Identity of the title whose files to page.

offset
Int!

Zero-based index of the first file row to return.

locationTransferTitleDetail
String

The operator-facing detail behind a title's exception, or null when it has none.

Arguments

NameDescription
id
ID!

Location-operation identity.

titleId
ID!

Identity of the title whose detail to read.

locationOperation
LocationOperationPayload

Read one location operation with its per-title checkpoints.

Arguments

NameDescription
id
ID!

Location-operation identity.

locationOperationRetrySelection
LocationRetrySelectionPayload

What planning a location operation's unfinished work again would select: the same destination and mode, and the titles it did not finish.

Read on demand for a stopped operation, since it joins the stored plan with the checkpoints. Null for an unknown operation, one stored without a readable plan, and for the root-scoped operation types, which are planned again from the root rather than from titles.

Arguments

NameDescription
id
ID!

Location-operation identity.

locationOperationAssets
LocationOperationAssetListingPayload

Which files one location operation renames and deduplicates, per title.

Activity's counters say how many; this says which ones, and whether each has happened yet or is still only what the confirmed plan intends (FR-091). It is a separate read from locationOperation because the per-file identities live in the operation's stored plan, which a progress poll has no reason to load.

Arguments

NameDescription
id
ID!

Location-operation identity.

deleteTitlePreview
DeletePreviewPayload!

Preview deleting all media files for one title without changing files.

Arguments

NameDescription
titleId
ID!

Title ID whose associated media files would be deleted.

deleteTitlesPreview
DeleteTitlesPreviewPayload!

Preview deleting media files for the supplied title IDs without changing files.

Arguments

NameDescription
input
DeleteTitlesPreviewInput!

Title IDs whose associated media files would be deleted; no files are changed.

deleteEpisodeFilesPreview
DeleteEpisodeFilesPreviewPayload!

Preview deleting the media files of the supplied episodes without changing files.

Arguments

NameDescription
input
DeleteEpisodeFilesPreviewInput!

Title and episode IDs whose linked media files would be deleted; no files are changed.

deleteMediaFilePreview
DeletePreviewPayload!

Preview deleting one media file without changing files.

Arguments

NameDescription
fileId
ID!

Media-file ID whose deletion would be previewed.

deleteExternalSubtitlePreview
DeletePreviewPayload!

Preview deleting one external subtitle file without changing files.

Arguments

NameDescription
externalSubtitleId
ID!

External-subtitle ID whose deletion would be previewed.

wantedItem
WantedItemPayload

Fetch one wanted item by ID, returning null when it is absent or inaccessible.

Arguments

NameDescription
id
ID!

Wanted-item ID to fetch.

searchReleases
[IndexerSearchResultPayload!]!

Search indexers for a title, series movie link, or episode and return at most 200 results.

Arguments

NameDescription
input
SearchReleasesInput!

Search target and optional season, episode, and result limit; season and episode must be supplied together.

interactiveReleaseSearch
InteractiveReleaseSearchPayload

Poll an interactive release-search job; null means no visible snapshot exists.

Arguments

NameDescription
id
ID!

Interactive release-search job ID to poll.

titleHistory
TitleHistoryPagePayload!

List title history events with optional identity, event, grouping, and offset filters.

Arguments

NameDescription
filter
TitleHistoryFilterInput!

Event, title, library, text, grouping, and pagination filters.

titleReleaseBlocklist
[TitleReleaseBlocklistEntryPayload!]!

List blocklisted releases for one title; the limit defaults to 100 and values below 1 become 1.

Arguments

NameDescription
titleId
ID!

Title ID whose blocked releases are returned.

limit
Int

Maximum entries to return; defaults to 100 and values below 1 become 1.

dashboardActivityStats
DashboardActivityStatsPayload!

Return grab, upgrade, import, and failure counts for a trailing window and the window before it.

Arguments

NameDescription
windowHours
Int!

Length of each window in hours; defaults to 24 and is clamped to 1 through 168.

activityEvents
[ActivityEventPayload!]!

List recent activity events with zero-based offset pagination.

Arguments

NameDescription
limit
Int

Maximum events to return; defaults to 100.

offset
Int

Number of events to skip; defaults to 0.

auditLog
[DomainEventEnvelopePayload!]!

List audit events visible to the caller, filtered by event type, title, facet, sequence, and limit.

Arguments

NameDescription
eventTypes
[DomainEventTypeValue!]

Optional event types to include; omitted includes all visible types.

titleId
ID

Include only events for this title ID.

facet
MediaFacetValue

Include only events for this media facet.

afterSequence
Long

Return events after this exclusive sequence number.

beforeSequence
Long

Return events before this exclusive sequence number.

limit
Int

Maximum events to return; defaults to 100 and values below 1 become 1.

activeLibraryScans
[LibraryScanProgressPayload!]!

List active library scan sessions visible to the caller.

libraryScanSession
LibraryScanProgressPayload

Recover an active or completed scan snapshot visible to the caller.

Arguments

NameDescription
sessionId
ID!

ID of the active or completed library scan to recover.

externalImportArrSourceWarmupStatus
ExternalImportMonitorWarmupProgressPayload!
Deprecated: use externalImportWarmupStatus

Poll deprecated external movie or series source warmup status for one session.

Arguments

NameDescription
sessionId
ID!

External movie or series source warmup session ID to poll.

externalImportWarmupStatus
ExternalImportMonitorWarmupProgressPayload!

Poll warmup status for one external movie, series, or indexer discovery session.

Arguments

NameDescription
sessionId
ID!

Warmup session ID to poll.

externalImportAggregateWarmupProgress
ExternalImportAggregateWarmupProgressPayload!

Aggregate Arr-source warmup progress; an empty list returns completed status with zero totals.

Arguments

NameDescription
input
ExternalImportAggregateWarmupProgressInput!

External movie or series source warmup session IDs to aggregate; an empty list returns COMPLETED with zero totals.

pendingImportCounts
PendingImportCountsPayload!

Return pending-import counts visible to the caller.

navigationBadgeCounts
NavigationBadgeCountsPayload!

Return navigation counts while omitting categories the caller is not authorized to view.

pendingImports
PendingImportConnectionPayload!

List pending imports by facet, library scope, status, and offset pagination.

Arguments

NameDescription
facet
MediaFacetValue!

Media facet whose pending imports are returned.

libraryIds
[ID!]

Library IDs to restrict the result; omitted or empty includes all permitted libraries.

status
PendingImportStatusValue!

Pending-import status to include.

limit
Int!

Maximum items to return; defaults to 50 and is clamped to 0 through 500.

offset
Int!

Number of matching items to skip; defaults to 0.

pendingImportTitleSearch
[MetadataSearchItemPayload!]!

Search metadata candidates for one pending import.

Arguments

NameDescription
pendingImportId
ID!

Pending-import ID whose title candidates are searched.

query
String!

Text used to search metadata candidates.

limit
Int!

Maximum candidates to return; defaults to 8.

language
String!

Metadata language code; defaults to "eng".

year
Int

Release year filter, when supplied.

pendingImportBindingPreview
PendingImportBindingPreviewPayload!

Preview the title binding for one pending import without applying it.

Arguments

NameDescription
pendingImportId
ID!

Pending-import ID whose title binding is previewed.

jobs
[JobDefinitionPayload!]!

List job definitions visible to the caller.

activeJobRuns
[JobRunPayload!]!

List currently active job runs visible to the caller.

jobRuns
[JobRunPayload!]!

List recent runs for one job key; the limit defaults to 10 and values below 1 become 1.

Arguments

NameDescription
jobKey
JobKeyValue!

Job key whose runs should be listed.

limit
Int

Maximum runs to return; defaults to 10 and values below 1 become 1.

recentJobRuns
[JobRunPayload!]!

List recent job runs; the limit defaults to 50 and values below 1 become 1.

Arguments

NameDescription
limit
Int

Maximum runs to return; defaults to 50 and values below 1 become 1.

discoveryHome
DiscoveryHomePayload!

Return discovery home results using optional facet, filter, and pagination input.

Arguments

NameDescription
input
DiscoveryHomeInput

Facet, filters, and pagination; omitted uses service defaults.

discoveryHomeCards
DiscoveryHomeCardsPayload!

Return discovery home cards using optional facet, filter, and pagination input.

Arguments

NameDescription
input
DiscoveryHomeInput

Facet, filters, and pagination; omitted uses service defaults.

discoveryHomeFilterOptions
DiscoveryHomeFilterOptionsPayload!

Return discovery home filter options for an optional facet and library scope.

Arguments

NameDescription
input
DiscoveryHomeFilterOptionsInput

Facet and library scope for filter options; omitted uses service defaults.

discoveryItems
DiscoveryItemsPayload!

List discovery items using optional filters, sorting, and pagination.

Arguments

NameDescription
input
DiscoveryItemsInput

Discovery filters, sorting, and pagination; omitted uses service defaults.

discoveryItemDetail
DiscoveryItemPayload

Fetch one discovery item by identity and scope, returning null when unavailable.

Arguments

NameDescription
input
DiscoveryItemDetailInput!

Discovery item identity and scope used for the lookup.

catalogDiscovery
CatalogDiscoveryPayload!

Return catalog discovery results for the requested target and filters.

Arguments

NameDescription
input
CatalogDiscoveryInput!

Catalog target, filters, sorting, and pagination.

downloadQueuePage
DownloadQueuePagePayload!

Return a bounded download queue page with readiness, revision, staleness, filters, and stable sorting metadata.

Arguments

NameDescription
limit
Int!

Number of queue items to return; defaults to 50 and is clamped to 1 through 200.

offset
Int!

Number of matching queue items to skip; defaults to 0 and negative values become 0.

filters
[DownloadActivityFilterValue!]

Activity states to include; omitted includes all states and an empty list returns no rows.

clientIds
[ID!]

Download-client IDs to include; omitted includes all clients and an empty list returns no rows.

scryerSubmittedOnly
Boolean!

When true, include only downloads submitted by Scryer; defaults to true.

titleId
ID

Include only queue items for this title ID.

sortKey
DownloadQueueSortKeyValue!

Queue sort key; defaults to Status.

sortDirection
SortDirectionValue!

Queue sort direction; defaults to Asc.

activeImportStreams
[ActiveImportStreamPayload!]!

Return queued and active filesystem import operations. Idle worker capacity is never included.

downloadQueue
[DownloadQueueItemPayload!]!
Deprecated: use downloadQueuePage

Deprecated download activity listing without pagination or queue readiness metadata.

Arguments

NameDescription
includeAllActivity
Boolean

Include all activity types instead of the default active subset; defaults to false.

includeHistoryOnly
Boolean

Include history-only activity; defaults to false.

includeImportActivity
Boolean

Include import activity; defaults to false.

titleId
ID

Include only activity for this title ID.

activityFilter
DownloadActivityFilterValue

Activity state filter; defaults to All.

downloadImport
DownloadImportPagePayload!

List a bounded page of download-import activity; the limit defaults to 50 and is clamped to 1 through 100.

Arguments

NameDescription
limit
Int

Number of import records to return; defaults to 50 and is clamped to 1 through 100.

offset
Int

Number of matching import records to skip; defaults to 0 and negative values become 0.

filter
DownloadImportFilterValue

Import activity filter; defaults to All.

downloadHistory
DownloadHistoryPagePayload!

List a bounded page of download history with optional client, activity, and sort filters.

Arguments

NameDescription
limit
Int

Number of history records to return; defaults to 50 and is clamped to 1 through 50.

offset
Int

Number of matching history records to skip; defaults to 0 and negative values become 0.

filters
[DownloadHistoryFilterValue!]

History activity filters; omitted includes all states and an empty list returns no rows.

clientIds
[ID!]

Download-client IDs to include; omitted includes all clients and an empty list returns no rows.

scryerSubmittedOnly
Boolean

When true, include only downloads submitted by Scryer; defaults to false.

sortKey
DownloadHistorySortKeyValue

History sort key; omitted uses the service default.

sortDirection
SortDirectionValue

Sort direction when a sort key is supplied; defaults to Asc.

subtitleSettings
SubtitleSettingsPayload!

Returns the current subtitle settings available to the authenticated actor.

acquisitionSettings
AcquisitionSettingsPayload!

Returns acquisition thresholds and polling settings for the authenticated actor.

generalSettings
GeneralSettingsPayload!

Returns system settings, effective image-cache limits, and trusted plugin certificates.

recycleBinSettings
RecycleBinSettingsPayload!

Returns whether the recycle bin is enabled for the authenticated actor.

verificationSettings
VerificationSettingsPayload!

Returns the verification depth applied to download-client completed-download copies. Location operations always verify in full and ignore it.

pluginAutoUpdateSettings
PluginAutoUpdateSettingsPayload!

Returns whether the scheduled plugin catalog refresh installs official patch updates automatically.

autoBackupSettings
AutoBackupSettingsPayload!

Returns auto-backup scheduling metadata without exposing the backup key.

backupSettings
BackupSettingsPayload!

Returns configured, default, and effective backup paths.

myUiSettings
UiSettingsPayload!

Returns the current UI settings for the authenticated actor.

securitySettings
SecuritySettingsPayload!

Returns saved security settings together with effective and environment-overridden login state.

oauthClientRegistrations
[OauthClientRegistrationPayload!]!

Lists managed and administrator-created OAuth applications.

oauthAuthorizationClient
OauthAuthorizationClientPayload!

Resolves the display name for an OAuth authorization request after validating its callback URL.

Arguments

NameDescription
clientId
String!

OAuth client identifier from the authorization request.

redirectUri
String!

Redirect URI from the authorization request.

scope
String

Requested OAuth scopes, validated and canonicalized before display.

externalAuthRuntimeSettings
ExternalAuthRuntimeSettingsPayload!

Returns effective external-auth providers and connections, hiding login capability when form login is disabled.

mediaServerConnections
[MediaServerConnectionPayload!]!

Lists media-server connections, optionally restricted to one provider.

Arguments

NameDescription
provider
MediaServerProviderValue

Optional provider filter; omit or pass null to list every connection.

jellyfinServerUsers
[JellyfinServerUserPayload!]!

Lists users from the media-server connection identified by connection_id.

Arguments

NameDescription
connectionId
ID!

ID of the Jellyfin media-server connection to query.

search
String

Optional user-name search; omit or pass null for no text filter.

mediaServerUsers
[MediaServerUserGroupPayload!]!

Lists grouped media-server users, optionally filtered by search text.

Arguments

NameDescription
search
String

Optional user search; omit or pass null to return all groups.

authRuntimeState
AuthRuntimeStatePayload!

Returns effective authentication and MFA requirements after runtime overrides are applied.

myPasskeys
[PasskeySummaryPayload!]!

Lists the authenticated actor's passkey summaries without credential material.

myTotp
TotpStatusPayload!

Returns TOTP status and recovery-code count without exposing the shared secret or codes.

myOauthApps
[OauthConnectedAppPayload!]!

Lists OAuth grants authorized by the authenticated actor without client secrets.

myApiKeys
[ApiKeyPayload!]!

Lists the interactive actor's API keys without returning their secrets.

canCreateMyApiKeys
Boolean!

Whether the interactive actor may create API keys under the active security policy.

delayProfiles
[DelayProfilePayload!]!

Lists delay profiles with minute-based delays and their media-facet assignments.

titleTagDefinitions
[TitleTagDefinitionPayload!]!

Lists every administrator-defined title tag with the number of titles carrying it.

Readable by any authenticated caller: the tag picker and the catalog filter both need the vocabulary, and the vocabulary says nothing about any particular title.

mediaSettings
MediaSettingsPayload!

Returns media settings for the requested content scope.

Arguments

NameDescription
scope
ContentScopeValue!

Content scope whose media settings should be returned.

libraryPaths
LibraryPathsPayload!

Returns the configured movie, series, and anime library paths.

serviceSettings
ServiceSettingsPayload!

Returns service TLS configuration and related settings.

qualityProfileSettings
QualityProfileSettingsPayload!

Returns quality profiles and the current global and facet selections.

downloadClientRouting
[DownloadClientRoutingEntryPayload!]!

Returns download-client routing entries for a content scope.

Arguments

NameDescription
scope
ContentScopeValue!

Content scope whose download-client routing should be returned.

indexerRouting
[IndexerRoutingEntryPayload!]!

Returns indexer routing entries for a content scope.

Arguments

NameDescription
scope
ContentScopeValue!

Content scope whose indexer routing should be returned.

indexers
[IndexerConfigPayload!]!

Lists indexer configurations and current query statistics, optionally filtered by provider type.

Arguments

NameDescription
providerType
String

Optional provider-type filter; omit or pass null to list every indexer.

seedingProfiles
[SeedingProfilePayload!]!

Lists configured torrent seeding profiles.

defaultSeedingProfile
DefaultSeedingProfilePayload!

Returns the seeding profile applied when nothing more specific matches.

indexerDownloadClientMappingCatalog
IndexerDownloadClientMappingCatalogPayload!

Returns compatible download clients and indexers for routing configuration.

proxyConfigs
[ProxyConfigPayload!]!

Lists configured proxy settings.

rootFolders
[RootFolderPayload!]!

Lists root folders for a media facet.

Arguments

NameDescription
facet
MediaFacetValue!

Media facet whose root folders should be returned.

downloadClientConfigs
[DownloadClientConfigPayload!]!

Lists download-client configurations with provider field metadata and redacted secrets.

subtitleProviderConfigs
[SubtitleProviderConfigPayload!]!

Lists subtitle-provider configurations, optionally filtered by provider type.

Arguments

NameDescription
providerType
String

Optional provider-type filter; matching is case-insensitive and null returns all providers.

users
[UserPayload!]!

Lists users with authorization and authentication-factor status, excluding secret values.

runtimeInfo
RuntimeInfoPayload!

Return the path style supported by the running service.

systemHealth
SystemHealthPayload!

Return system health details visible to the authenticated caller.

scryerVersion
String!

Return the running Scryer version.

instanceFeatures
InstanceFeaturesPayload!

Instance-wide feature switches readable by any signed-in user.

smgVersionCompatibilityNotice
SmgVersionCompatibilityNoticePayload

Return an SMG compatibility notice when the connected SMG version requires attention.

smgScryerUpdateNotice
SmgScryerUpdateNoticePayload

Return an available Scryer update notice from SMG, if one exists.

applicationUpgradeStatus
ApplicationUpgradeStatusPayload!

Return application update availability and installation eligibility; requires system-settings management permission.

recycledItems
RecycledItemsPayload!

List recycled media items in a bounded page, optionally restricted to library IDs.

Arguments

NameDescription
limit
Int!

Number of recycled items to return; defaults to 500 and is clamped to 1 through 500.

offset
Int!

Number of matching recycled items to skip; defaults to 0 and negative values become 0.

libraryIds
[ID!]

Library IDs to include; omitted or empty includes all permitted libraries.

previewRestoreRecycledItems
RecycleRestorePreviewPayload!

Preview restoring recycled items by ID without changing their files.

Arguments

NameDescription
ids
[ID!]!

Recycled-item IDs whose restore destinations are previewed; an empty list returns an empty preview.

backups
[BackupInfoPayload!]!

List available backups; requires system-settings management permission.

pendingReleases
PendingReleasesPayload!

List a bounded page of pending releases with optional title, wanted-item, and status filters.

Arguments

NameDescription
filter
PendingReleaseFilterInput

Optional title, wanted-item, and release-status filters; omitted applies no filters.

limit
Int!

Number of pending releases to return; defaults to 50 and is clamped to 1 through 500.

offset
Int!

Number of matching pending releases to skip; defaults to 0 and negative values become 0.

importHistory
[ImportRecordPayload!]!

List recent import records; the limit defaults to 50 and is capped at 500.

Arguments

NameDescription
limit
Int

Number of import records to return; defaults to 50 and is clamped to 1 through 500.

me
UserPayload

Return the authenticated user payload, or null for an anonymous session; restricted enrollment and password-replacement sessions are rejected.

wantedItems
WantedItemsListPayload!

Return Missing or Cutoff Upgrade targets with activity state and per-scope convergence progress.

Arguments

NameDescription
wantedKind
WantedKindValue!

Wanted target set to list; defaults to Missing.

facet
MediaFacetValue

Media facet filter, when supplied.

libraryIds
[ID!]

Library IDs to include; omitted or empty includes all permitted libraries.

titleSearch
String

Title search text, when supplied.

limit
Int!

Number of targets to return; defaults to 50.

offset
Int!

Number of matching targets to skip; defaults to 0.

cutoffUnmetTitlesPage
CutoffUnmetTitlesPagePayload!

Return one page of cutoff-unmet targets with the full match count and per-item convergence progress.

Arguments

NameDescription
facet
MediaFacetValue

Media facet filter, when supplied.

libraryIds
[ID!]

Library IDs to include; omitted or empty includes all permitted libraries.

limit
Int!

Number of targets to return; negative values become 0.

offset
Int!

Number of matching targets to skip; negative values become 0.

titleAcquisitionDiagnostics
TitleAcquisitionDiagnosticsPayload!

Return acquisition diagnostics for one title ID.

Arguments

NameDescription
titleId
ID!

Title ID whose acquisition diagnostics are returned.

acquisitionSearchJob
AcquisitionSearchJobPayload

Return progress for an interactive acquisition-search job, or null when no such job exists.

Arguments

NameDescription
id
ID!

Acquisition-search job ID to poll.

ruleSets
[RuleSetPayload!]!

List rule sets visible to the caller.

ruleSet
RuleSetPayload

Return one rule set, including its source, when it is visible to the caller.

Arguments

NameDescription
id
ID!

Rule-set identity to load.

maintenanceRuleSets
[MaintenanceRuleSet!]!

List maintenance rule sets; requires catalog-settings management permission.

maintenanceRuleSet
MaintenanceRuleSetDetail

Return one maintenance rule set with the revision currently in force, or null when no such rule set exists.

Arguments

NameDescription
id
ID!

Maintenance rule-set ID to load.

maintenanceRuleRevisions
[MaintenanceRuleRevision!]!

List every stored revision of one maintenance rule set, newest first.

Arguments

NameDescription
ruleSetId
ID!

Maintenance rule-set ID whose revisions are returned.

maintenanceActionDescriptors
[MaintenanceActionDescriptor!]!

List the static maintenance action catalog the rule builder chooses from.

maintenanceActionStepDescriptors
[MaintenanceActionStepDescriptor!]!

List the backend-owned schema-2 action-sequence catalog. Authoring clients use its parameter and dependency descriptors directly rather than maintaining a parallel effect matrix.

maintenanceCandidates
[MaintenanceCandidate!]!

List lifecycle candidates the maintenance evaluator has recorded; requires catalog-settings management permission.

Two independent things hide rows, and they are not the same thing. A rule in shadow mode is dark by definition, so its candidates are returned only when includeShadow is true. Separately, the instance result-display gate hides everything while it is off.

includeShadow overrides the gate as well as the mode filter, on purpose: an operator deciding whether to arm result display has to be able to see what shadow evaluation actually found first, and reaching this query already requires catalog-settings management.

Arguments

NameDescription
ruleSetId
ID

Return candidates of this rule set only.

states
[MaintenanceCandidateState!]

Return candidates in these lifecycle states only.

libraryId
ID

Return candidates whose subject belongs to this library only.

includeShadow
Boolean

Include candidates produced by rules running in shadow mode.

limit
Int

Maximum number of candidates to return.

maintenanceEvaluationRuns
[MaintenanceEvaluationRun!]!

List recorded maintenance evaluation runs, newest first.

Runs carry counts and timing rather than subjects, so the result-display gate does not hide them: they are how an operator sees that dark evaluation is working at all.

Arguments

NameDescription
ruleSetId
ID

Return runs of this rule set only.

limit
Int

Maximum number of runs to return.

maintenanceInstanceGates
MaintenanceInstanceGates!

Read the five instance-wide maintenance gates; requires system-settings management permission.

maintenanceExclusions
[MaintenanceExclusion!]!

List maintenance exclusions, newest first.

Narrowing by rule returns that rule's own exclusions together with every global one, because both are what actually stop it acting.

Arguments

NameDescription
ruleSetId
ID

Return the exclusions that apply to this rule set.

maintenanceActionRuns
[MaintenanceActionRun!]!

List recorded maintenance action-handler attempts, newest first.

Arguments

NameDescription
ruleSetId
ID

Return only attempts for this rule set.

candidateId
ID

Return only attempts for this candidate.

limit
Int

Maximum rows to return; defaults to fifty.

requestRuleSets
[RequestRuleSet!]!

List request rule sets; requires catalog-settings management permission.

requestRuleSet
RequestRuleSetDetail

Return one request rule set with the revision currently in force, or null when no such rule set exists.

Arguments

NameDescription
id
ID!

Request rule-set ID to load.

requestRuleRevisions
[RequestRuleRevision!]!

List every stored revision of one request rule set, newest first.

Arguments

NameDescription
ruleSetId
ID!

Request rule-set ID whose revisions are returned.

requestRuleInstanceGates
RequestRuleInstanceGates!

Read the instance-wide request-rule gate; requires system-settings management permission.

requestRuleDecision
RequestRuleDecision

Read the decision recorded for one media request, or null when it was never evaluated.

Two audiences reach this. A manager of the request's library sees the whole trace. The requester sees the outcome, the fallback reason, the reasons, and the tags, with votes emptied, which is the same redaction the pre-flight enforces by construction.

Arguments

NameDescription
requestId
ID!

Media request whose decision is returned.

requestRuleDecisions
[RequestRuleDecision!]!

List recorded request decisions, newest first; requires catalog-settings management permission.

Arguments

NameDescription
limit
Int

Maximum decisions to return; defaults to 50 and is clamped to 1 through 500.

outcome
RequestDecisionOutcomeValue

Return only decisions whose effective outcome was this.

requestRuleInputReference
JSON!

The request family's Rules Context Reference: every fact a request matcher may read.

previewMyRequestDecision
RequestPreflightPayload!

Evaluate a draft request without submitting it; requires request permission on the target library.

Takes the submit mutation's own input type, deliberately: the pre-flight and the submit share one input, one metadata read, and one evaluation function, which is what makes "identical drafts yield identical decisions" a property of the code rather than a promise.

Arguments

NameDescription
input
SubmitMediaRequestInput!

The draft request to evaluate, exactly as it would be submitted.

titleClaims
[TitleClaim!]!

List every lifecycle claim on one title, live and historical; requires title management on the title's library.

Arguments

NameDescription
titleId
ID!

Title whose claims are returned.

postProcessingScripts
[PostProcessingScriptPayload!]!

List post-processing scripts visible to the caller.

postProcessingScriptRuns
[PostProcessingScriptRunPayload!]!

List runs for one post-processing script; the limit defaults to 50 and is clamped to 1 through 500.

Arguments

NameDescription
scriptId
ID!

Post-processing script ID whose runs are returned.

limit
Int

Maximum runs to return; defaults to 50 and is clamped to 1 through 500.

plugins
[RegistryPluginPayload!]!

List available registry plugins visible to the caller.

pluginCatalogStatus
PluginCatalogStatusPayload!

Return plugin catalog readiness and update status visible to the caller.

rulePackRegistry
[RulePackRegistryEntryPayload!]!

List community rule packs from the plugin registry.

rulePackTemplates
[RulePackTemplatePayload!]!

Fetch templates from a community rule pack by registry ID.

Arguments

NameDescription
packId
String!

Registry ID of the community rule pack.

trackedRulePacks
[TrackedRulePackPayload!]!

List tracked community rule packs and their local rule bindings.

indexerProviderTypes
[ProviderTypePayload!]!

Return available indexer provider types and their configuration fields; requires system-settings permission.

downloadClientProviderTypes
[ProviderTypePayload!]!

Return available download-client provider types and their configuration fields; requires system-settings permission.

subtitleProviderTypes
[ProviderTypePayload!]!

Return available subtitle-provider types, host bindings, and recommended facets; requires catalog-settings permission.

externalImportSetupSecretDraft
ExternalImportSetupSecretDraftPayload

Read the caller-visible external import setup secret draft; requires system-settings management permission.

externalImportSetupSecretDraftStatus
ExternalImportSetupSecretDraftStatusPayload!

Report whether an external import setup secret draft exists and whether the caller owns it.

searchMetadata
[MetadataSearchItemPayload!]!

Search provider metadata for one facet, returning at most 100 results.

Arguments

NameDescription
query
String!

Provider search text.

type
MediaFacetValue!

Facet to search, exposed as the GraphQL type argument.

limit
Int!

Result count, defaulting to 25 and clamped to the range 1 through 100.

language
String!

Metadata language, defaulting to eng.

year
Int

Optional release-year hint passed to the provider.

searchMetadataMulti
MetadataSearchMultiPayload!

Search provider metadata across movie, series, and anime facets.

Arguments

NameDescription
query
String!

Provider search text.

limit
Int!

Result count, defaulting to 25 and clamped to the range 1 through 100.

language
String!

Metadata language, defaulting to eng.

metadataMovie
MetadataMoviePayload!

Fetch one movie metadata record by a supplied identity and language.

Arguments

NameDescription
input
MetadataMovieInput!

Movie identity and optional metadata language, which defaults to eng.

metadataSeries
MetadataSeriesPayload!

Fetch one series metadata record, optionally including its episode list.

Arguments

NameDescription
input
MetadataSeriesInput!

TVDB identity, language, and whether episode metadata should be included, defaulting to true.

calendarEpisodes
[CalendarEpisodePayload!]!

List calendar episodes between two dates, optionally restricted to libraries.

Arguments

NameDescription
startDate
Date!

Start date of the calendar range.

endDate
Date!

End date of the calendar range.

libraryIds
[ID!]

Optional library IDs; omitted, null, or an empty list includes all accessible libraries.

notificationChannels
[NotificationChannelPayload!]!

List notification channels visible to the caller, including provider configuration metadata.

notificationTargets
[NotificationTargetPayload!]!

List notification targets visible to the caller.

notificationSubscriptions
[NotificationSubscriptionPayload!]!

List notification subscriptions visible to the caller.

notificationProviderTypes
[ProviderTypePayload!]!

Return available notification provider types and their configuration fields; requires system-settings permission.

notificationEventTypes
[String!]!

Return notification event types that can be subscribed to; requires system-settings permission.

setupStatus
SetupStatusPayload!

Return whether setup is complete and whether download clients and indexers are configured.

browsePath
[DirectoryEntryPayload!]!

List non-hidden entries under an absolute directory path; requires library-settings read permission.

Arguments

NameDescription
path
String!

Absolute directory path to list; defaults to "/".

includeFiles
Boolean

Include regular files as well as directories; defaults to false; hidden names are excluded.

serviceLogs
ServiceLogsPayload!

Return the most recent buffered service log lines; requires system-settings permission.

Arguments

NameDescription
limit
Int!

Maximum log lines; defaults to 250 and is clamped to 1 through 2000.

externalSubtitles
[ExternalSubtitlePayload!]!

List external subtitles associated with a title ID.

Arguments

NameDescription
titleId
ID!

Title ID whose external subtitles are returned.

externalSubtitleBlocklistEntries
[ExternalSubtitleBlocklistEntryPayload!]!

List external subtitle blocklist entries for one media file ID.

Arguments

NameDescription
mediaFileId
ID!

Media-file ID whose subtitle blocklist entries are returned.

linkedAccounts
[LinkedAccountPayload!]!

List linked external accounts visible to the caller, optionally restricted to a user ID.

Arguments

NameDescription
userId
ID

User ID filter; omitted lists accounts visible to the caller.

externalAccountInvites
[LinkedAccountPayload!]!

List external account invitations visible to the caller.

indexerErrors
IndexerErrorConnectionPayload!

List persisted indexer HTTP errors; requires system-settings management permission.

Arguments

NameDescription
indexerId
ID

Restrict results to one configured indexer.

first
Int

Requested page size from 1 through 100; defaults to 50.

after
String

Opaque cursor returned by a prior indexerErrors page.

indexerError
IndexerErrorDetailPayload

Return one complete persisted indexer HTTP response; requires system-settings management permission.

Arguments

NameDescription
id
ID!

Stable persisted error-event identifier.

Existing download work that prevented a new submission.

Fields

NameDescription
titleId
ID!

Title identity involved in the conflict.

titleName
String!

Current title name.

downloadClientId
ID

Download-client identity, null when the conflict is not tied to a configured client.

downloadClientType
String!

Download-client provider type.

downloadClientItemId
String!

Provider-specific download item identity.

sourceTitle
String

Release title already associated with the conflict, when known.

sourceKind
DownloadSourceKindValue

Release source category, when known.

scope
QueueDownloadScopePayload!

Acquisition scope occupied by the conflicting work.

state
DownloadQueueStateValue

Current queue state, when available.

replaceable
Boolean!

Whether the conflicting work may be replaced.

Result of a release queue request.

Fields

NameDescription
status
QueueDownloadResultStatusValue!

Whether the request was queued or conflicted.

jobId
ID

Background job identity when the request was queued.

titleId
ID!

Title identity receiving the request.

titleName
String!

Current title name.

sourceTitle
String

Queued release title, null when the request conflicted.

sourceKind
DownloadSourceKindValue

Queued release source category, null when unavailable or conflicted.

conflict
QueueDownloadConflictPayload

Conflict details when the request was not queued.

Outcome of grabbing a release with no catalog title behind it.

Fields

NameDescription
downloadId
String!

Download client's own item identity for the submitted download.

clientName
String!

Name of the download client that accepted the release.

sourceTitle
String!

Release name as the indexer announced it.

Recycle-bin enablement setting.

Fields

NameDescription
enabled
Boolean!

Whether deleted media is moved to the recycle bin.

File moved to the recycle bin with its original library context.

Fields

NameDescription
id
ID!

Recycle-bin entry ID.

originalPath
String!

Original absolute or library-relative file path.

fileName
String!

Original file name.

sizeBytes
Long!

File size in bytes.

titleId
ID

Associated title ID, or null when no title was matched.

titleName
String

Associated title name, or null when no title was matched.

reason
String!

Reason the file entered the recycle bin.

recycledAt
DateTime!

Time the file entered the recycle bin in UTC.

scheduledDeletionAt
DateTime!

Time the retention policy schedules this file for permanent deletion in UTC.

mediaRoot
String!

Media root containing the original file.

libraryId
ID!

Library ID containing the original file.

libraryName
String!

Library name containing the original file.

A page of recycle-bin entries and its total matching count.

Fields

NameDescription
items
[RecycledItemPayload!]!

Recycle-bin entries in the requested page.

totalCount
Int!

Total matching entries across all pages.

One destination collision found during restore preview.

Fields

NameDescription
id
ID!

Recycle-bin entry ID.

originalPath
String!

Original path that would be restored.

destinationOccupied
Boolean!

Whether the destination is currently occupied.

Restore preview fingerprint and destination collision details.

Fields

NameDescription
fingerprint
String!

Fingerprint required to confirm the current preview.

items
[RecycleRestorePreviewItemPayload!]!

Preview entries for the selected recycle-bin records.

Plugin registry entry with trust, installation, update, and progress state.

Fields

NameDescription
id
ID!

Registry plugin ID.

name
String!

Plugin name.

description
String!

Plugin description.

version
String!

Registry version.

latestVersion
String

Latest known version, or null when unavailable.

pluginType
String!

Registry classification of the plugin.

providerType
String!

Provider type exposed by the plugin.

author
String!

Publisher or author name.

official
Boolean!

Whether the plugin is official.

publisher
String

Publisher identity, or null when unavailable.

supportTier
String!

Trust or support tier.

status
String

Current registry or installation status, or null when unavailable.

docsUrl
String

Documentation URL, or null when unavailable.

sourceRepo
String

Source repository URL, or null when unavailable.

builtin
Boolean!

Whether the plugin is built into the service.

sourceUrl
String

Download source URL, or null when unavailable.

sourceKind
String

Source kind, or null when unavailable.

blockedReason
String

Trust-block reason, or null when not blocked.

bytes
Long

Artifact size in bytes, or null when unavailable.

isInstalled
Boolean!

Whether the plugin is installed.

isEnabled
Boolean!

Whether the installed plugin is enabled.

installedVersion
String

Installed version, or null when not installed.

updateAvailable
Boolean!

Whether a newer version is available.

installInProgress
Boolean!

Whether install or update work is currently running.

defaultBaseUrl
String

Default provider base URL, or null when not applicable.

Result of clearing metadata before background rehydration.

Fields

NameDescription
language
String!

Language whose metadata was cleared.

titlesCleared
Int!

Number of titles cleared.

A scored release decision associated with a wanted scope.

Fields

NameDescription
id
ID!

Stable release-decision identifier.

wantedItemId
ID!

Identifier of the wanted scope evaluated by the decision.

titleId
ID!

Identifier of the title targeted by the decision.

releaseTitle
String!

Release title evaluated by the matcher.

releaseUrl
String

Release URL, or null when the provider did not supply one.

releaseSizeBytes
Long

Release size in bytes, or null when unavailable.

decisionCode
String!

Machine-readable decision code.

candidateScore
Int!

Candidate score assigned by the scoring rules.

currentScore
Int

The bar this decision was measured against: the re-derived canonical score of the primary media file occupying the scope at decision time, never the persisted acquisition_score. Null when the decision was recorded before any comparison ran (a parse or identity refusal), or when nothing occupied the scope.

scoreDelta
Int

Candidate minus current score, or null when no current score exists.

explanationJson
JSON

Structured scoring explanation, or null when no explanation was stored.

createdAt
DateTime!

Time when the decision was recorded, in UTC.

title
TitlePayload

Title associated with this release decision, or null when it is no longer available to the caller.

wantedItem
WantedItemPayload

Wanted scope evaluated by this decision, or null when it is no longer available to the caller.

A page of release decisions with a total count.

Fields

NameDescription
items
[ReleaseDecisionPayload!]!

Decisions in stable order.

totalCount
Int!

Number of matching decisions across all pages.

hasMore
Boolean!

Whether another page exists after this page.

Accepted rename work and the job run tracking it.

Fields

NameDescription
jobRun
JobRunPayload!

Background job run tracking the rename work.

acceptedTitleIds
[ID!]!

Title IDs accepted for processing.

Persisted download-client configuration order.

Fields

NameDescription
ids
[ID!]!

Download-client identities in stored order.

Requester-side pre-flight: what would happen if this draft were submitted now (FR-020).

Deliberately has no vote table and no input document. A requester sees the outcome, the reasons behind it, and the tags an approval would stamp.

Fields

NameDescription
outcome
RequestDecisionOutcomeValue!

What would actually happen if the draft were submitted now.

reasons
[RequestPreflightReason!]!

Why, in codes with the rule names that produced them.

tags
[String!]!

Tags an approval would stamp on the created title.

metadataPartial
Boolean!

True when the metadata could not be fully established, so the verdict rests on incomplete facts. An unevaluable policy never approves.

evaluationMode
RequestRuleEvaluationModeValue!

Strictest mode among the rules that were consulted.

fallbackReason
String

Why the verdict fell back to needing approval, when it did. One of the arbitration vocabulary's codes (rule_manual, held, error, no_rule_matched), or null when a rule decided outright. It carries no rule internals: it names the shape of the fallback, never a vote.

One reason a decision came out the way it did, in the only form that is safe to show a requester: a stable code and the name of the rule that emitted it. Rule bodies never reach this surface.

Fields

NameDescription
code
String!

Stable reason code the rule emitted.

ruleName
String!

Name of the rule that emitted it.

The durable trace of one request evaluation (FR-016).

policyOutcome is what the rules concluded and effectiveOutcome is what the instance acted on. They disagree on purpose whenever the instance gate is off or every deciding rule is in shadow.

Fields

NameDescription
id
ID

Trace ID, or null for a preview, which persists nothing.

requestId
ID

The media request this decision belongs to, or null for a preview.

evaluatedAt
DateTime!

UTC time the evaluation ran.

mode
RequestRuleEvaluationModeValue!

Strictest mode among the rules that were consulted.

effectiveOutcome
RequestDecisionOutcomeValue!

What actually happened to the request.

policyOutcome
RequestDecisionOutcomeValue!

What the rules concluded, whether or not they were allowed to act.

fallbackReason
String

Why the decision fell back rather than following a rule vote (no_rule_matched, held, error, rule_manual), or null when a rule decided.

votes
[RequestRuleVote!]!

Per-rule votes. Empty for a requester reading their own request's decision, who sees reasons instead.

reasons
[RequestPreflightReason!]!

Reason codes with the rules that emitted them, flattened out of the votes. Safe for every audience, and the only explanation a requester gets.

tags
[String!]!

Tags the rules emitted. Recorded on every path; applied to a title only on an approval.

inputSchemaVersion
Int!

Schema version of the input document the rules were evaluated against.

The instance-wide request-rule gate. One switch, defaulting off: a request rule votes and executes nothing, so there is one blast radius.

Fields

NameDescription
evaluationEnabled
Boolean!

Whether stored request rules are allowed to decide anything. While this is off every evaluation still runs and is recorded, but the effective outcome stays whatever the library permission would have produced.

Author-side preview of one matcher against one hypothetical request.

Nothing is persisted but the trace the evaluation writes, and the caller already holds catalog-settings authority, so this is the one place the whole input document is returned.

Fields

NameDescription
ruleSetId
String!

Stored rule set the preview ran, or the throwaway ID an unsaved draft compiled under.

matcherContentHash
String!

Hash of the exact source that produced this outcome.

decision
RequestRuleDecision!

The single rule's verdict, shaped as a decision so the authoring UI and the decision browser render the same component. effectiveOutcome equals policyOutcome here because a preview is never subject to the instance gate.

metadataPartial
Boolean!

True when the sample's metadata could not be fully established, so some facts were unknown.

undefinedTags
[String!]!

Of the tags the rule emitted, the ones the title tag registry does not define. They are dropped at approval, so an author needs to define them in Settings before the rule can apply them. decision.tags still lists everything the rule emitted.

inputDocument
JSON!

The exact document the rule saw.

One immutable revision of a request rule set’s matcher.

Fields

NameDescription
id
ID!

Revision ID.

ruleSetId
ID!

ID of the rule set this revision belongs to.

revisionNumber
Int!

Revision number, starting at one and incremented on every matcher edit.

regoSource
String!

Rego source as the editor should show it, with the package declaration and the rego.v1 import stripped.

matcherContentHash
String!

Hash of the exact stored source, used to attribute a decision to the revision that produced it.

createdBy
ID

ID of the user who wrote the revision, or null when unattributed.

createdAt
DateTime!

UTC creation time.

A request rule set: identity, scope, and evaluation state. The matcher lives on the revision, never here.

Fields

NameDescription
id
ID!

Rule-set ID.

name
String!

Rule-set name.

description
String!

Rule-set description; empty when the author supplied none.

enabled
Boolean!

Whether the rule set is enabled. Derived from evaluationMode rather than set independently: false for DISABLED, true otherwise.

evaluationMode
RequestRuleEvaluationModeValue!

Evaluation mode currently stored for the rule set.

libraryIds
[String!]!

Libraries the rule is confined to. Empty means every library.

currentRevisionNumber
Int!

Revision number of the matcher currently in force.

decisionCount
Int!

How many recorded decisions this rule took part in. Traces outlive the rule that produced them, so this can be non-zero for a rule that is now disabled.

createdAt
DateTime!

UTC creation time.

updatedAt
DateTime!

UTC last-update time.

A rule set together with the revision currently in force.

Fields

NameDescription
ruleSet
RequestRuleSet!

The rule set itself.

revision
RequestRuleRevision!

The revision currently in force.

Result of validating request rule source without saving it.

Fields

NameDescription
valid
Boolean!

Whether the source is valid.

errors
[String!]!

Validation errors; empty when valid.

One rule’s recorded vote inside a decision trace.

vote is null exactly when error is set: a rule that failed produced no vote, and rendering that as an abstain would say the rule looked and had no opinion.

Fields

NameDescription
ruleSetId
ID!

Rule set that voted.

ruleSetName
String!

That rule set's name as it was when the vote was cast. Recorded on the trace, so it survives the rule being renamed or deleted.

revisionNumber
Int!

Revision that voted.

vote
RequestVoteValue

The vote, or null when the rule failed.

held
Boolean!

True when Scryer held the rule because a fact it reads was unobservable, rather than the author writing manual. Both arbitrate identically.

reasonCodes
[String!]!

Reason codes the rule emitted.

tags
[String!]!

Tags the rule emitted.

error
String

Why the rule failed, or null when it did not.

Result of resolving a pending import to a title.

Fields

NameDescription
title
TitlePayload!

Title created or reused for the pending import.

created
Boolean!

Whether the operation created a new title.

libraryScan
LibraryScanSummaryPayload

Library scan summary, or null when no scan was accepted or run.

metadataHydrationState
AddTitleHydrationStateValue!

Metadata processing outcome for the resolved title.

Reports the backup contents staged for restoration on restart.

Fields

NameDescription
summary
RestoreSummaryPayload!

Backup contents and source metadata accepted for restoration.

Identifies a staged restore upload and its inspected contents.

Fields

NameDescription
uploadId
ID!

Temporary restore upload ID used by the apply operation.

summary
RestoreSummaryPayload!

Inspected backup contents and source metadata.

Accepted request to restore one recycle-bin entry.

Fields

NameDescription
id
ID!

Recycle-bin entry ID.

jobRun
JobRunPayload!

Background job accepted for the restore operation.

Accepted background restore for multiple recycle-bin entries.

Fields

NameDescription
ids
[ID!]!

Recycle-bin entry IDs accepted for restore.

jobRun
JobRunPayload!

Background job accepted for the restore operation.

Summarizes the contents and source compatibility metadata of a backup bundle.

Fields

NameDescription
formatVersion
String!

Backup bundle format version.

createdAt
DateTime!

UTC timestamp when the backup bundle was created.

sourceScryerVersion
String!

Scryer version that created the backup.

sourceEngine
String!

Datastore engine used by the source instance.

sourceMigrationKey
String

Source database migration key; null when the bundle does not provide one.

encrypted
Boolean!

Whether the backup contents are encrypted.

rowCounts
[BackupRowCountPayload!]!

Row counts grouped by backed-up entity.

totalRows
Long!

Total rows contained in the backup.

Result of asking an interrupted operation to pick up from its checkpoints.

Fields

NameDescription
id
ID!

Operation the resume or retry was requested for.

resumed
Boolean!

Whether the operation was picked back up. A failed or canceled operation is reopened and retried from its last verified checkpoint; a finished one is never restarted.

detail
String

Why it was not picked back up, when it was not.

Identifier returned after resuming a wanted state row or convergence scope.

Fields

NameDescription
id
ID!

State-row ID or convergence scope key that was resumed.

Revocation result for a user-owned API key.

Fields

NameDescription
id
ID!

ID of the revoked key.

revoked
Boolean!

Whether the active key was revoked.

Result of revoking an OAuth grant.

Fields

NameDescription
grantId
ID!

Grant ID targeted by the revoke request.

revoked
Boolean!

False when the grant was already revoked or was not owned by the caller.

Root-folder path and default marker.

Fields

NameDescription
path
String!

Filesystem path.

isDefault
Boolean!

Whether this is the default root folder.

Counts produced by one RSS synchronization pass.

Fields

NameDescription
releasesFetched
Int!

Number of releases fetched from feeds.

releasesMatched
Int!

Number of fetched releases matched to known titles.

releasesGrabbed
Int!

Number of matched releases accepted for grabbing.

releasesHeld
Int!

Number of matched releases held instead of grabbed.

Rule-pack registry entry.

Fields

NameDescription
id
String!

Registry rule-pack ID.

name
String!

Rule-pack name.

description
String!

Rule-pack description.

author
String!

Rule-pack author.

version
String!

Rule-pack version.

customizable
Boolean!

Whether rules from the pack may be copied into user-authored rules.

Template supplied by a rule pack.

Fields

NameDescription
id
String!

Template ID.

title
String!

Template title.

description
String!

Template description.

category
String!

Template category.

regoSource
String!

Rego source for the template.

appliedFacets
[String!]!

Facets to which the template applies.

defaultEnabled
Boolean!

Whether the pack recommends enabling the template.

Rego rule set configuration and managed-pack metadata.

Fields

NameDescription
id
ID!

Rule-set ID.

name
String!

Rule-set name.

description
String!

Rule-set description.

regoSource
String!

Rego source used for validation and evaluation.

enabled
Boolean!

Whether the rule set is enabled.

priority
Int!

Evaluation priority.

evaluationPhase
String!

Baseline rules establish the subtotal read by additional rules.

disabledReason
String

Why a retained rule was disabled during a context migration.

exclusiveGroup
String

Other rules with this group cannot be enabled simultaneously.

appliedFacets
[String!]!

Media facets to which the rule set applies.

isManaged
Boolean!

Whether the rule set is managed by a trusted pack.

managedKey
String

Managed-pack key, or null for user-authored rules.

managedTagFilter
[String!]

Tags a managed pack is narrowed to. Null means it applies wherever its facts match. Always null for user-authored rule sets.

createdAt
DateTime!

UTC creation time.

updatedAt
DateTime!

UTC last-update time.

Title and library facts resolved for a rule-set scoring preview.

Fields

NameDescription
titleName
String!

Resolved title name.

libraryName
String

Resolved library name, or null when unavailable.

facet
String!

Resolved media facet.

language
String

Resolved original language, or null when unavailable.

tags
[String!]!

Resolved title tags.

episodeLabel
String

Resolved episode label, or null for whole-title previews.

Current editor draft’s contribution to a scoring preview.

Fields

NameDescription
score
Int!

Signed score contribution from the draft.

matched
Boolean!

Whether the draft matched the candidate facts.

blocked
Boolean!

Compatibility field, always false: drafts emit recoverable numeric contributions.

applies
Boolean!

Whether the draft applies to the selected title facet.

enabled
Boolean!

Whether the draft is enabled.

message
String

Explanation for a disabled or non-applicable draft, or null when none.

One numeric contribution or explicit rejection in a scoring preview.

Fields

NameDescription
code
String!

Stable explanation code; the code does not determine rejection type.

delta
Int!

Signed score delta associated with the entry.

blocked
Boolean!

Whether this is an explicit rejection, as identified by kind.

kind
String!

score_contribution, mandatory_rejection, or final_score_rejection.

A validation or evaluation error retained by a scoring preview.

Fields

NameDescription
code
String!

Stable error classification.

message
String!

Human-readable error detail.

ruleSetId
String

Rule-set identity associated with the error, or null when global.

Release facts parsed for a rule-set scoring preview.

Fields

NameDescription
releaseGroup
String

Parsed release group, or null when unknown.

quality
String

Parsed quality, or null when unknown.

source
String

Parsed release source, or null when unknown.

season
String

Season parsed from the release name, or null when absent.

episode
String

Episode parsed from the release name, or null when absent.

edition
String

Parsed edition, or null when unknown.

videoCodec
String

Parsed video codec, or null when unknown.

audio
String

Parsed audio codec, or null when unknown.

year
Int

Parsed release year, or null when unknown.

audioLanguages
[String!]!

Parsed audio-language codes.

sizeBytes
Long

Release size in bytes, or null when the caller omitted it.

One rule-set’s contribution to a title-aware scoring preview.

Fields

NameDescription
ruleSetId
String

Stable rule-set identity.

ruleSetName
String!

Rule-set display name.

origin
String!

Existing policy origin.

score
Int!

Signed score contribution.

matched
Boolean!

Whether this rule set matched the candidate facts.

blocked
Boolean!

Whether this group contains an explicit rejection. Numeric penalties are recoverable.

isDraft
Boolean!

Whether this entry represents the current editor draft.

entries
[RuleSetTestEntryPayload!]!

Individual numeric contributions and explicit rejection reasons.

messages
[String!]!

Evaluation messages and diagnostics for this rule set.

Result of validating Rego source.

Fields

NameDescription
valid
Boolean!

Whether the source is valid.

errors
[String!]!

Validation errors; empty when valid.

Runtime path information used by clients interpreting filesystem values.

Fields

NameDescription
runtimePathStyle
RuntimePathStyleValue!

Path syntax used by the running service.

Result of saving an external import secret draft.

Fields

NameDescription
overwroteAnotherUserDraft
Boolean!

Whether another user's existing draft was replaced.

updatedAt
DateTime!

Save time in UTC.

One scoring rule contribution used in a quality decision.

Fields

NameDescription
code
String!

Stable scoring rule code.

delta
Int!

Signed score delta contributed by the rule.

kind
String!

score_contribution, mandatory_rejection, or final_score_rejection.

source
String!

Source of the scoring rule.

ruleSetName
String

Rule-set name, or null when not associated with a named set.

Optional boolean scoring overrides for quality evaluation.

Fields

NameDescription
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.

Secret provider configuration value represented without plaintext.

Fields

NameDescription
stored
Boolean!

True when a secret is stored; false means absent or cleared.

Security settings and effective environment overrides.

Fields

NameDescription
formLoginEnabled
Boolean!

Whether form-based login is enabled by configuration.

sessionDurationDays
Int!

Instance-wide lifetime of new sign-in sessions, in days.

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 configuration changes require MFA step-up.

mfaRequirePasswordLogin
Boolean!

Whether password login is required alongside MFA.

mfaRequireJellyfinLogin
Boolean!

Whether Jellyfin login requires an enrolled authentication factor.

mfaRequireEmbyLogin
Boolean!

Whether Emby login requires an enrolled authentication factor.

totpRequireJellyfinLogin
Boolean!
Deprecated: Use mfaRequireJellyfinLogin.

Deprecated alias for mfaRequireJellyfinLogin.

totpRequireEmbyLogin
Boolean!
Deprecated: Use mfaRequireEmbyLogin.

Deprecated alias for mfaRequireEmbyLogin.

effectiveFormLoginEnabled
Boolean!

Effective form-login state after environment overrides.

envOverrideActive
Boolean!

Whether an environment override is active.

envOverrideDescription
String

Description of the active override, or null when none is active.

Named torrent seeding policy assignable to indexers, routing entries, or the global default.

Fields

NameDescription
id
ID!

Seeding profile ID.

name
String!

Seeding profile name.

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.

seasonPackRatio
Float

Season-pack share ratio goal, or null when unset.

seasonPackSeedTimeMinutes
Int

Season-pack seed time goal in minutes, or null when unset.

honorTrackerMinimums
Boolean!

Whether resolved goals are raised to tracker-declared minimums.

goalMetAction
SeedGoalMetActionValue!

Action taken once the seeding goal is met.

neverRemove
Boolean!

Whether torrents grabbed under this profile are never auto-removed.

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 grabbed under this profile after import.

createdAt
DateTime!

UTC creation time.

updatedAt
DateTime!

UTC last-update time.

A movie’s placement and continuity metadata within a series.

Fields

NameDescription
id
ID!

Stable series-movie link identifier.

movie
MovieEntityPayload!

Movie metadata referenced by this link.

narrativeOrder
String

Narrative position within the series, or null when unknown.

afterSeason
Int

Season after which the movie is placed, or null when not applicable.

beforeSeason
Int

Season before which the movie is placed, or null when not applicable.

linkedEpisodeId
ID

Linked episode identifier, or null when this link has no episode anchor.

continuityStatus
String

Continuity classification, or null when not determined.

movieForm
String

Form of the movie in the series chronology, or null when not determined.

signalSummary
String

Short explanation of the placement signals, or null when unavailable.

monitoringOverride
Boolean

Explicit operator monitoring choice, or null when title policy manages this link.

metadataActive
Boolean!

Whether current metadata still reports this series-movie relationship.

monitored
Boolean!

Whether acquisition and monitoring are enabled for this link.

tags
[String!]!

User tags applied to this series movie. Defined in the title-tag registry and stored on the link, not on the series title.

Union member identifying a series-movie relationship by ID.

Fields

NameDescription
seriesMovieLinkId
ID!

Target series-movie link ID.

Snapshot of the in-memory service log buffer.

Fields

NameDescription
generatedAt
DateTime!

UTC time when the snapshot was generated.

lines
[String!]!

Log lines returned, newest or oldest order as defined by the service buffer.

count
Int!

Number of returned lines.

TLS certificate and private-key paths used by the service.

Fields

NameDescription
tlsCertPath
String!

Filesystem path to the TLS certificate.

tlsKeyPath
String!

Filesystem path to the TLS private key.

Result of changing a collection’s monitored state.

Fields

NameDescription
id
ID!

Identifier of the collection that was updated.

monitored
Boolean!

The resulting monitored state.

episodes
[EpisodePayload!]!

Episodes in the collection after the monitoring change.

Result of setting a title’s required-audio-language override.

Fields

NameDescription
titleId
ID!

Target title ID.

facet
MediaFacetValue!

Title media facet.

languages
[String!]

Effective override languages; null means inherited behavior.

updated
Boolean!

Whether the stored value changed.

Current setup prerequisites and completion state.

Fields

NameDescription
setupComplete
Boolean!

Whether initial setup has been completed.

hasDownloadClients
Boolean!

Whether at least one download client is configured.

hasIndexers
Boolean!

Whether at least one indexer is configured.

Available Scryer update information.

Fields

NameDescription
available
Boolean!

Whether a newer version is available.

currentVersion
String!

Currently running version.

latestVersion
String!

Latest available version.

latestTag
String!

Latest release tag.

releaseUrl
String

Release URL, or null when unavailable.

publishedAt
DateTime

UTC publication time, or null when unavailable.

checkedAt
DateTime!

UTC time when the check completed.

Compatibility result comparing the connected SMG version with requirements.

Fields

NameDescription
status
String!

Compatibility status string.

minimumVersion
String!

Minimum supported SMG version.

yourVersion
String!

Connected SMG version.

message
String!

Human-readable compatibility message.

upgradeDeadline
String

Optional UTC deadline for upgrading.

Acceptance of a confirmed location operation; the work runs in the background.

Fields

NameDescription
operation
LocationOperationPayload!

The accepted operation, as persisted.

planFingerprint
String!

Fingerprint of the plan the server rebuilt and accepted.

Filesystem usage of the volume backing one library root folder.

Fields

NameDescription
path
String!

Configured root-folder path as stored on the library.

libraryId
ID!

ID of the library that owns this root folder.

libraryName
String!

Name of the library that owns this root folder.

facet
MediaFacetValue!

Media facet of the library that owns this root folder.

usedBytes
Long

Bytes in use on the backing filesystem; null when it cannot be inspected.

totalBytes
Long

Total bytes on the backing filesystem; null when it cannot be inspected.

Stored string provider configuration value.

Fields

NameDescription
value
String!

String value.

Result containing the ID of the submitted or deduplicated request.

Fields

NameDescription
requestId
ID!

ID of the submitted or deduplicated media request.

Fields

NameDescription
locationTransferSummary
LocationTransferSnapshotPayload!

Arguments

NameDescription
id
ID!
locationTransferPage
LocationTransferSnapshotPayload!

Arguments

NameDescription
id
ID!
offset
Int!
locationTransferFiles
LocationTransferSnapshotPayload!

Arguments

NameDescription
id
ID!
titleId
ID!
offset
Int!
activityEvents
ActivityEventPayload!
domainEventFeed
DomainEventEnvelopePayload!

Arguments

NameDescription
afterSequence
Long
downloadQueueSync
DownloadQueueSyncPayload!
activeImportStreamsSync
ActiveImportStreamSyncPayload!

Notify clients when queued or active import streams change.

downloadQueue
[DownloadQueueItemPayload!]!
Deprecated: use downloadQueueSync

Arguments

NameDescription
includeAllActivity
Boolean
includeHistoryOnly
Boolean
includeImportActivity
Boolean
titleId
ID
activityFilter
DownloadActivityFilterValue
libraryScanState
LibraryScanProgressPayload!
jobRunEvents
JobRunPayload!
serviceLogLines
String!
importHistoryChanged
Boolean!
mediaRequestsChanged
MediaRequestChangedPayload!
indexersChanged
Boolean!
providerCatalogChanged
[ProviderCatalogFamilyValue!]!
pluginInstallProgress
PluginInstallProgressPayload!

Arguments

NameDescription
pluginId
ID!
externalImportMonitorWarmupProgress
ExternalImportMonitorWarmupProgressPayload!

Arguments

NameDescription
sessionId
ID!
settingsChanged
[String!]!

Subtitle language preference with hearing-impaired and forced flags.

Fields

NameDescription
code
String!

Language code.

hearingImpaired
Boolean!

Whether hearing-impaired subtitles are preferred.

forced
Boolean!

Whether forced subtitles are preferred.

Subtitle-provider configuration and health state without exposing secret values.

Fields

NameDescription
id
ID!

Subtitle-provider configuration ID.

name
String!

Provider configuration name.

providerType
String!

Subtitle-provider type identifier.

hasConfig
Boolean!

Whether provider configuration exists.

storedSecretKeys
[String!]!

Names of stored secret fields, never their values.

enabledFacets
[MediaFacetValue!]!

Media facets enabled for this provider.

isEnabled
Boolean!

Whether the provider is enabled.

lastHealthStatus
String

Most recent health status, or null before the first check.

lastError
String

Most recent error, or null when none is recorded.

lastErrorAt
DateTime

UTC time of the most recent error, or null when none is recorded.

disabledUntil
DateTime

UTC time until which the provider is disabled, or null when not disabled.

createdAt
DateTime!

UTC creation time.

updatedAt
DateTime!

UTC last-update time.

Reports one subtitle search: what was searched, what the caller may search next, and the provider matches found.

Fields

NameDescription
status
SubtitleSearchStatus!

Why the search returned these results.

language
String!

Language code that was actually searched; the requested language when one was given, otherwise the administrator's preferred language.

availableLanguages
[String!]!

Subtitle languages an administrator configured, in configured order, for the language picker.

results
[SubtitleSearchResult!]!

Provider matches found for the searched language; empty unless the status is READY.

Describes a subtitle provider result and its match characteristics.

Fields

NameDescription
provider
String!

Provider that returned the subtitle.

providerFileId
String!

Provider-specific subtitle file ID used for download.

language
String!

Subtitle language code.

releaseInfo
String

Provider release information; null when unavailable.

score
Int!

Raw subtitle match score.

scorePercent
Int!

Match score normalized to a percentage.

hearingImpaired
Boolean!

Whether the subtitle includes hearing-impaired cues.

forced
Boolean!

Whether the subtitle is intended only for forced dialogue.

aiTranslated
Boolean!

Whether the subtitle was translated with generative AI.

machineTranslated
Boolean!

Whether the subtitle was machine translated.

uploader
String

Provider uploader name; null when unavailable.

downloadCount
Int

Provider-reported download count; null when unavailable.

hashMatched
Boolean!

Whether the subtitle matched the media file hash.

Effective subtitle search, download, and synchronization settings.

Fields

NameDescription
enabled
Boolean!

Whether subtitle processing is enabled.

languages
[SubtitleLanguagePreferencePayload!]!

Ordered subtitle language preferences.

autoDownloadOnImport
Boolean!

Whether subtitles are downloaded automatically after import.

minimumScoreSeries
Int!

Minimum subtitle score for series, on the provider score scale.

minimumScoreMovie
Int!

Minimum subtitle score for movies, on the provider score scale.

searchIntervalHours
Int!

Search interval in hours.

includeAiTranslated
Boolean!

Whether AI-translated subtitles are eligible.

includeMachineTranslated
Boolean!

Whether machine-translated subtitles are eligible.

syncEnabled
Boolean!

Whether subtitle synchronization is enabled.

syncThresholdSeries
Int!

Synchronization threshold for series, on the provider score scale.

syncThresholdMovie
Int!

Synchronization threshold for movies, on the provider score scale.

syncMaxOffsetSeconds
Int!

Maximum subtitle offset correction in seconds.

Subtitle stream metadata for a media file.

Fields

NameDescription
codec
String

Codec name, or null when unavailable.

language
String

Language code, or null when unavailable.

name
String

Stream name, or null when unavailable.

forced
Boolean!

Whether the subtitle is forced.

default
Boolean!

Whether the subtitle is the default stream.

Current service health and catalog counters.

Fields

NameDescription
serviceReady
Boolean!

Whether the service is ready to accept work.

dbPath
String!

Configured database path.

datastoreEngine
String!

Datastore engine name.

datastoreMigrationKey
String

Datastore migration key, or null when unavailable.

runtimePathStyle
RuntimePathStyleValue!

Runtime path syntax.

totalTitles
Int!

Total title count across facets.

monitoredTitles
Int!

Number of monitored titles.

totalUsers
Int!

Total user count.

titlesMovie
Int!

Movie title count.

titlesSeries
Int!

Series title count.

titlesAnime
Int!

Anime title count.

titlesOther
Int!

Titles outside the named facets.

recentEvents
Int!

Number of recent events included in the preview window.

recentEventPreview
[String!]!

Recent event preview messages in source order.

dbMigrationVersion
String

Datastore migration version, or null when unavailable.

indexerStats
[IndexerQueryStatsPayload!]!

Query statistics for configured indexers.

Explicit, read-only scoring preview for the current rule-editor draft.

Fields

NameDescription
score
Int!

Aggregate score after normal policy aggregation.

allowed
Boolean!

Whether mandatory requirements and both final score gates pass.

blocked
Boolean!

Whether the completed decision is rejected by a requirement or score gate.

minimumScoreMet
Boolean!

Whether the configured minimum-score gate passed.

profileName
String!

Resolved quality-profile name.

context
RuleSetTestContextPayload!

Resolved title, library, and episode context.

parsed
RuleSetTestParsedPayload!

Parsed release facts preserved from the supplied release name.

ruleSets
[RuleSetTestRuleSetPayload!]!

Contributions grouped by policy rule set.

draftContribution
RuleSetTestDraftContributionPayload!

Dedicated explanation of the current draft's contribution.

errors
[RuleSetTestErrorPayload!]!

Validation and evaluation errors retained by the preview.

Acquisition diagnostics for a title, including decisions and state counts.

Fields

NameDescription
recentDecisions
[ReleaseDecisionPayload!]!

Recent release decisions, newest first.

decisionCounts
[DecisionCodeCountPayload!]!

Counts grouped by release decision code.

wantedStatusCounts
[WantedStatusCountPayload!]!

Counts grouped by wanted status.

pendingReleaseCounts
[PendingReleaseStatusCountPayload!]!

Counts grouped by pending-release status.

mismatchRecoveryEligibleCount
Int!

Number of scopes eligible for mismatch-recovery search.

latestDecisionAt
DateTime

Time of the latest release decision in UTC, or null when none exists.

latestWantedSearchAt
DateTime

Time of the latest wanted search in UTC, or null when none exists.

Counts for common title catalog filter facets.

Fields

NameDescription
all
Int!

Number of matching titles before the facet is applied.

monitored
Int!

Number of matching monitored titles.

unmonitored
Int!

Number of matching unmonitored titles.

continuing
Int!

Number of matching continuing titles.

ended
Int!

Number of matching ended titles.

Available canonical tag filters and the observed release-year range.

Fields

NameDescription
genres
[CanonicalTagFilterOptionPayload!]!

Genre tag options available to the current catalog scope.

themes
[CanonicalTagFilterOptionPayload!]!

Theme tag options available to the current catalog scope.

minimumYear
Int

Lowest observed release year, or null when no title has a year.

maximumYear
Int

Highest observed release year, or null when no title has a year.

A page of catalog titles with counts and managed storage usage.

Fields

NameDescription
items
[TitlePayload!]!

Titles in the requested page, in the requested stable sort order.

hasMore
Boolean!

Whether another page exists after the current page.

totalCount
Int!

Number of titles matching the filters across all pages.

filterCounts
TitleCatalogFilterCountsPayload!

Counts for the standard monitored and content-status facets.

managedBytes
Long!

Total managed media bytes represented by the matching catalog scope.

One hold on one title.

Fields

NameDescription
id
ID!

Claim ID.

titleId
ID!

Title the claim holds.

libraryId
ID!

Library that title belongs to.

producer
LifecycleClaimProducerValue!

What produced the claim.

producerRef
String

The producing media request's ID, or null for an operator pin.

kind
LifecycleClaimKindValue!

What the claim holds.

state
LifecycleClaimStateValue!

Current lifecycle state.

durationDays
Int

Requested window in days for a retention claim; null for a keep.

startsAt
DateTime

When the claim started running, which is the title's first import. Null while dormant.

expiresAt
DateTime

When the window closes. Null while dormant and for a keep.

createdBy
ID

ID of the user the claim is attributed to, or null when unattributed.

createdAt
DateTime!

UTC creation time.

updatedAt
DateTime!

UTC last-update time.

releasedReason
String

Why the claim was released or converted; kept as history, never cleared.

One cast or crew credit cached from the title’s last metadata hydration.

Fields

NameDescription
kind
String!

Credit kind exactly as the metadata provider spelled it, e.g. actor, voice_actor, director, writer, creator, composer. Kept as a string so a new provider kind reaches clients without a schema break.

personName
String!

Person's display name in the hydration language.

personOriginalName
String!

Person's name in their original language, or empty when the provider has none.

personImageUrl
String

Proxied portrait for this person, or null when the provider has no image.

character
String!

Character played, or empty for crew credits.

language
String!

Language tag this credit was hydrated in, or empty when the provider has none.

billingOrder
Int!

Provider billing rank; lower sorts closer to top billing.

episodeCount
Int

Episodes this person appears in, or null for titles the provider does not count.

One external rating source and its normalized score.

Fields

NameDescription
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.

One event in a title’s acquisition and file history.

Fields

NameDescription
id
ID!

History event ID.

titleId
ID

Title ID associated with the event, or null when the event has no catalog title behind it: an unlinked grab is recorded against the release and the indexer, with no catalog title behind it (FR-026).

titleName
String

Title name, or null when no name was available.

posterUrl
String

Poster URL of the title, or null when the title is gone or has no poster.

libraryId
ID

Library owning the title, or null when the event cannot be attributed.

facet
MediaFacetValue

Media facet, or null when the event is not facet-specific.

sizeBytes
Long

Bytes imported or upgraded; null for other event types and for events recorded before sizes were captured.

episodeId
ID

Episode ID, or null when not episode-specific.

episodeIds
[ID!]!

Episode IDs affected by the event.

collectionId
ID

Collection ID, or null when not collection-specific.

eventType
String!

Stable domain event code represented by this history row.

actorKind
ActorKindValue

Kind of actor that caused the event, or null when unknown.

actorUserId
ID

Acting user ID, or null for non-user actors.

actorDisplayName
String

Acting user display name, or null when unavailable.

sourceTitle
String

Title as supplied by the source, or null when unavailable.

displayTitle
String

Display title recorded for the event, or null when unavailable.

sourceSystem
String

Source system name, or null when unavailable.

sourceRef
String

Source reference, or null when unavailable.

sourceProvider
String

Source provider, or null when unavailable.

sourceHint
String

Download source locator associated with the event, or null when unavailable.

quality
String

Quality label, or null when unavailable.

downloadId
String

Download identity, or null when unavailable.

clientId
ID

Download client ID, or null when unavailable.

clientName
String

Download client name, or null when unavailable.

importId
ID

Import job ID, or null when unavailable.

skipReason
String

Skip reason, or null when the event was not skipped.

retryRequiresPassword
Boolean!

Whether retrying requires a password.

failureReason
String

Failure reason, or null when the event did not fail.

blocklistReason
String

Blocklist reason, or null when the event was not blocklisted.

sourcePath
String

Source file path, or null when unavailable.

destPath
String

Destination file path, or null when unavailable.

dataJson
JSON

Additional event data as JSON, or null when absent.

occurredAt
DateTime!

Time the event occurred in UTC.

createdAt
DateTime!

Time the event record was created in UTC.

A page of title history events and pagination state.

Fields

NameDescription
items
[TitleHistoryEventPayload!]!

Events in the requested page.

totalCount
Int!

Total matching events across all pages.

hasMore
Boolean!

Whether more matching events exist after this page.

A title media file with raw scan data and parsed acquisition metadata.

Fields

NameDescription
analysis
MediaAnalysisDetailsPayload!

Versioned analysis retained from the last successful inspection.

analysisAttempt
MediaAnalysisAttemptPayload

Latest probe attempt, including failures that did not replace successful metadata.

id
ID!

Stable media file identifier.

titleId
ID!

Identifier of the title owning this file.

episodeId
ID

Identifier of the episode represented by this file, or null for title-level media.

seriesMovieLinkIds
[ID!]!

Identifiers of series-movie links represented by this file, or an empty list when none are associated.

filePath
String!

Absolute path to the media file.

sizeBytes
Long!

File size in bytes.

role
String!

File role, such as primary or additional media.

qualityLabel
String

Human-readable quality label, or null before quality is known.

scanStatus
String!

Raw media scan state; analysis fields remain null until scanning completes.

createdAt
DateTime!

Time when the file record was created, in UTC.

videoCodec
String

Codec discovered by media analysis, or null until a scan supplies it.

videoWidth
Int

Video width in pixels, or null until a scan supplies it.

videoHeight
Int

Video height in pixels, or null until a scan supplies it.

videoBitrateKbps
Int

Video bitrate in kilobits per second, or null until a scan supplies it.

videoBitDepth
Int

Video bit depth in bits per channel, or null until a scan supplies it.

videoHdrFormat
String

HDR format reported by the scan, or null when absent or not scanned.

videoFrameRate
String

Video frame rate as a source-formatted string, or null until known.

videoProfile
String

Codec profile reported by the scan, or null until known.

audioCodec
String

Audio codec reported by the scan, or null until known.

audioChannels
Int

Number of audio channels, or null until known.

audioBitrateKbps
Int

Audio bitrate in kilobits per second, or null until known.

audioLanguages
[String!]!

Language codes reported for audio streams.

audioStreams
[AudioStreamDetailPayload!]!

Detailed audio streams reported by the scan.

subtitleLanguages
[String!]!

Language codes reported for subtitle streams.

subtitleCodecs
[String!]!

Codec names reported for subtitle streams.

subtitleStreams
[SubtitleStreamDetailPayload!]!

Detailed subtitle streams reported by the scan.

hasMultiaudio
Boolean!

Whether the file contains multiple audio streams.

durationSeconds
Int

Media duration in seconds, or null until known.

numChapters
Int

Number of chapters, or null until known.

containerFormat
String

Container format, or null until known.

sceneName
String

Parsed scene or release name, or null when import metadata is unavailable.

releaseGroup
String

Parsed release group, or null when unavailable.

sourceType
String

Parsed source type, or null when unavailable.

resolution
String

Parsed resolution label, or null when unavailable.

videoCodecParsed
String

Parsed video codec label, or null when unavailable.

audioCodecParsed
String

Parsed audio codec label, or null when unavailable.

acquisitionScore
Int

Acquisition score assigned during release matching, or null when not scored.

scoringLog
String

Structured scoring explanation, or null when no scoring record exists.

indexerSource
String

Indexer or provider that supplied the release, or null when unknown.

grabbedReleaseTitle
String

Release title that was grabbed, or null when the file was not acquired from a release.

grabbedAt
DateTime

Time when the release was grabbed, in UTC, or null when not recorded.

edition
String

Parsed edition label, or null when unavailable.

originalFilePath
String

File path before import moved or renamed the file, or null when not recorded.

releaseHash
String

Release identity hash, or null when unavailable.

title
TitlePayload

Parent title for this media file, or null if it is no longer available to the caller.

episode
EpisodePayload

Episode represented by this file, or null for title-level media.

Catalog metadata, monitoring settings, and media identity for a title.

Fields

NameDescription
id
ID!

Stable title identifier.

libraryId
ID!

Identifier of the library containing this title.

name
String!

Display title from the catalog metadata.

facet
MediaFacetValue!

Media facet that determines the title's domain, such as movie or series.

monitored
Boolean!

Whether acquisition and monitoring are enabled for the title.

tags
[String!]!

User-defined tags plus reserved scryer: settings entries.

externalIds
[ExternalIdPayload!]!

External catalog identifiers attached to the title.

createdAt
DateTime!

Time when the title record was created, in UTC.

year
Int

Release year, when catalog metadata supplies one.

overview
String

Plot or synopsis text, or null before metadata provides it.

posterUrl
String

Proxied poster URL, or null when no poster source is available.

posterSourceUrl
String

Poster source URL exposed alongside poster_url, or null when unavailable.

backgroundUrl
String

Proxied background URL, or null when no background source is available.

backgroundSourceUrl
String

Background source URL exposed alongside background_url, or null when unavailable.

sortTitle
String

Normalized title used for ordering, or null when not computed.

slug
String

Stable URL-friendly title key, or null when not assigned.

imdbId
String

IMDb identifier, or null when the title has no IMDb match.

runtimeMinutes
Int

Runtime in minutes, or null when unknown.

popularity
Float

Catalog popularity score, or null when unavailable.

canonicalTags
[CanonicalMediaTagPayload!]!

Canonical genre and theme tags resolved from source metadata.

contentStatus
String

Catalog content status, or null before metadata provides it.

language
String

Original content language code, or null when unknown.

firstAired
Date

First air date as a calendar date, or null when unavailable.

network
String

Broadcasting network, or null when unknown.

studio
String

Production studio, or null when unknown.

country
String

Production country, or null when unknown.

aliases
[String!]!

Alternate title strings from catalog metadata.

metadataLanguage
String

Language used for the latest metadata fetch, or null when not recorded.

metadataFetchedAt
DateTime

Time of the latest metadata fetch in UTC, or null before a fetch completes.

qualityProfileId
ID

Identifier of the selected quality profile, or null when the title uses no profile.

rootFolderId
ID!

Identifier of the root folder that stores this title's files.

monitorType
MonitorTypeValue

Monitoring mode, or null when no explicit mode is configured.

useSeasonFolders
Boolean

Whether episodic files use season directories, or null when unset.

monitorSpecials
Boolean

Whether specials are monitored, or null when unset.

interSeasonMovies
Boolean

Whether movies between seasons are included, or null when unset.

fillerPolicy
FillerPolicyValue

Policy for filler episodes, or null when unset.

recapPolicy
RecapPolicyValue

Policy for recap episodes, or null when unset.

releaseNumbering
ReleaseNumberingValue

Which episode numbering this title's releases are read in, or null when the title follows the default (AUTO).

playbackLinks
[MediaServerPlaybackLinkPayload!]!

Provider-native playback links for this title, when an exact catalog mapping exists.

qualityTier
String

Effective target quality-profile label for the title.

currentQualityTier
String

Lowest live media-file quality tier for the title.

sizeBytes
Long

Aggregated media-file size in bytes for the title.

episodesOwned
Int

Owned-vs-total episode progress, excluding specials.

episodesMonitored
Int

Monitored episode count, excluding specials.

episodesTotal
Int

Total episode count, excluding specials.

mediaResolution
String

Primary movie media resolution.

mediaHdr
String

Primary movie media HDR format.

mediaAudioCodec
String

Primary movie media audio codec.

libraryName
String

Name of the title's library when it is visible to the caller, otherwise null.

librarySlug
String

Stable slug of the title's caller-visible library, otherwise null.

ratings
TitleRatingPayload!

Aggregated title ratings; the rating is null and source lists are empty when no rating exists.

credits
[TitleCreditPayload!]!

Cast and crew cached from this title's last metadata hydration, ordered by billing rank. Reads the local cache only; hydration refills it.

Arguments

NameDescription
kinds
[String!]

Credit kinds to include, e.g. ["actor", "voice_actor"] for cast. Omit or leave empty for every cached kind.

limit
Int!

Maximum credits to return; defaults to 15 and clamps to 0 through 50.

moreLikeThis
[DiscoveryItemPayload!]!

Discovery items related to this title, limited to the requested count.

Arguments

NameDescription
limit
Int!

Maximum related items to return; defaults to 12 and clamps to 0 through 100.

rootFolderPath
String!

Absolute root-folder path for this title; requires view permission on its library.

renameEnabled
Boolean!

Whether renaming is turned on for this title's media type. Rename preview and rename requests for the title are refused while this is false.

metadataLanguageOverride
String

Explicit metadata-language override, or null when the global default is inherited.

effectiveMetadataLanguage
String!

Metadata language after applying title and library overrides.

inheritsMetadataLanguage
Boolean!

Whether this title inherits metadata language from its library or the global default.

useSeasonFoldersOverride
Boolean

Explicit season-folder override, or null when library/facet settings are inherited.

effectiveUseSeasonFolders
Boolean!

Whether this title uses season folders after applying inheritance.

inheritsUseSeasonFolders
Boolean!

Whether this title inherits the season-folder setting from its library or facet.

effectiveFillerPolicy
FillerPolicyValue

Filler policy after applying the title override or library/facet default.

effectiveRecapPolicy
RecapPolicyValue

Recap policy after applying the title override or library/facet default.

requiredAudioLanguagesOverride
[String!]

Title-specific required audio-language override, or null when the facet setting is inherited.

effectiveRequiredAudioLanguages
[String!]!

Configured audio requirements after title, library, and facet inheritance. The original token remains unresolved in this configuration field.

inheritsRequiredAudioLanguages
Boolean!

Whether the title uses the facet-level required audio-language setting without an override.

collections
[CollectionPayload!]!

Collections belonging to this title, or an empty list when none are available.

seriesMovieLinks
[SeriesMovieLinkPayload!]!

Series-movie links for this title, or an empty list when none exist.

mediaFiles
[TitleMediaFilePayload!]!

Media files for this title that are visible to the caller, or an empty list when none are available.

wantedItems
WantedItemsPagePayload!

Wanted scopes for this title, optionally filtered by status and returned as a page without a total count.

Arguments

NameDescription
status
WantedStatusValue

Optional wanted status filter; omitted includes all statuses.

limit
Int!

Page size; defaults to 50 and clamps to 1 through 300.

offset
Int!

Zero-based page offset; defaults to 0 and negative values become 0.

releaseDecisions
ReleaseDecisionsPagePayload!

Release decisions for this title with a total count and continuation flag.

Arguments

NameDescription
limit
Int!

Page size; defaults to 50 and clamps to 1 through 300.

offset
Int!

Zero-based page offset; defaults to 0 and negative values become 0.

downloadQueueItems
[DownloadQueueItemPayload!]!

Queue items associated with this title after the supplied activity filters are applied.

Arguments

NameDescription
includeAllActivity
Boolean

Include all queue activity instead of only active activity; defaults to false.

includeHistoryOnly
Boolean

Restrict results to history entries; defaults to false.

includeImportActivity
Boolean

Include import activity; defaults to false.

activityFilter
DownloadActivityFilterValue

Activity-state filter; omitted defaults to ALL.

Combined title rating and the sources that contributed it.

Fields

NameDescription
rating
Float

Combined rating, or null when no source supplied one.

ratingSources
[String!]!

Names of rating sources included in the combined value.

externalRatings
[TitleExternalRatingPayload!]!

Per-provider ratings used to calculate or explain the combined value.

One blocked release for a title.

Fields

NameDescription
id
ID!

Blocklist entry ID.

releaseName
String!

The blocked release's name, as the indexer presented it.

errorMessage
String

Failure or blocklist reason, or null when unavailable.

attemptedAt
DateTime!

UTC time when the release was attempted.

Union member indicating the entire title is the acquisition scope.

Fields

NameDescription
wholeTitle
Boolean!

Always true when this marker is emitted.

Identity of a deleted title tag and what the deletion cleaned up.

Fields

NameDescription
id
ID!

Deleted title-tag definition ID.

label
String!

Label the deleted tag carried.

counts
TitleTagRewriteCountsPayload!

Rewrite and reference counts for the deletion.

A saved title-tag definition together with what the save rewrote.

Fields

NameDescription
definition
TitleTagDefinitionPayload!

The definition as it now stands.

counts
TitleTagRewriteCountsPayload!

Rewrite and reference counts; all zero when a tag is created or only its description changed.

Administrator-defined title tag and how many titles currently carry it.

Fields

NameDescription
id
ID!

Title-tag definition ID.

label
String!

Normalized label stored on every title carrying this tag; lowercase, with internal whitespace collapsed.

description
String

Operator-facing note about what the tag is for, or null when none was written.

titleCount
Int!

Number of titles currently carrying the label.

seriesMovieCount
Int!

Number of series movies currently carrying the label. Counted separately from titleCount: a series movie is a link inside a series, not a title of its own.

createdAt
DateTime!

Time the tag was defined, in UTC.

updatedAt
DateTime!

Time the tag was last renamed or re-described, in UTC.

What a title-tag rename or deletion rewrote, and what it only found.

Fields

NameDescription
titles
Int!

Titles whose tag list was rewritten.

seriesMovies
Int!

Series movies whose tag list was rewritten.

delayProfiles
Int!

Delay profiles whose tag list was rewritten.

maintenanceRuleSets
Int!

Maintenance rule sets whose current rule source names the old label; rule sources are never rewritten, so these rules stop matching.

releaseRuleSets
Int!

Release rule sets whose rule source names the old label; rule sources are never rewritten, so these rules stop matching.

managedTagFilters
Int!

Managed rule sets whose tag filter lists the old label; managed filters belong to their pack and are never rewritten.

requestRuleSets
Int!

Request rule sets whose current rule source emits the old label; rule sources are never rewritten, so those rules stop applying the tag.

Result of completing TOTP enrollment or regenerating recovery codes.

Fields

NameDescription
status
TotpStatusPayload!

Updated TOTP status without the shared secret.

recoveryCodes
[String!]!

Newly generated one-time recovery codes; they are not returned again.

One-time values returned when TOTP enrollment starts.

Fields

NameDescription
challengeId
ID!

ID of the short-lived enrollment challenge.

otpauthUrl
String!

otpauth URI for authenticator setup; treat it as secret.

secretBase32
String!

Base32 TOTP secret; returned only for enrollment and must be protected as a secret.

expiresAt
DateTime!

UTC time when the enrollment challenge expires.

TOTP enrollment and usage status without exposing the shared secret.

Fields

NameDescription
enabled
Boolean!

Whether TOTP is enabled.

createdAt
DateTime

UTC time when TOTP was enrolled, or null when never enrolled.

lastUsedAt
DateTime

UTC time when TOTP was last used, or null when unused.

recoveryCodesRemaining
Int!

Number of unused recovery codes remaining.

Local state of one source-template binding in a tracked rule pack.

Fields

NameDescription
templateId
String!

Stable template ID from the source pack.

ruleSetId
ID!

Local rule-set ID retained across source updates.

removed
Boolean!

Whether the template is absent from the current upstream version.

enabled
Boolean

Local enabled state, or null when the retained rule no longer exists.

priority
Int

Local evaluation priority, or null when the retained rule no longer exists.

name
String

Local rule name, or null when the retained rule no longer exists.

description
String

Local rule description, or null when the retained rule no longer exists.

appliedFacets
[String!]!

Local facet scope; empty when the retained rule no longer exists.

One installed rule pack and its locally editable member settings.

Fields

NameDescription
packId
String!

Immutable registry rule-pack ID.

name
String!

Display name recorded from the verified manifest.

version
String!

Installed immutable source version.

digest
String!

Verified source digest for the installed version.

customizable
Boolean!

Whether this installed pack permits copying its rules into user-authored rules.

revision
Long!

Optimistic-concurrency token for pack changes.

autoUpdate
Boolean!

Whether scheduled updates are enabled for this pack.

availableVersion
String

Newer compatible registry version, or null when the installed version is current.

autoUpdateAvailable
Boolean!

Whether an automatic update is currently eligible for this pack.

lastError
String

Most recent automatic-update failure, or null when none is recorded.

lastUpdated
DateTime!

UTC timestamp of the last successful installation or update.

members
[TrackedRulePackMemberPayload!]!

Source templates and their local rule-set bindings.

Preview of the exact source version that a tracked-pack update would apply.

Fields

NameDescription
version
String!

Candidate immutable source version.

digest
String!

Candidate verified source digest.

revision
Long!

Revision that must be supplied to apply this preview.

addedTemplateIds
[String!]!

Template IDs newly introduced by the candidate version.

changedTemplateIds
[String!]!

Template IDs whose source content changed in the candidate version.

removedTemplateIds
[String!]!

Template IDs removed by the candidate version.

Result of queuing title-mismatch recovery searches.

Fields

NameDescription
titleId
ID!

Title ID searched.

queuedCount
Int!

Number of recovery searches accepted for background processing.

Persisted caller presentation preferences and table-column settings.

Fields

NameDescription
theme
UiThemeValue!

Selected theme.

dateTimeFormat
UiDateTimeFormatValue!

Selected date and time format.

highlightColor
String

Primary highlight color, or null when using the default.

secondaryColor
String

Secondary color, or null when using the default.

highContrastMode
Boolean!

Whether high-contrast presentation is enabled.

reduceMotion
Boolean!

Whether motion-reduction behavior is enabled.

hideSponsorButton
Boolean!

Whether the sponsor button is hidden.

density
UiDensityValue!

Selected density.

sidebarMode
UiSidebarModeValue!

Selected sidebar mode.

defaultLandingView
UiDefaultLandingViewValue!

Content area opened by default.

tableColumns
[UiTableColumnSettingPayload!]!

Persisted table-column settings.

One persisted table-column preference for a facet and table mode.

Fields

NameDescription
facet
UiSettingsFacetValue!

Media facet to which the column setting applies.

tableViewMode
UiTableViewModeValue!

Table mode to which the column setting applies.

columnId
String!

Stable column identifier.

columnOrder
Int!

Zero-based display order.

visible
Boolean!

Whether the column is visible.

Identifier returned after uninstalling a plugin.

Fields

NameDescription
pluginId
ID!

Uninstalled plugin ID.

Identifier returned after unlinking an external account.

Fields

NameDescription
linkedAccountId
ID!

Linked-account identity that was removed.

Permissions granted to one library for one user.

Fields

NameDescription
libraryId
ID!

ID of the library receiving the grant.

permissions
[LibraryPermissionValue!]!

Permissions granted within that library.

User summary with authorization and credential-presence flags, never credential values.

Fields

NameDescription
id
ID!

ID of the user.

username
String!

Login username.

loginEnabled
Boolean!

Whether password or external login is enabled.

isDefaultAdmin
Boolean!

Whether this is the default administrator account.

hasPassword
Boolean!

Whether a password is configured, without revealing it.

passwordChangeRequired
Boolean!

Whether a local password must be replaced before the next local-password session is full.

hasMfa
Boolean!

Whether MFA is configured, without revealing its secret.

hasPasskey
Boolean!

Whether a passkey is configured.

accountKind
UserAccountKindValue!

Local or externally provisioned account origin.

appPermissions
[AppPermissionValue!]!

Application-wide permissions granted to the user.

libraryPermissions
[UserLibraryPermissionGrantPayload!]!

Library-specific permission grants.

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.

Fields

NameDescription
depth
VerificationDepthValue!

Depth applied when proving a copied file before its source is touched.

Acquisition target for a title scope, including missing and upgrade states.

Fields

NameDescription
id
ID!

Stable identifier for this scope, or an addressable key such as episode:<id>, title:<id>, or series_movie:<id>.

titleId
ID!

Identifier of the title targeted for acquisition.

titleName
String

Title name, or null when title metadata is unavailable.

titleSlug
String

Stable title slug, or null when unavailable.

titleFacet
String

Title facet, or null when title context is unavailable.

libraryId
ID

Identifier of the containing library, or null when the scope has no library context.

libraryName
String

Library name, or null when library metadata is unavailable.

librarySlug
String

Stable library slug, or null when library metadata is unavailable.

episodeId
ID

Identifier of the targeted episode, or null for title and series-movie scopes.

collectionId
ID

Identifier of the targeted collection, or null when not applicable.

seasonNumber
String

Season number for an episodic scope, or null when not applicable or unknown.

episodeNumber
String

Episode number for an episodic scope, or null when not applicable or unknown.

mediaType
WantedMediaTypeValue!

Acquisition media type represented by this scope.

lastSearchAt
DateTime

Time of the latest search in UTC, or null before a search runs.

status
WantedStatusValue!

Acquisition status; missing targets report wanted until a stored status exists.

grabbedRelease
String

Serialized grabbed-release metadata, or null when no release has been grabbed.

sourceProvider
String

Safe provider label extracted from grabbed-release metadata, with sensitive release details omitted.

currentScore
Int

The bar this scope's landed file sets, or null when nothing occupies it.

The re-derived canonical score of the primary media file occupying the scope: computed on read from the row, never read back from the persisted acquisition_score, which is display history and is only valid while the profile, persona, rule packs and scoring algorithm that wrote it are all unchanged. This is the same number the admission gate compares a candidate against, so the value shown here and the value a grab or import decision used cannot disagree.

It used to be a per-scope ledger column that only held a landed score in one of its five lifecycle states; after a rejected import it held the score of a release that never landed, which read lower than the incumbent.

latestReleaseDecision
ReleaseDecisionPayload

Latest release decision, or null before a candidate decision exists.

standbyCount
Int!

Number of saved fallback candidates keyed to this scope. Season-pack candidates are keyed to their season's anchor episode, so sibling episodes can report zero while the anchor reports the saved candidates.

mismatchRecoveryEligible
Boolean!

Whether a changed title match permits a recovery search.

convergenceState
ConvergenceStateValue!

Convergence state showing whether indexer coverage is queued, searching, complete, or deferred.

indexersCovered
Int!

Number of routed indexers already searched under the current fingerprint.

indexersRouted
Int!

Number of routed indexers enabled for this scope.

recencyLane
RecencyLaneValue!

Scheduling lane used to prioritize convergence work.

createdAt
DateTime!

Creation time in UTC, using a fallback timestamp for synthesized scopes.

updatedAt
DateTime!

Update time in UTC, using a fallback timestamp for synthesized scopes.

title
TitlePayload

Title targeted by this wanted scope, or null when it is no longer available to the caller.

collection
CollectionPayload

Collection targeted by this scope, or null when the scope is not collection-based.

episode
EpisodePayload

Episode targeted by this scope, or null for title, collection, and series-movie scopes.

releaseDecisions
ReleaseDecisionsPagePayload!

Release decisions for this wanted scope with a total count and continuation flag.

Arguments

NameDescription
limit
Int!

Page size; defaults to 50 and clamps to 1 through 300.

offset
Int!

Zero-based page offset; defaults to 0 and negative values become 0.

pendingReleases
PendingReleasesPayload!

Pending releases for this wanted scope with a total count and continuation flag.

Arguments

NameDescription
limit
Int!

Page size; defaults to 50 and clamps to 1 through 300.

offset
Int!

Zero-based page offset; defaults to 0 and negative values become 0.

A complete or partial page of wanted acquisition scopes.

Fields

NameDescription
items
[WantedItemPayload!]!

Wanted items in stable order.

totalCount
Int!

Number of matching scopes across all pages.

hasMore
Boolean!

Whether another page exists after this page.

Wanted items returned without a total-count query.

Fields

NameDescription
items
[WantedItemPayload!]!

Wanted items in stable order.

Counts reported for a wanted search attempt.

Fields

NameDescription
queuedCount
Int!

Number of scopes queued for search.

skippedInProgressCount
Int!

Number of scopes skipped because work was already in progress.

Count of wanted items grouped by lifecycle status.

Fields

NameDescription
status
WantedStatusValue!

Wanted-item status.

count
Int!

Number of items with this status.

WebAuthn registration or authentication challenge options.

Fields

NameDescription
challengeId
ID!

ID of the short-lived WebAuthn challenge.

optionsJson
JSON!

Browser options JSON; it contains challenge data and should not be persisted as a credential.

expiresAt
DateTime!

UTC time when the challenge expires.