Objects
AbandonLocationOperationPayload
Section titled “AbandonLocationOperationPayload”Result of giving up on an operation nobody is running.
Fields
| Name | Description |
|---|---|
idID!
|
Operation the abandon was requested for. |
abandonedBoolean!
|
Whether the operation was marked failed and its titles and roots released. False when it had already stopped on its own. |
detailString
|
Why it was left alone, when it was. |
AcquisitionSearchJobPayload
Section titled “AcquisitionSearchJobPayload”Progress snapshot for a background acquisition search.
Fields
| Name | Description |
|---|---|
jobRunJobRunPayload
|
Accepted job snapshot for shared live tracking; absent in legacy query projections. |
idID!
|
Acquisition-search job ID. |
stateAcquisitionSearchJobStateValue!
|
Current job lifecycle state. |
totalInt!
|
Total search targets. |
processedInt!
|
Number of targets processed. |
grabbedCountInt!
|
Number of releases grabbed. |
failedCountInt!
|
Number of target searches that failed. |
currentTitleString
|
Title currently being processed, or null when idle or complete. |
startedAtDateTime!
|
UTC job start time. |
finishedAtDateTime
|
UTC completion time, or null while running. |
AcquisitionSettingsPayload
Section titled “AcquisitionSettingsPayload”Acquisition worker enablement and polling or convergence limits.
Fields
| Name | Description |
|---|---|
enabledBoolean!
|
Whether automatic acquisition is enabled. |
upgradeCooldownHoursInt!
|
Upgrade cooldown in hours. |
sameTierMinDeltaInt!
|
Minimum score delta for same-tier upgrades. |
crossTierMinDeltaInt!
|
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. |
forcedUpgradeDeltaBypassInt!
|
Score delta that bypasses normal forced-upgrade thresholds. |
pollIntervalSecondsInt!
|
Acquisition polling interval in seconds. |
longTailBackfillMaxScopesPerCycleInt!
|
Maximum long-tail scopes processed per cycle. |
longTailReconvergeDaysInt!
|
Number of days before long-tail scopes are reconverged. |
ActiveImportStreamPayload
Section titled “ActiveImportStreamPayload”A queued or active import operation. This reports real import work only, never worker capacity.
Fields
| Name | Description |
|---|---|
idID!
|
Opaque runtime identity for this active import stream. |
importIdID!
|
Identifier of the persisted import record. |
libraryIdID!
|
Identifier of the library receiving the import. |
facetMediaFacetValue!
|
Media category of the import target. |
sourcePathString!
|
Filesystem path of the source file or extraction directory. |
destinationPathString!
|
Filesystem path where the import is being placed. |
phaseActiveImportStreamPhaseValue!
|
Current runtime phase of the import. |
bytesLong!
|
Number of source bytes transferred so far. |
totalBytesLong!
|
Total source bytes expected for the transfer, or zero when unavailable. |
queuedAtDateTime!
|
Time the import entered the active worker queue. |
startedAtDateTime
|
Time work began, or null while the import remains queued. |
updatedAtDateTime!
|
Time this stream was last updated. |
cancellableBoolean!
|
Whether this stream can still be cancelled. |
cancellationRequestedBoolean!
|
Whether cancellation has been requested and is being processed. |
ActiveImportStreamSyncPayload
Section titled “ActiveImportStreamSyncPayload”Revision metadata for active import stream updates.
Fields
| Name | Description |
|---|---|
revisionLong!
|
Monotonic revision for active import stream changes. |
updatedAtDateTime
|
Time active import streams last changed, or null before the first change. |
ActivityEventPayload
Section titled “ActivityEventPayload”Activity notification with delivery channels and actor context.
Fields
| Name | Description |
|---|---|
idID!
|
ID of the activity event. |
kindActivityKindValue!
|
Activity kind. |
severityActivitySeverityValue!
|
Activity severity. |
channels[ActivityChannelValue!]!
|
Channels associated with the activity. |
actorKindActorKindValue!
|
Origin of the actor that caused the activity. |
actorUserIdID
|
ID of the user actor, or null for anonymous or system activity. |
actorDisplayNameString!
|
Display name of the actor. |
titleIdID
|
ID of the affected title, or null when not title-scoped. |
facetMediaFacetValue
|
Media facet, or null when not facet-scoped. |
episodeIds[ID!]!
|
Episodes affected by the activity when it originated from an import. |
messageString!
|
Human-readable activity message. |
occurredAtDateTime!
|
UTC time when the activity occurred. |
ActivityWindowCountsPayload
Section titled “ActivityWindowCountsPayload”Title-history event counts for one dashboard activity window.
Fields
| Name | Description |
|---|---|
grabbedInt!
|
Releases grabbed during the window. |
upgradedInt!
|
Existing files replaced by a better release during the window. |
importedInt!
|
Imports that completed during the window. |
importFailedInt!
|
Imports rejected as failed during the window; skipped imports are excluded. |
downloadFailedInt!
|
Downloads that failed during the window. |
AddTitleResult
Section titled “AddTitleResult”Result of adding or reusing a title and optionally queuing its acquisition.
Fields
| Name | Description |
|---|---|
titleTitlePayload!
|
Title created or reused by the operation. |
metadataHydrationStateAddTitleHydrationStateValue!
|
Metadata processing outcome, including whether work was accepted or completed. |
reusedExistingTitleBoolean!
|
Whether an existing title matched the requested identity. |
reusedQueuedDownloadBoolean!
|
Whether an existing queued download was reused instead of creating another one. |
downloadJobIdID
|
Identifier of the metadata or acquisition job, or null when no job was created. |
queuedDownloadQueueDownloadPayload
|
Queued download created or reused by the operation, or null when nothing was queued. |
ApiKeyPayload
Section titled “ApiKeyPayload”Non-secret API-key metadata.
Fields
| Name | Description |
|---|---|
idID!
|
API-key record ID. |
labelString!
|
Human-readable label. |
actorString!
|
Auditable identity used for requests made with this key. |
expiresAtDateTime
|
UTC expiry time, or null when the key does not expire. |
revokedAtDateTime
|
UTC revocation time, or null while active. |
lastUsedAtDateTime
|
UTC last successful-use time, or null when unused. |
createdAtDateTime!
|
UTC creation time. |
provisioningSourceString!
|
Provisioning source ( |
ApplicationUpgradeStartPayload
Section titled “ApplicationUpgradeStartPayload”Durable job run accepted for an application upgrade.
Fields
| Name | Description |
|---|---|
jobRunJobRunPayload!
|
The registered application-upgrade job. |
ApplicationUpgradeStatusPayload
Section titled “ApplicationUpgradeStatusPayload”Current update availability and installation eligibility.
Fields
| Name | Description |
|---|---|
currentVersionString!
|
Running application version. |
updateVersionString
|
Available application version, or null when no update notice exists. |
updateTagString
|
Available release tag, or null when no update notice exists. |
updateAvailableBoolean!
|
Whether the current update notice offers a newer version. |
installationKindApplicationInstallationKindValue!
|
Installation layout identified at startup. |
managementOwnerApplicationUpgradeOwnerValue!
|
Party responsible for managing application upgrades. |
eligibleBoolean!
|
Whether this installation is eligible for an in-app upgrade. |
eligibilityReasonString!
|
Stable snake_case code explaining eligibility. |
activeRunJobRunPayload
|
In-memory application-upgrade job still running in this process, if any. |
latestRunJobRunPayload
|
Most recent persisted application-upgrade job, if any. |
ApproveMediaRequestPayload
Section titled “ApproveMediaRequestPayload”Result of approving a media request.
Fields
| Name | Description |
|---|---|
titleIdID!
|
Title identity created or updated by approval. |
wantedSearchWantedSearchPayload
|
Search counts when approval queued acquisition work. |
searchErrorString
|
Non-fatal search error when approval succeeded but search could not be queued. |
claimErrorString
|
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. |
AudioStreamDetailPayload
Section titled “AudioStreamDetailPayload”Audio stream metadata for a media file.
Fields
| Name | Description |
|---|---|
profileString
|
Codec profile, or null when unavailable. |
nameString
|
Original container track name, or null when absent. |
codecString
|
Codec name, or null when unavailable. |
channelsInt
|
Number of audio channels, or null when unavailable. |
languageString
|
Language code, or null when unavailable. |
inferredLanguageString
|
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. |
bitrateKbpsInt
|
Bitrate in kilobits per second, or null when unavailable. |
AuthRuntimeStatePayload
Section titled “AuthRuntimeStatePayload”Effective authentication runtime flags after configuration and environment overrides.
Fields
| Name | Description |
|---|---|
effectiveFormLoginEnabledBoolean!
|
Effective form-login state. |
skipLoginForLocalIpsBoolean!
|
Whether local IPs may skip login. |
passkeyEnabledBoolean!
|
Whether passkey authentication is enabled. |
defaultPersistSessionBoolean!
|
Whether this request's network provenance defaults sessions to persistent storage. |
envOverrideActiveBoolean!
|
Whether an environment override is active. |
mfaRequirePasswordLoginBoolean!
|
Whether password login is required alongside MFA. |
mfaRequireConfigStepUpBoolean!
|
Whether configuration changes require MFA step-up. |
mfaRequireJellyfinLoginBoolean!
|
Whether Jellyfin login requires an enrolled authentication factor. |
mfaRequireEmbyLoginBoolean!
|
Whether Emby login requires an enrolled authentication factor. |
totpRequireJellyfinLoginBoolean!
|
Deprecated: Use mfaRequireJellyfinLogin. Deprecated alias for |
totpRequireEmbyLoginBoolean!
|
Deprecated: Use mfaRequireEmbyLogin. Deprecated alias for |
AutoBackupSettingsPayload
Section titled “AutoBackupSettingsPayload”Automatic backup schedule and encryption-key readiness.
Fields
| Name | Description |
|---|---|
enabledBoolean!
|
Whether automatic backups are enabled. |
dailyTimeLocalString!
|
Daily local-time schedule in the service's configured time format. |
autoBackupKeyPresentBoolean!
|
Whether the automatic-backup encryption key is present. |
autoBackupDisabledMissingKeyNoticeBoolean!
|
Whether automatic backup is disabled because the key is missing. |
nextRunAtDateTime
|
Next scheduled run in UTC, or null when no run is scheduled. |
BackupDownloadUrlPayload
Section titled “BackupDownloadUrlPayload”Provides a temporary authorization token and route for downloading one backup.
Fields
| Name | Description |
|---|---|
downloadUrlString!
|
HTTP path from which the selected backup can be downloaded. |
downloadAuthorizationTokenString!
|
Short-lived token authorizing the backup download. |
expiresAtDateTime!
|
UTC timestamp after which the download token is invalid. |
BackupInfoPayload
Section titled “BackupInfoPayload”Metadata and lifecycle result for one backup file.
Fields
| Name | Description |
|---|---|
filenameString!
|
Backup filename. |
sizeBytesLong!
|
Backup size in bytes. |
createdAtDateTime!
|
Backup creation time in UTC. |
formatVersionString!
|
Backup format version. |
sourceEngineString!
|
Database engine that produced the backup. |
sourceMigrationKeyString
|
Source migration key, when recorded. |
encryptedBoolean!
|
Whether the backup is encrypted. |
rowCounts[BackupRowCountPayload!]!
|
Counts of rows included by table. |
triggerString!
|
Operation that created the backup. |
statusString!
|
Backup lifecycle status. |
errorMessageString
|
Failure detail, or null when the operation succeeded. |
BackupRowCountPayload
Section titled “BackupRowCountPayload”Row count for one table in a backup.
Fields
| Name | Description |
|---|---|
tableString!
|
Table name. |
rowCountLong!
|
Number of rows copied from the table. |
BackupSettingsPayload
Section titled “BackupSettingsPayload”Configured, default, and effective backup paths.
Fields
| Name | Description |
|---|---|
customBackupPathString
|
Custom backup path, or null when the default path is used. |
defaultBackupPathString!
|
Service default backup path. |
effectiveBackupPathString!
|
Effective path selected after applying the custom override. |
BlocklistExternalSubtitlePayload
Section titled “BlocklistExternalSubtitlePayload”Reports the result of deleting and blocklisting an external subtitle.
Fields
| Name | Description |
|---|---|
idID!
|
External subtitle ID targeted by the operation. |
blocklistedBoolean!
|
Whether the subtitle was deleted and its provider result blocklisted. |
BoolConfigValuePayload
Section titled “BoolConfigValuePayload”Stored boolean provider configuration value.
Fields
| Name | Description |
|---|---|
valueBoolean!
|
Boolean value. |
CalendarEpisodePayload
Section titled “CalendarEpisodePayload”Calendar episode with title, library, monitoring, and air-date context.
Fields
| Name | Description |
|---|---|
idID!
|
Episode ID. |
titleIdID!
|
Parent title ID. |
libraryIdID!
|
ID of the library containing the parent title. |
libraryNameString
|
Library name, or null when unavailable. |
librarySlugString
|
Library slug, or null when unavailable. |
titleNameString!
|
Display name of the parent title. |
titleSlugString
|
Title slug, or null when unavailable. |
titleFacetString!
|
Title facet string. |
seasonNumberString
|
Season number text, or null when unavailable. |
episodeNumberString
|
Episode number text, or null when unavailable. |
episodeTitleString
|
Episode title, or null when unavailable. |
overviewString
|
Movie or episode overview, or null when unavailable. |
imageUrlString
|
Proxied movie poster or episode-still URL. |
airDateDate
|
Air date, or null when unavailable. |
monitoredBoolean!
|
Whether both the episode and its parent title are monitored. |
mediaAvailabilityEpisodeMediaAvailabilityPayload!
|
Compact availability derived from the episode's primary media file. |
playbackLinks[MediaServerPlaybackLinkPayload!]!
|
Provider-native playback links available to the current user. |
CancelAcquisitionSearchPayload
Section titled “CancelAcquisitionSearchPayload”Result of requesting cancellation for an acquisition search.
Fields
| Name | Description |
|---|---|
idID!
|
Acquisition-search job ID. |
acceptedBoolean!
|
True when cancellation was accepted; false when the search was already terminal. |
CancelExternalImportMonitorWarmupPayload
Section titled “CancelExternalImportMonitorWarmupPayload”Result of canceling an external import monitor warmup.
Fields
| Name | Description |
|---|---|
sessionIdID!
|
Warmup session ID. |
canceledBoolean!
|
Whether cancellation changed the session state. |
CancelInteractiveReleaseSearchPayload
Section titled “CancelInteractiveReleaseSearchPayload”Result of requesting cancellation for an interactive release search.
Fields
| Name | Description |
|---|---|
idID!
|
Interactive search job ID. |
acceptedBoolean!
|
True when cancellation was accepted; false when the search was already terminal. |
CancelLibraryScanPayload
Section titled “CancelLibraryScanPayload”Result of requesting cancellation for a library scan.
Fields
| Name | Description |
|---|---|
sessionIdID!
|
Library-scan session ID. |
acceptedBoolean!
|
True when cancellation was accepted; false when the scan was already terminal. |
CancelLocationOperationPayload
Section titled “CancelLocationOperationPayload”Result of requesting cancellation; the runner stops at the next title checkpoint.
Fields
| Name | Description |
|---|---|
idID!
|
Operation the cancel was requested for. |
cancelRequestedBoolean!
|
Whether the request was recorded; false when the operation already finished. |
CanonicalMediaTagPayload
Section titled “CanonicalMediaTagPayload”Canonical metadata tag with provenance and content-safety flags.
Fields
| Name | Description |
|---|---|
keyString!
|
Stable canonical tag key. |
categoryString!
|
Canonical tag category. |
nameString!
|
Display name for the tag. |
confidenceFloat
|
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. |
isAdultBoolean!
|
Whether the tag is marked adult. |
isSpoilerBoolean!
|
Whether the tag is marked spoiler-sensitive. |
CanonicalTagFilterOptionPayload
Section titled “CanonicalTagFilterOptionPayload”Canonical tag key and display name used by discovery filters.
Fields
| Name | Description |
|---|---|
keyString!
|
Stable canonical tag key accepted by discovery filters. |
nameString!
|
Display name associated with the canonical key. |
CatalogDiscoveryGroupPayload
Section titled “CatalogDiscoveryGroupPayload”One catalog discovery group with surface, count, and bounded items.
Fields
| Name | Description |
|---|---|
idString!
|
Stable group identifier. |
kindCatalogDiscoveryGroupKindValue!
|
Reason this group was selected. |
surfaceCatalogDiscoverySurfaceValue!
|
Public or personalized origin of the group. |
labelValueString
|
Optional label value, such as a genre or theme key. |
totalCountLong!
|
Total matching items before the returned item page is applied. |
items[DiscoveryItemPayload!]!
|
Items returned for this group. |
CatalogDiscoveryPayload
Section titled “CatalogDiscoveryPayload”Catalog discovery response containing authorization state and grouped results.
Fields
| Name | Description |
|---|---|
canViewPersonalizedBoolean!
|
Whether the caller may view personalized groups. |
groups[CatalogDiscoveryGroupPayload!]!
|
Discovery groups returned in selection order; empty means no group qualified. |
ChangeTitleFolderPayload
Section titled “ChangeTitleFolderPayload”Result of applying a folder-match correction.
Fields
| Name | Description |
|---|---|
outcomeFolderMatchOutcomeValue!
|
What the correction actually did. |
titleFolderMatchTitleRefPayload!
|
The edited title after the change. |
previousFolderPathString
|
Folder the edited title owned before, or null when it owned none. |
detachedMediaFileCountInt!
|
Media associations detached because a title gave up a folder. |
scanLibraryScanSummaryPayload
|
Rescan of the edited title's new folder, or null for a no-op. |
swappedTitleFolderMatchTitleRefPayload
|
The other title after a swap, with the folder it received. |
swappedTitleScanLibraryScanSummaryPayload
|
Rescan of the swapped title's new folder. |
displacedTitleDisplacedTitleRepairPayload
|
The title left unmatched by a takeover, or null when none was displaced. |
ChangeTitleFolderPreviewPayload
Section titled “ChangeTitleFolderPreviewPayload”Read-only description of a proposed folder-match correction.
Fields
| Name | Description |
|---|---|
titleFolderMatchTitleRefPayload!
|
The title being edited. |
facetMediaFacetValue!
|
Media facet of the title being edited. |
libraryIdID!
|
Library that owns the title and every candidate folder. |
libraryNameString!
|
Library display name. |
currentRootIdID
|
Root containing the title's current folder, or null when it owns none. |
currentRootPathString
|
Path of the root containing the title's current folder. |
selectedFolderPathString!
|
Candidate folder, normalized to its stored form. |
selectedRootIdID!
|
Root containing the candidate folder; always a root of the title's library. |
selectedRootPathString!
|
Path of the root containing the candidate folder. |
ownershipFolderMatchOwnershipValue!
|
How the candidate folder relates to the title being edited. |
currentOwnerFolderMatchTitleRefPayload
|
The other title holding the candidate folder, or null when unowned. |
currentFolderTrackedMediaCountInt!
|
Tracked media rows the title currently has inside its existing folder. |
selectedFolderTrackedMediaCountInt!
|
Tracked media rows inside the candidate folder, counted across the title being edited and the candidate folder's owner. |
filesWillMoveBoolean!
|
Always false: correcting a folder match never moves file content. |
noOpBoolean!
|
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
| Name | Description |
|---|---|
clearedBoolean!
|
False when there was no draft owned by the caller to clear. |
ClearTitleImageCachePayload
Section titled “ClearTitleImageCachePayload”Accepted request to clear cached title images.
Fields
| Name | Description |
|---|---|
requestedAtDateTime!
|
When the cache-clear request was accepted. |
ClearTitleReleaseBlocklistEntryPayload
Section titled “ClearTitleReleaseBlocklistEntryPayload”Identity returned after clearing a title release blocklist entry.
Fields
| Name | Description |
|---|---|
idID!
|
Cleared release-blocklist entry identity. |
CollectionPayload
Section titled “CollectionPayload”An ordered season, collection, or other grouped set of episodes for a title.
Fields
| Name | Description |
|---|---|
idID!
|
Stable collection identifier. |
titleIdID!
|
Identifier of the title owning this collection. |
collectionTypeCollectionTypeValue!
|
Collection kind, such as a season or special grouping. |
collectionIndexString!
|
Domain-specific collection index, preserved as text for non-numeric values. |
labelString
|
Human-readable collection label, or null when unavailable. |
orderedPathString
|
Ordered path used to place this collection among its parent collections, or null when absent. |
narrativeOrderString
|
Narrative ordering value, or null when the source does not provide one. |
firstEpisodeNumberString
|
First episode number in the collection, or null when no episode number is known. |
lastEpisodeNumberString
|
Last episode number in the collection, or null when no episode number is known. |
monitoredBoolean!
|
Whether acquisition and monitoring are enabled for this collection. |
createdAtDateTime!
|
Time when the collection record was created, in UTC. |
sizeBytesLong
|
Aggregated live media-file size for this collection. |
fileSizeBytesLong
|
Size in bytes of the media file associated with this collection, or null when unavailable. |
episodesOwnedInt
|
Owned-vs-total episode progress for this collection, populated when requested. |
episodesMonitoredInt
|
Monitored episode count for this collection, populated when requested. |
episodesTotalInt
|
Total countable episode count for this collection, populated when requested. |
episodeRecordsTotalInt
|
Total episode records in this collection including uncountable placeholders (TBA/undated), populated when requested. |
titleTitlePayload
|
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. |
CollectionScopePayload
Section titled “CollectionScopePayload”Union member identifying a collection by ID.
Fields
| Name | Description |
|---|---|
collectionIdID!
|
Target collection ID. |
CompleteSetupPayload
Section titled “CompleteSetupPayload”Result of completing initial application setup.
Fields
| Name | Description |
|---|---|
completedBoolean!
|
Whether setup is now complete. |
CreateMyApiKeyPayload
Section titled “CreateMyApiKeyPayload”Creation result. apiKey is shown once and must be stored by the caller.
Fields
| Name | Description |
|---|---|
apiKeyString!
|
Generated raw API key. This is never returned again. |
keyApiKeyPayload!
|
Non-secret metadata for the generated key. |
CutoffUnmetItemPayload
Section titled “CutoffUnmetItemPayload”One cutoff-unmet target with its current and target quality tiers and convergence state.
Fields
| Name | Description |
|---|---|
titleIdID!
|
Target title ID. |
titleNameString!
|
Title display name. |
titleSlugString
|
Title slug, or null when unavailable. |
titleFacetMediaFacetValue!
|
Media facet containing the title. |
libraryIdID!
|
Library ID containing the title. |
libraryNameString
|
Library name, or null when unavailable. |
librarySlugString
|
Library slug, or null when unavailable. |
episodeIdID
|
Episode ID for episodic targets, or null for title-level targets. |
seasonNumberString
|
Season number as parsed text, or null when unavailable. |
episodeNumberString
|
Episode number as parsed text, or null when unavailable. |
currentTierString!
|
Current quality tier. |
targetTierString!
|
Required target quality tier. |
convergenceStateConvergenceStateValue!
|
Convergence state for this upgrade scope. |
indexersCoveredInt!
|
Number of indexers covering the target. |
indexersRoutedInt!
|
Number of indexers selected by routing. |
CutoffUnmetTitlesPagePayload
Section titled “CutoffUnmetTitlesPagePayload”One page of cutoff-unmet targets plus the full matching count.
Fields
| Name | Description |
|---|---|
items[CutoffUnmetItemPayload!]!
|
Items in the requested page. |
totalCountInt!
|
Total matching targets before pagination. |
hasMoreBoolean!
|
Whether more matching targets exist after this page. |
DashboardActivityStatsPayload
Section titled “DashboardActivityStatsPayload”A trailing activity window together with the window immediately before it, so callers can render each count with its period-over-period delta.
Fields
| Name | Description |
|---|---|
currentActivityWindowCountsPayload!
|
Counts for the trailing window ending at the time of the request. |
previousActivityWindowCountsPayload!
|
Counts for the equally long window immediately before the current one. |
DecisionCodeCountPayload
Section titled “DecisionCodeCountPayload”Count of wanted items grouped by decision code.
Fields
| Name | Description |
|---|---|
codeString!
|
Decision code. |
countInt!
|
Number of wanted items with this code. |
DefaultSeedingProfilePayload
Section titled “DefaultSeedingProfilePayload”Global default seeding profile after an assignment change.
Fields
| Name | Description |
|---|---|
seedingProfileIdID
|
Seeding profile identity used as the default, or null when unset. |
minimumSeedersFloorInt!
|
Fewest seeders a torrent candidate may report when no seeding profile resolves. |
DelayProfileDeletionPayload
Section titled “DelayProfileDeletionPayload”Identifier returned after requesting delay-profile deletion.
Fields
| Name | Description |
|---|---|
idID!
|
Deleted delay-profile ID. |
DelayProfilePayload
Section titled “DelayProfilePayload”Delay profile controlling protocol timing and acquisition bypass rules.
Fields
| Name | Description |
|---|---|
idID!
|
Delay-profile ID. |
nameString!
|
Delay-profile name. |
usenetDelayMinutesInt!
|
Usenet delay in minutes. |
torrentDelayMinutesInt!
|
Torrent delay in minutes. |
enableUsenetBoolean!
|
Whether Usenet releases are eligible for this profile. |
enableTorrentBoolean!
|
Whether torrent releases are eligible for this profile. |
preferredProtocolDelayProfilePreferredProtocolValue!
|
Preferred protocol after delay eligibility. |
minAgeMinutesInt!
|
Minimum release age in minutes. |
bypassScoreThresholdInt
|
Score threshold that bypasses delay, or null when disabled. |
bypassIfHighestQualityBoolean!
|
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. |
priorityInt!
|
Lower values run with higher priority according to service ordering. |
enabledBoolean!
|
Whether the profile is enabled. |
DeleteBackupPayload
Section titled “DeleteBackupPayload”Result of attempting to delete a backup file.
Fields
| Name | Description |
|---|---|
filenameString!
|
Filename targeted by the deletion. |
deletedBoolean!
|
False when no backup file with that name existed. |
DeleteDownloadClientConfigPayload
Section titled “DeleteDownloadClientConfigPayload”Result of deleting a download-client configuration.
Fields
| Name | Description |
|---|---|
idID!
|
Deleted download-client identity. |
clearedIndexerMappingCountInt!
|
Number of indexer mappings cleared as a consequence. |
DeleteEpisodeFilePreviewResultPayload
Section titled “DeleteEpisodeFilePreviewResultPayload”Per-file result within a multi-episode media-file deletion preview.
Fields
| Name | Description |
|---|---|
fileIdID!
|
Media-file identity that would be deleted. |
episodeIdID!
|
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. |
previewDeletePreviewPayload
|
Deletion preview for this file, or null when preview generation failed. |
errorString
|
Error message, or null when preview generation succeeded. |
DeleteEpisodeFilesPayload
Section titled “DeleteEpisodeFilesPayload”Accepted media-file IDs and background job information for a multi-episode media-file deletion request.
Fields
| Name | Description |
|---|---|
jobRunJobRunPayload!
|
Background job run tracking the deletion work. |
acceptedFileIds[ID!]!
|
Media-file identities accepted for processing. |
DeleteEpisodeFilesPreviewPayload
Section titled “DeleteEpisodeFilesPreviewPayload”Combined deletion preview for the media files of several episodes of one title.
Fields
| Name | Description |
|---|---|
previewDeletePreviewPayload!
|
Aggregate preview across all resolved media files. |
items[DeleteEpisodeFilePreviewResultPayload!]!
|
Per-file results, ordered by media-file identity. |
fileCountInt!
|
Number of media files resolved from the requested episodes. |
failedCountInt!
|
Number of media files that failed preview generation. |
DeleteExternalSubtitlePayload
Section titled “DeleteExternalSubtitlePayload”Reports the result of deleting an external subtitle.
Fields
| Name | Description |
|---|---|
idID!
|
External subtitle ID targeted by the deletion. |
deletedBoolean!
|
Whether the subtitle file and tracked record were deleted. |
DeleteIndexerConfigPayload
Section titled “DeleteIndexerConfigPayload”Identity returned after deleting an indexer configuration.
Fields
| Name | Description |
|---|---|
idID!
|
Deleted indexer configuration identity. |
DeleteLibraryPayload
Section titled “DeleteLibraryPayload”Identity returned after deleting a library.
Fields
| Name | Description |
|---|---|
idID!
|
Deleted library identity. |
DeleteMaintenanceExclusionPayload
Section titled “DeleteMaintenanceExclusionPayload”Identifier returned after removing a maintenance exclusion.
Fields
| Name | Description |
|---|---|
idID!
|
Removed exclusion ID. |
DeleteMaintenanceRuleSetPayload
Section titled “DeleteMaintenanceRuleSetPayload”Identifier returned after deleting a maintenance rule set.
Fields
| Name | Description |
|---|---|
idID!
|
Deleted rule-set ID. |
DeleteMediaFilePayload
Section titled “DeleteMediaFilePayload”Result of a media-file deletion request.
Fields
| Name | Description |
|---|---|
idID!
|
Deleted media-file identity. |
jobRunJobRunPayload!
|
Background job accepted to complete deletion and related cleanup. |
DeleteMediaServerConnectionPayload
Section titled “DeleteMediaServerConnectionPayload”Identity returned after deleting a media-server connection.
Fields
| Name | Description |
|---|---|
idID!
|
Deleted connection identity. |
DeleteMyPasskeyPayload
Section titled “DeleteMyPasskeyPayload”Acknowledgement containing the ID of a deleted passkey.
Fields
| Name | Description |
|---|---|
idID!
|
ID of the deleted passkey. |
DeleteNotificationChannelPayload
Section titled “DeleteNotificationChannelPayload”Identifier of a deleted notification channel.
Fields
| Name | Description |
|---|---|
idID!
|
Deleted notification channel ID. |
DeleteNotificationSubscriptionPayload
Section titled “DeleteNotificationSubscriptionPayload”Identifier of a deleted notification subscription.
Fields
| Name | Description |
|---|---|
idID!
|
Deleted notification subscription ID. |
DeleteOAuthClientRegistrationPayload
Section titled “DeleteOAuthClientRegistrationPayload”Result of deleting a custom OAuth application.
Fields
| Name | Description |
|---|---|
clientIdString!
|
Deleted OAuth client identifier. |
deletedBoolean!
|
Whether a persisted custom registration was removed. |
DeletePostProcessingScriptPayload
Section titled “DeletePostProcessingScriptPayload”Identifier of a deleted post-processing script.
Fields
| Name | Description |
|---|---|
idID!
|
Deleted script ID. |
DeletePreviewPayload
Section titled “DeletePreviewPayload”Read-only media deletion preview with confirmation and sample-path details.
Fields
| Name | Description |
|---|---|
fingerprintString!
|
Stable preview fingerprint required to apply the same plan. |
totalFileCountInt!
|
Total files selected by the preview. |
mediaCountInt!
|
Selected media-file count. |
subtitleCountInt!
|
Selected subtitle-file count. |
imageCountInt!
|
Selected image-file count. |
otherCountInt!
|
Selected other-file count. |
directoryCountInt!
|
Selected directory count. |
requiresTypedConfirmationBoolean!
|
Whether typed confirmation is required before applying the plan. |
typedConfirmationPromptString
|
Required confirmation text, or null when typed confirmation is not required. |
targetLabelString!
|
Human-readable preview target label. |
samplePaths[String!]!
|
Sample paths from the selected files and directories. |
DeleteProxyConfigPayload
Section titled “DeleteProxyConfigPayload”Identity returned after deleting a proxy.
Fields
| Name | Description |
|---|---|
idID!
|
Deleted proxy configuration identity. |
DeleteRecycledItemPayload
Section titled “DeleteRecycledItemPayload”Result of deleting one recycle-bin entry.
Fields
| Name | Description |
|---|---|
idID!
|
Recycle-bin entry ID. |
deletedBoolean!
|
Whether the recycle-bin record and file were deleted. |
DeleteRecycledItemsPayload
Section titled “DeleteRecycledItemsPayload”Accepted background deletion for multiple recycle-bin entries.
Fields
| Name | Description |
|---|---|
ids[ID!]!
|
Recycle-bin entry IDs accepted for deletion. |
jobRunJobRunPayload!
|
Background job accepted for the deletion operation. |
DeleteRequestRuleSetPayload
Section titled “DeleteRequestRuleSetPayload”Identifier returned after deleting a request rule set.
Fields
| Name | Description |
|---|---|
idID!
|
Deleted rule-set ID. |
DeleteRuleSetPayload
Section titled “DeleteRuleSetPayload”Identifier returned after deleting a rule set.
Fields
| Name | Description |
|---|---|
idID!
|
Deleted rule-set ID. |
DeleteSeedingProfilePayload
Section titled “DeleteSeedingProfilePayload”Identity returned after deleting a seeding profile.
Fields
| Name | Description |
|---|---|
idID!
|
Deleted seeding profile identity. |
DeleteSubtitleProviderConfigPayload
Section titled “DeleteSubtitleProviderConfigPayload”Identity returned after deleting a subtitle provider.
Fields
| Name | Description |
|---|---|
idID!
|
Deleted subtitle-provider identity. |
DeleteTitlePayload
Section titled “DeleteTitlePayload”Identity returned after deleting a title.
Fields
| Name | Description |
|---|---|
idID!
|
Deleted title identity. |
DeleteTitlePreviewResultPayload
Section titled “DeleteTitlePreviewResultPayload”Per-title result within a multi-title deletion preview.
Fields
| Name | Description |
|---|---|
titleIdID!
|
Target title ID. |
previewDeletePreviewPayload
|
Deletion preview, or null when preview generation failed. |
errorString
|
Error message, or null when preview generation succeeded. |
DeleteTitlesPayload
Section titled “DeleteTitlesPayload”Accepted title IDs and background job information for a deletion request.
Fields
| Name | Description |
|---|---|
jobRunJobRunPayload!
|
Background job run tracking the deletion work. |
acceptedTitleIds[ID!]!
|
Title IDs accepted for processing. |
DeleteTitlesPreviewPayload
Section titled “DeleteTitlesPreviewPayload”Combined deletion preview for multiple titles.
Fields
| Name | Description |
|---|---|
previewDeletePreviewPayload!
|
Aggregate preview across all successful title targets. |
items[DeleteTitlePreviewResultPayload!]!
|
Per-title results. |
failedCountInt!
|
Number of title targets that failed preview generation. |
DeleteTrackedRulePackPayload
Section titled “DeleteTrackedRulePackPayload”Identifier returned after uninstalling a tracked rule pack.
Fields
| Name | Description |
|---|---|
packIdString!
|
Immutable registry rule-pack ID. |
DeleteUserPayload
Section titled “DeleteUserPayload”Identity returned after deleting a user.
Fields
| Name | Description |
|---|---|
idID!
|
Deleted user identity. |
DirectoryEntryPayload
Section titled “DirectoryEntryPayload”Directory entry returned while browsing a configured path.
Fields
| Name | Description |
|---|---|
nameString!
|
Entry name. |
pathString!
|
Entry path. |
isDirectoryBoolean!
|
Whether the entry is a directory rather than a file. |
DiscoveryContentCertificationPayload
Section titled “DiscoveryContentCertificationPayload”Content certification for one country and release type.
Fields
| Name | Description |
|---|---|
valueString!
|
Certification value, such as an age category. |
sourceString!
|
Authority or source that supplied the certification. |
releaseTypeInt
|
Release-type code, or null when the source did not specify one. |
DiscoveryContentRatingPayload
Section titled “DiscoveryContentRatingPayload”Country-specific content ratings and their certifications.
Fields
| Name | Description |
|---|---|
countryString!
|
ISO-like country code supplied by the source. |
certifications[DiscoveryContentCertificationPayload!]!
|
Certifications reported for this country. |
ageRatingInt
|
Numeric age rating, or null when unavailable. |
ageRatingSourceString
|
Source of the numeric age rating, or null when unavailable. |
DiscoveryExternalIdPayload
Section titled “DiscoveryExternalIdPayload”External identifier associated with a discovery item.
Fields
| Name | Description |
|---|---|
sourceString!
|
External source name. |
kindString!
|
External identifier kind. |
idString!
|
Provider-issued identifier value. |
keyString!
|
Canonical composite key for the external identity. |
DiscoveryExternalRatingPayload
Section titled “DiscoveryExternalRatingPayload”Rating from an external source, including normalized score and optional vote count.
Fields
| Name | Description |
|---|---|
sourceString!
|
External rating source name. |
valueFloat
|
Source-specific raw value, or null when unavailable. |
scoreFloat
|
Source-specific score, or null when unavailable. |
normalizedFloat!
|
Normalized score used for cross-source comparison. |
votesInt
|
Number of votes reported by the source, or null when unavailable. |
urlString!
|
Source URL for the rating record. |
DiscoveryFacetPayload
Section titled “DiscoveryFacetPayload”Discovery facet counts for external and local catalog matches.
Fields
| Name | Description |
|---|---|
nameString!
|
Human-readable facet name. |
valueString!
|
Stable facet value. |
smgCountLong
|
External discovery count, or null when unavailable. |
localCountLong
|
Local owned-title count, or null when unavailable. |
DiscoveryHomeCardPayload
Section titled “DiscoveryHomeCardPayload”Compact discovery card identity and display metadata.
Fields
| Name | Description |
|---|---|
idID!
|
Stable local or discovery-card ID for this result. |
targetKeyString!
|
Stable discovery target key used for detail lookup. |
targetKindMediaFacetValue!
|
Kind of target represented by the card. |
displayTitleString!
|
Display title selected for this card. |
originalTitleString
|
Original source title when it differs from the display title, or null. |
sortTitleString
|
Normalized sort title when available, or null. |
yearInt
|
Release year, or null when unavailable. |
posterUrlString
|
Poster URL, or null when no poster is available. |
contentTypeMediaFacetValue!
|
Content facet represented by the card. |
isAdultBoolean!
|
Whether the source metadata marks the content as adult. |
ownedInInputBoolean!
|
Whether the target is already owned in the input scope. |
DiscoveryHomeCardsPayload
Section titled “DiscoveryHomeCardsPayload”Card-oriented discovery home response with synchronization status and optional hero and sections.
Fields
| Name | Description |
|---|---|
statusDiscoverySyncStatusPayload!
|
Synchronization readiness and pending-context information. |
heroItemDiscoveryHomeHeroPayload
|
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. |
completeCollectionDiscoveryHomeSectionPayload
|
Complete-collection card section, or null when none is available. |
canViewPersonalizedBoolean!
|
Whether the caller may view personalized cards. |
DiscoveryHomeFilterOptionsPayload
Section titled “DiscoveryHomeFilterOptionsPayload”Available discovery-home filter values for genres, themes, and studios.
Fields
| Name | Description |
|---|---|
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. |
DiscoveryHomeHeroPayload
Section titled “DiscoveryHomeHeroPayload”Expanded discovery hero metadata, ratings, tags, and ownership state.
Fields
| Name | Description |
|---|---|
idID!
|
Stable local or discovery-card ID for this result. |
targetKeyString!
|
Stable discovery target key used for detail lookup. |
targetKindMediaFacetValue!
|
Kind of target represented by the hero. |
displayTitleString!
|
Display title selected for the hero. |
originalTitleString
|
Original source title when it differs from the display title, or null. |
sortTitleString
|
Normalized sort title when available, or null. |
yearInt
|
Release year, or null when unavailable. |
posterUrlString
|
Poster URL, or null when no poster is available. |
backgroundUrlString
|
Background artwork URL, or null when unavailable. |
overviewString
|
Overview text, or null when unavailable. |
contentTypeMediaFacetValue!
|
Content facet represented by the hero. |
isAdultBoolean!
|
Whether the source metadata marks the content as adult. |
ratingFloat
|
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. |
matchedSubjectCountInt!
|
Number of subject matches contributing to this hero selection. |
ownedInInputBoolean!
|
Whether the target is already owned in the input scope. |
DiscoveryHomePayload
Section titled “DiscoveryHomePayload”Discovery home response with synchronization status, selected sections, facets, and authorization state.
Fields
| Name | Description |
|---|---|
statusDiscoverySyncStatusPayload!
|
Synchronization readiness and pending-context information used to interpret the result. |
heroItemDiscoveryItemPayload
|
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. |
completeCollectionDiscoverySectionPayload
|
Complete-collection section, or null when none is available. |
facets[DiscoveryFacetPayload!]!
|
Facet summaries returned for the selected discovery scope. |
canViewPersonalizedBoolean!
|
Whether the caller may view personalized results. |
DiscoveryHomeSectionPayload
Section titled “DiscoveryHomeSectionPayload”A titled discovery home section with its source surface, total count, and bounded items.
Fields
| Name | Description |
|---|---|
sectionIdString!
|
Stable section identifier. |
sectionTypeString!
|
Section classification value. |
titleString!
|
Human-readable section title. |
surfaceDiscoverySurfaceValue!
|
Whether this section is public, personalized, or mixed. |
totalCountLong!
|
Total matching items before the returned item page is applied. |
items[DiscoveryHomeCardPayload!]!
|
Items returned for this section, possibly fewer than the total. |
DiscoveryItemPayload
Section titled “DiscoveryItemPayload”Detailed discovery item with resolution, metadata, relationships, provenance, and ownership state.
Fields
| Name | Description |
|---|---|
idID!
|
Stable local or discovery-item ID. |
targetKeyString!
|
Stable discovery target key used for detail lookup. |
targetKindString!
|
Target kind string supplied by the discovery source. |
resolvedBoolean!
|
Whether the target resolved to a local title. |
resolvedTitleIdID
|
Local title ID when resolved, or null when unresolved. |
displayTitleString!
|
Display title selected from available metadata. |
originalTitleString
|
Original source title when available. |
sortTitleString
|
Normalized sort title when available. |
yearInt
|
Release year, or null when unavailable. |
posterUrlString
|
Poster URL, or null when unavailable. |
backgroundUrlString
|
Background artwork URL, or null when unavailable. |
overviewString
|
Overview text, or null when unavailable. |
contentTypeString
|
Content facet string, or null when the source did not classify it. |
canonicalTags[CanonicalMediaTagPayload!]!
|
Canonical tags associated with the item. |
isAdultBoolean!
|
Whether the source metadata marks the content as adult. |
contentRatings[DiscoveryContentRatingPayload!]!
|
Country-specific content ratings. |
ratingFloat
|
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. |
bestSourceString
|
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. |
sourceCountInt
|
Number of contributing sources, or null when not computed. |
edgeCountInt
|
Number of discovery edges, or null when not computed. |
relationCountInt
|
Number of relations, or null when not computed. |
sourceSubjectCountInt
|
Number of matched source subjects, or null when not computed. |
rankScoreFloat
|
Ranking score used for ordering, or null when not computed. |
matchedSubjectTitles[String!]!
|
Titles of matched subjects contributing to this item. |
matchedSubjectCountInt!
|
Number of matched subjects contributing to this item. |
tmdbCollectionIdString
|
TMDB collection ID, or null when unavailable. |
tmdbCollectionNameString
|
TMDB collection name, or null when unavailable. |
ownedInInputBoolean!
|
Whether the target is already owned in the input scope. |
studioSlugString
|
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. |
DiscoveryItemsPayload
Section titled “DiscoveryItemsPayload”Paged discovery-item results with a total count and personalization capability.
Fields
| Name | Description |
|---|---|
items[DiscoveryItemPayload!]!
|
Items in the requested page; empty means no items matched. |
totalCountLong!
|
Total number of matching items before pagination. |
canViewPersonalizedBoolean!
|
Whether the caller may view personalized results. |
DiscoverySectionPayload
Section titled “DiscoverySectionPayload”A discovery section containing a title, origin surface, count, and items.
Fields
| Name | Description |
|---|---|
sectionIdString!
|
Stable section identifier. |
sectionTypeString!
|
Section classification value. |
titleString!
|
Human-readable section title. |
surfaceString!
|
Surface label for this section. |
totalCountLong!
|
Total matching items before the returned item page is applied. |
items[DiscoveryItemPayload!]!
|
Items returned for this section. |
DiscoverySyncStatePayload
Section titled “DiscoverySyncStatePayload”Generation markers, completion timestamps, and eligibility timestamps for discovery synchronization.
Fields
| Name | Description |
|---|---|
lastSuccessGenerationIdID
|
Generation ID of the last successfully completed context snapshot, or null before the first success. |
lastPublicFeedGenerationIdID
|
Generation ID of the last completed public-feed build, or null when none has completed. |
lastContextSnapshotCompletedAtDateTime
|
UTC completion time of the last context snapshot, or null when none has completed. |
lastIncrementalReloadCompletedAtDateTime
|
UTC completion time of the last incremental reload, or null when none has completed. |
lastPublicFeedCompletedAtDateTime
|
UTC completion time of the last public-feed build, or null when none has completed. |
nextContextSnapshotEligibleAtDateTime
|
UTC time when another context snapshot becomes eligible, or null when no schedule is set. |
nextIncrementalReloadEligibleAtDateTime
|
UTC time when another incremental reload becomes eligible, or null when no schedule is set. |
nextPublicFeedEligibleAtDateTime
|
UTC time when another public-feed build becomes eligible, or null when no schedule is set. |
updatedAtDateTime!
|
UTC time when this synchronization state was last updated. |
DiscoverySyncStatusPayload
Section titled “DiscoverySyncStatusPayload”Discovery synchronization state and the number of context changes awaiting processing.
Fields
| Name | Description |
|---|---|
stateDiscoverySyncStatePayload!
|
Current synchronization lifecycle state and next eligible work times. |
pendingContextChangeCountLong!
|
Number of discovery context changes not yet incorporated into a completed snapshot. |
DismissPendingReleasePayload
Section titled “DismissPendingReleasePayload”Identifier of a dismissed pending release.
Fields
| Name | Description |
|---|---|
idID!
|
Pending release ID. |
DisplacedTitleRepairPayload
Section titled “DisplacedTitleRepairPayload”A title left without a folder by a takeover, and how it surfaces for repair.
Fields
| Name | Description |
|---|---|
idID!
|
Displaced title identity. |
nameString!
|
Displaced title display name. |
previousFolderPathString!
|
Folder the displaced title no longer owns. |
repairReasonCodeString!
|
Reason recorded on its unmatched-discovery item. |
DomainEventEnvelopePayload
Section titled “DomainEventEnvelopePayload”Ordered domain event envelope for stream subscriptions.
Fields
| Name | Description |
|---|---|
sequenceLong!
|
Monotonically increasing stream sequence. |
eventIdID!
|
ID of the event. |
occurredAtDateTime!
|
UTC time when the event occurred. |
actorKindActorKindValue!
|
Origin of the actor that caused the event. |
actorUserIdID
|
ID of the user actor, or null for anonymous or system events. |
actorDisplayNameString!
|
Display name of the actor. |
titleIdID
|
ID of the affected title, or null when not title-scoped. |
facetMediaFacetValue
|
Media facet, or null when not facet-scoped. |
eventTypeDomainEventTypeValue!
|
Typed domain event name. |
streamKindStreamKindValue!
|
Stream category containing the event. |
streamIdID
|
ID of the stream target, or null for the global stream. |
payloadJsonJSON!
|
Event-specific JSON payload. |
DownloadClientConfigPayload
Section titled “DownloadClientConfigPayload”Download-client configuration with provider metadata and masked secret fields.
Fields
| Name | Description |
|---|---|
idID!
|
Download-client configuration ID. |
nameString!
|
Download-client name. |
clientTypeString!
|
Download-client provider type. |
baseUrlString
|
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. |
isEnabledBoolean!
|
Whether the client is enabled. |
statusString!
|
Current client status. |
lastErrorString
|
Most recent error, or null when none is recorded. |
lastSeenAtDateTime
|
UTC time the client was last observed, or null before the first observation. |
disabledUntilDateTime
|
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. |
escalationLevelInt!
|
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. |
proxyConfigIdID
|
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. |
createdAtDateTime!
|
UTC creation time. |
updatedAtDateTime!
|
UTC last-update time. |
DownloadClientFilterOptionPayload
Section titled “DownloadClientFilterOptionPayload”Download-client option used by paged queue and history filters.
Fields
| Name | Description |
|---|---|
clientIdID!
|
Download-client ID. |
clientNameString!
|
Download-client name. |
clientTypeString!
|
Download-client provider type. |
DownloadClientRoutingEntryPayload
Section titled “DownloadClientRoutingEntryPayload”Download-client routing behavior for one client.
Fields
| Name | Description |
|---|---|
clientIdID!
|
Download-client ID. |
enabledBoolean!
|
Whether this route is enabled. |
categoryString
|
Optional category assigned to recent downloads. |
recentQueuePriorityString
|
Priority for recent queue items, or null when unspecified. |
olderQueuePriorityString
|
Priority for older queue items, or null when unspecified. |
removeCompletedBoolean!
|
Whether completed items are removed from the client. |
removeFailedBoolean!
|
Whether failed items are removed from the client. |
seedingProfileIdID
|
Optional seeding profile ID applied to torrents routed to this client. |
DownloadHistoryPagePayload
Section titled “DownloadHistoryPagePayload”A page of completed or failed queue history items and clients available for filtering.
Fields
| Name | Description |
|---|---|
items[DownloadQueueItemPayload!]!
|
Items in the requested page in stable history order. |
hasMoreBoolean!
|
Whether another page exists after this page. |
totalCountInt!
|
Number of matching history items across all pages. |
availableClients[DownloadClientFilterOptionPayload!]!
|
Clients represented after activity filters and before the client filter is applied. |
DownloadImportActionsPayload
Section titled “DownloadImportActionsPayload”The import actions one queue item offers, decided by the server so every client surface agrees.
Fields
| Name | Description |
|---|---|
manualImportInteractiveBoolean!
|
Whether a manual import should open the file-mapping dialog first. |
manualImportDirectBoolean!
|
Whether a manual import can run without the mapping dialog. |
assignTitleBoolean!
|
Whether the item can be assigned to a title. |
ignoreBoolean!
|
Whether the item can be ignored. |
markFailedBoolean!
|
Whether the item can be marked failed. |
DownloadImportPagePayload
Section titled “DownloadImportPagePayload”A page of queue items classified for import.
Fields
| Name | Description |
|---|---|
items[DownloadQueueItemPayload!]!
|
Import items in the requested page in stable order. |
hasMoreBoolean!
|
Whether another page exists after this page. |
totalCountInt!
|
Number of matching import items across all pages. |
DownloadQueueActionPayload
Section titled “DownloadQueueActionPayload”Result of a queue command and the item state observed after it was issued.
Fields
| Name | Description |
|---|---|
kindDownloadQueueActionKindValue!
|
Command action accepted for the queue item. |
downloadClientItemIdString!
|
Client-local item identifier targeted by the command. |
clientIdID
|
Identifier of the client targeted by the command, or null when unresolved. |
clientTypeString
|
Client type targeted by the command, or null when unresolved. |
importIdID
|
Application import identifier affected by the command, or null when not applicable. |
commandIdID
|
Command identifier for tracking asynchronous work, or null when no command was created. |
removedBoolean!
|
Whether the item was removed from the queue. |
queueItemDownloadQueueItemPayload
|
Updated queue item, or null when the item was removed or is unavailable. |
DownloadQueueItemPayload
Section titled “DownloadQueueItemPayload”Queue item state with download client, import, and tracked-download information.
Fields
| Name | Description |
|---|---|
idID!
|
Identifier of this queue item. |
titleIdID
|
Identifier of the associated title, or null for an unmatched item. |
episodeIdID
|
Identifier of the associated episode, or null for title-level or unmatched items. |
titleNameString!
|
Title name resolved for display, including an unmatched release title when needed. |
facetMediaFacetValue
|
Media facet of the matched title, or null when unmatched. |
isScryerOriginBoolean!
|
Whether the item originated from Scryer's acquisition workflow. |
sourceProviderString
|
Provider label associated with the source release, or null when unknown. |
clientIdID!
|
Identifier of the download client owning this item. |
clientNameString!
|
Display name of the download client. |
clientTypeString!
|
Download client type identifier. |
stateDownloadQueueStateValue!
|
State reported by the download client. |
displayStateDownloadDisplayStateValue!
|
Normalized state across the download client and import workflow. |
progressPercentInt!
|
Download progress percentage from 0 through 100. |
importTransferPhaseImportTransferPhaseValue
|
Import transfer stage, or null when no import transfer is active. |
importTransferBytesLong
|
Bytes transferred during import, or null when transfer accounting is unavailable. |
importTransferTotalBytesLong
|
Total bytes expected during import, or null when the total is unknown. |
importTransferStartedAtDateTime
|
Time the import transfer started, in UTC, or null when not started. |
importTransferUpdatedAtDateTime
|
Time the import transfer was last updated, in UTC, or null when not updated. |
sizeBytesLong
|
Download size in bytes, or null when the client has not reported it. |
remainingSecondsInt
|
Estimated remaining time in seconds, or null when unavailable. |
queuedAtDateTime
|
Time the item entered the queue, in UTC, or null when unknown. |
lastUpdatedAtDateTime
|
Time the client last updated the item, in UTC, or null when unknown. |
attentionRequiredBoolean!
|
Whether the item requires attention before the workflow can proceed. |
attentionReasonString
|
Reason for the attention flag, or null when no attention is required. |
downloadClientItemIdString!
|
Client-local item identifier; together with |
downloadIdString
|
Application download identifier, or null when the item is not linked to one. |
importStatusImportStatusValue
|
Import lifecycle status, or null before import classification. |
importErrorCodeImportErrorCodeValue
|
Import failure code, or null when there is no import failure. |
importErrorMessageString
|
Import failure detail, or null when there is no import failure. |
importedAtDateTime
|
Time the item was imported, in UTC, or null before successful import. |
deleteStatusDownloadQueueDeleteStatusValue
|
Deletion command status, or null when no deletion was requested. |
deleteErrorMessageString
|
Deletion failure detail, or null when deletion has not failed. |
trackedStateTrackedDownloadStateValue
|
Tracked-download lifecycle state, or null when no tracked record matches. |
trackedStatusTrackedDownloadStatusValue
|
Tracked-download status, or null when no tracked record matches. |
trackedStatusMessages[String!]!
|
Human-readable tracked-download status messages; empty when none are available. |
trackedMatchTypeTitleMatchTypeValue
|
Match classification for the tracked download, or null when unmatched. |
seedingStateDownloadSeedingStateValue
|
Seeding obligation state, or null when the item carries no torrent seeding information. |
seedRatioFloat
|
Share ratio observed by the download client, or null when it reports none. |
seedRatioGoalFloat
|
Share ratio this download was grabbed under, or null when no profile applied. |
seedTimeSecondsLong
|
Seconds spent seeding as reported by the client, or null when it has no counter. |
seedTimeGoalSecondsLong
|
Seeding time in seconds this download was grabbed under, or null when no profile applied. |
isPrivateBoolean
|
Whether the torrent's metainfo carries the private flag; null when the client cannot say. |
importActionsDownloadImportActionsPayload!
|
Import actions this download currently offers; every client surface renders from this. |
queueScopeQueueDownloadScopePayload
|
Acquisition scope for this queue item, or its episode scope when no more specific scope is available. |
titleTitlePayload
|
Caller-visible matched title, or null when the queue item is unmatched or inaccessible. |
DownloadQueuePagePayload
Section titled “DownloadQueuePagePayload”A live download queue page with revision and readiness metadata.
Fields
| Name | Description |
|---|---|
items[DownloadQueueItemPayload!]!
|
Items in the requested page in stable queue order. |
hasMoreBoolean!
|
Whether another page exists after this page. |
totalCountInt!
|
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. |
revisionLong!
|
Monotonic queue revision used to detect updates. |
updatedAtDateTime
|
Time the queue data was updated, in UTC, or null before the first update. |
readyBoolean!
|
Whether the queue data is complete enough to represent current state. |
staleBoolean!
|
Whether the queue data may be behind its source. |
DownloadQueueSyncPayload
Section titled “DownloadQueueSyncPayload”Queue revision metadata returned after synchronization.
Fields
| Name | Description |
|---|---|
revisionLong!
|
New monotonic queue revision. |
updatedAtDateTime
|
Time the queue data was updated, in UTC, or null when no update exists. |
DownloadSubtitlePayload
Section titled “DownloadSubtitlePayload”Confirms the provider subtitle saved for a media file.
Fields
| Name | Description |
|---|---|
mediaFileIdID!
|
Media file ID that received the subtitle. |
providerFileIdString!
|
Provider-specific subtitle file ID that was downloaded. |
downloadedBoolean!
|
Whether the subtitle download and import completed. |
EmbyConnectServerPayload
Section titled “EmbyConnectServerPayload”Emby Connect server and its reachable addresses.
Fields
| Name | Description |
|---|---|
serverIdString!
|
Emby Connect server identity. |
nameString!
|
Server display name. |
userTypeEmbyConnectUserTypeValue!
|
Emby Connect user category. |
localAddressString
|
Local server address, when advertised. |
remoteAddressString
|
Remote server address, when advertised. |
localApiBaseUrlString
|
Local API base URL, when reachable. |
remoteApiBaseUrlString
|
Remote API base URL, when reachable. |
localStatusEmbyConnectAddressStatusValue!
|
Local address probe result. |
remoteStatusEmbyConnectAddressStatusValue!
|
Remote address probe result. |
suggestedBaseUrlString
|
Server address selected by connection logic, when one is available. |
EmptyRecycleBinPayload
Section titled “EmptyRecycleBinPayload”Accepted background request to empty the selected recycle bins.
Fields
| Name | Description |
|---|---|
jobRunJobRunPayload!
|
Background job whose result reports the number of entries purged. |
EpisodeMediaAvailabilityPayload
Section titled “EpisodeMediaAvailabilityPayload”Availability summary for an episode’s primary media.
Fields
| Name | Description |
|---|---|
stateEpisodeMediaAvailabilityStateValue!
|
Current availability or scan state. |
primaryQualityLabelString
|
Quality label of the primary file, or null before a file is available. |
EpisodePayload
Section titled “EpisodePayload”Episode identity, schedule metadata, flags, and media readiness fields.
Fields
| Name | Description |
|---|---|
idID!
|
Stable episode identifier. |
titleIdID!
|
Identifier of the title containing this episode. |
collectionIdID
|
Identifier of the containing collection, or null when not assigned. |
episodeTypeEpisodeTypeValue!
|
Episode kind, such as regular, special, filler, or recap. |
episodeNumberString
|
Season-relative episode number, or null when unknown. |
seasonNumberString
|
Season number, or null when the source does not provide one. |
episodeLabelString
|
Display label for the episode number, or null before metadata is available. |
titleString
|
Episode title, or null before metadata is available. |
overviewString
|
Episode synopsis, or null before metadata is available. |
airDateDate
|
Air date as a calendar date without a time zone, or null when unknown. |
durationSecondsInt
|
Duration in seconds, or null when media or metadata has not supplied it. |
hasMultiAudioBoolean!
|
Whether more than one audio stream is present in the available media. |
hasSubtitleBoolean!
|
Whether at least one subtitle stream is present in the available media. |
isFillerBoolean!
|
Whether the episode is classified as filler. |
isRecapBoolean!
|
Whether the episode is classified as recap. |
absoluteNumberString
|
Absolute episode number, or null when unknown. |
imageUrlString
|
Proxied episode image URL, or null when no image source is available. |
monitoredBoolean!
|
Whether acquisition and monitoring are enabled for this episode. |
createdAtDateTime!
|
Time when the episode record was created, in UTC. |
sizeBytesLong
|
Aggregated live media-file size for this episode. |
playbackLinks[MediaServerPlaybackLinkPayload!]!
|
Provider-native playback links for this episode, when an exact catalog mapping exists. |
parentTitleTitlePayload
|
Parent title for this episode, or null if it is no longer available to the caller. |
collectionCollectionPayload
|
Containing collection when the episode has one, otherwise null. |
wantedItemWantedItemPayload
|
Acquisition state for this episode, or null when no wanted state exists. |
mediaAvailabilityEpisodeMediaAvailabilityPayload!
|
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. |
EpisodeScopePayload
Section titled “EpisodeScopePayload”Union member identifying one episode by ID.
Fields
| Name | Description |
|---|---|
episodeIdID!
|
Target episode ID. |
EpisodeSetScopePayload
Section titled “EpisodeSetScopePayload”Union member identifying multiple episodes by ID.
Fields
| Name | Description |
|---|---|
episodeIds[ID!]!
|
Target episode IDs; empty means no episode scope was supplied. |
ExternalAuthRuntimeConnectionPayload
Section titled “ExternalAuthRuntimeConnectionPayload”Runtime state for one external authentication connection.
Fields
| Name | Description |
|---|---|
idID!
|
Connection identity. |
providerExternalAccountProviderValue!
|
External provider type. |
displayNameString!
|
Display name of the connection. |
loginEnabledBoolean!
|
Whether login through this connection is enabled. |
linkingEnabledBoolean!
|
Whether account linking through this connection is enabled. |
embyConnectEnabledBoolean!
|
Whether Emby Connect is enabled for this connection. |
ExternalAuthRuntimeSettingsPayload
Section titled “ExternalAuthRuntimeSettingsPayload”Runtime authentication providers, linking providers, and connections.
Fields
| Name | Description |
|---|---|
loginProviders[ExternalAccountProviderValue!]!
|
Providers enabled for login. |
linkingProviders[ExternalAccountProviderValue!]!
|
Providers enabled for account linking. |
connections[ExternalAuthRuntimeConnectionPayload!]!
|
Configured external authentication connections. |
ExternalIdPayload
Section titled “ExternalIdPayload”External identifier from a provider.
Fields
| Name | Description |
|---|---|
sourceString!
|
Provider or source name. |
kindString
|
Entity kind the identifier names at that source, such as |
valueString!
|
Identifier assigned by that source. |
ExternalImportAggregateWarmupProgressPayload
Section titled “ExternalImportAggregateWarmupProgressPayload”Aggregate title-fetch progress for external source warmups.
Fields
| Name | Description |
|---|---|
statusExternalImportMonitorWarmupStatusValue!
|
Aggregate warmup status. |
titlesTotalKnownBoolean!
|
Whether the total title count is known. |
titlesFetchedInt!
|
Number of titles fetched. |
titlesTotalInt!
|
Total titles expected when known. |
errorMessageString
|
Failure detail, or null when no error occurred. |
ExternalImportArrSourcePayload
Section titled “ExternalImportArrSourcePayload”Connection and warmup result for one external Arr source.
Fields
| Name | Description |
|---|---|
sessionIdID!
|
Warmup session ID. |
sourceKeyString!
|
Stable source identity. |
kindExternalArrSourceKind!
|
External source kind. |
baseUrlString!
|
Source base URL. |
connectedBoolean!
|
Whether the source connection succeeded. |
versionString
|
Source version, or null when unavailable. |
statusExternalImportMonitorWarmupStatusValue!
|
Warmup lifecycle status. |
errorString
|
Connection or warmup error, or null on success. |
ExternalImportConnectionValidationPayload
Section titled “ExternalImportConnectionValidationPayload”Connection probe result for an external service.
Fields
| Name | Description |
|---|---|
kindExternalImportConnectionKind!
|
Service kind that was validated. |
baseUrlString!
|
Normalized service base URL. |
connectedBoolean!
|
Whether the service accepted the connection credentials. |
versionString
|
Detected service version, or null when unavailable. |
errorString
|
Connection failure detail, or null when connected. |
ExternalImportDownloadClientPayload
Section titled “ExternalImportDownloadClientPayload”Download-client candidate discovered during external import.
Fields
| Name | Description |
|---|---|
sourceKeys[String!]!
|
Source identities that reported this candidate. |
nameString!
|
Download-client name. |
implementationString!
|
Source implementation name. |
scryerClientTypeString
|
Scryer client type, or null when unsupported. |
hostString
|
Hostname or address, when reported. |
portString
|
Port as reported by the external source, which may not be numeric. |
useSslBoolean!
|
Whether the source uses TLS. |
urlBaseString
|
URL base path, when reported. |
usernameString
|
Username, when reported. |
apiKeyPresentBoolean!
|
Whether an API key was returned by the source. |
dedupKeyString!
|
Stable identity used to deduplicate this candidate. |
supportedBoolean!
|
Whether Scryer can create this client type. |
requiresPasswordOverrideBoolean!
|
Whether an explicit password override is required. |
ExternalImportIndexerPayload
Section titled “ExternalImportIndexerPayload”Indexer candidate discovered during external import.
Fields
| Name | Description |
|---|---|
sourceKeys[String!]!
|
Source identities that reported this candidate. |
nameString!
|
Indexer name. |
implementationString!
|
Source implementation name. |
scryerProviderTypeString
|
Scryer provider type, or null when unsupported. |
baseUrlString
|
Indexer base URL, when reported. |
apiKeyPresentBoolean!
|
Whether an API key was returned by the source. |
dedupKeyString!
|
Stable identity used to deduplicate this candidate. |
supportedBoolean!
|
Whether Scryer can create this provider type. |
childCountInt!
|
Number of grouped child indexers. |
childNames[String!]!
|
Names of grouped child indexers. |
requiresApiKeyOverrideBoolean!
|
Whether an explicit API key override is required. |
apiKeyHelpUrlString
|
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
| Name | Description |
|---|---|
sessionIdID!
|
Warmup session ID. |
statusExternalImportMonitorWarmupStatusValue!
|
Warmup lifecycle status. |
phaseExternalImportMonitorWarmupPhaseValue!
|
Current warmup phase. |
startedAtDateTime!
|
Session start time in UTC. |
updatedAtDateTime!
|
Last progress update time in UTC. |
overallTotalKnownBoolean!
|
Whether the overall total is known. |
overallProgressLibraryScanPhaseProgressPayload!
|
Overall progress counters. |
moviesTotalKnownBoolean!
|
Whether the movie total is known. |
moviesProgressLibraryScanPhaseProgressPayload!
|
Movie loading progress counters. |
seriesTotalKnownBoolean!
|
Whether the series total is known. |
seriesProgressLibraryScanPhaseProgressPayload!
|
Series loading progress counters. |
episodeFetchTotalKnownBoolean!
|
Whether the episode fetch total is known. |
episodeFetchExpectedTotalInt
|
Expected episode count when known. |
episodeFetchExpectedMonitoredTotalInt
|
Expected monitored episode count when known. |
episodeFetchProgressLibraryScanPhaseProgressPayload!
|
Episode loading progress counters. |
snapshotBuildTotalKnownBoolean!
|
Whether snapshot-build totals are known. |
snapshotBuildProgressLibraryScanPhaseProgressPayload!
|
Snapshot-build progress counters. |
matchedMovieCountInt!
|
Number of matched movies. |
matchedSeriesCountInt!
|
Number of matched series. |
unmatchedMovieCountInt!
|
Number of unmatched movies. |
unmatchedSeriesCountInt!
|
Number of unmatched series. |
ambiguousMovieCountInt!
|
Number of ambiguous movies. |
ambiguousSeriesCountInt!
|
Number of ambiguous series. |
errorMessageString
|
Failure detail, or null when no error occurred. |
ExternalImportPreviewPayload
Section titled “ExternalImportPreviewPayload”External import candidates and source warmup results.
Fields
| Name | Description |
|---|---|
prowlarrConnectedBoolean!
|
Whether Prowlarr connected during preview construction. |
prowlarrVersionString
|
Prowlarr version, or null when unavailable. |
prowlarrErrorString
|
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. |
ExternalImportResultPayload
Section titled “ExternalImportResultPayload”Counts and errors produced by external import execution.
Fields
| Name | Description |
|---|---|
mediaPathsSavedBoolean!
|
Whether selected media paths were saved. |
downloadClientsCreatedInt!
|
Number of download clients created. |
indexersCreatedInt!
|
Number of indexers created. |
pluginsInstalled[String!]!
|
Plugin identifiers installed as part of the import. |
errors[String!]!
|
Errors encountered during execution. |
ExternalImportRootFolderPayload
Section titled “ExternalImportRootFolderPayload”Root folder reported by an external Arr source.
Fields
| Name | Description |
|---|---|
sourceWarmupSessionIdID!
|
Warmup session that reported the root. |
sourceKeyString!
|
Stable source identity. |
kindExternalArrSourceKind!
|
External source kind. |
arrRootPathString!
|
Root path reported by the source. |
ExternalImportSetupApiKeyOverridePayload
Section titled “ExternalImportSetupApiKeyOverridePayload”Download-client or indexer API key stored in an import draft.
Fields
| Name | Description |
|---|---|
dedupKeyString!
|
Stable candidate identity used for deduplication. |
apiKeyString!
|
Stored API key value for the draft. |
ExternalImportSetupInstanceApiKeyPayload
Section titled “ExternalImportSetupInstanceApiKeyPayload”API key entry returned from an external import secret draft.
Fields
| Name | Description |
|---|---|
instanceIdID!
|
External instance ID. |
kindExternalImportConnectionKind!
|
External service kind. |
apiKeyString!
|
Stored API key value for the draft. |
ExternalImportSetupPasswordOverridePayload
Section titled “ExternalImportSetupPasswordOverridePayload”Download-client password stored in an import draft.
Fields
| Name | Description |
|---|---|
dedupKeyString!
|
Stable candidate identity used for deduplication. |
passwordString!
|
Stored password value for the draft. |
ExternalImportSetupSecretDraftPayload
Section titled “ExternalImportSetupSecretDraftPayload”Secret values held in an external import setup draft.
Fields
| Name | Description |
|---|---|
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. |
updatedAtDateTime!
|
Last update time in UTC. |
ExternalImportSetupSecretDraftStatusPayload
Section titled “ExternalImportSetupSecretDraftStatusPayload”Ownership and existence status for the current user’s import secret draft.
Fields
| Name | Description |
|---|---|
hasDraftBoolean!
|
Whether a secret draft exists. |
ownedByCurrentUserBoolean!
|
Whether the draft belongs to the current user. |
updatedAtDateTime
|
Draft update time in UTC, or null when no draft exists. |
ExternalSubtitleBlocklistEntryPayload
Section titled “ExternalSubtitleBlocklistEntryPayload”Subtitle provider record blocked for a media file.
Fields
| Name | Description |
|---|---|
idID!
|
Blocklist entry ID. |
mediaFileIdID!
|
Media file ID affected by the blocklist entry. |
providerString!
|
Subtitle provider. |
providerFileIdString!
|
Provider subtitle file ID. |
languageString!
|
Blocked subtitle language code. |
reasonString
|
Blocklist reason, or null when none was recorded. |
createdAtDateTime!
|
Creation time in UTC. |
ExternalSubtitlePayload
Section titled “ExternalSubtitlePayload”Subtitle file downloaded for a media file.
Fields
| Name | Description |
|---|---|
idID!
|
Subtitle record ID. |
mediaFileIdID!
|
Media file ID containing the subtitle. |
titleIdID!
|
Title ID owning the media file. |
episodeIdID
|
Episode ID, or null for movie or series-level subtitles. |
sourceKindString!
|
Subtitle source category. |
languageString!
|
Subtitle language code. |
providerString
|
Subtitle provider, or null when provider metadata is unavailable. |
providerFileIdString
|
Provider subtitle file ID, or null when unavailable. |
filePathString!
|
Local subtitle file path. |
scoreInt
|
Provider score, when supplied. |
scorePercentInt
|
Provider score as a percentage, when supplied. |
hearingImpairedBoolean!
|
Whether the subtitle is marked for hearing-impaired viewers. |
forcedBoolean!
|
Whether the subtitle is forced. |
aiTranslatedBoolean!
|
Whether the subtitle was translated by an AI system. |
machineTranslatedBoolean!
|
Whether the subtitle was translated by a machine process. |
uploaderString
|
Provider uploader, or null when unavailable. |
releaseInfoString
|
Provider release information, or null when unavailable. |
syncedBoolean!
|
Whether the subtitle timing is synchronized. |
downloadedAtDateTime!
|
Download time in UTC. |
FacetScoringPersonaSelectionPayload
Section titled “FacetScoringPersonaSelectionPayload”Effective scoring-persona selection for one content scope.
Fields
| Name | Description |
|---|---|
scopeContentScopeValue!
|
Content scope to which the selection applies. |
overridePersonaScoringPersonaValue
|
Scope-specific persona override, or null when inherited. |
effectivePersonaScoringPersonaValue!
|
Effective scoring persona. |
inheritsGlobalBoolean!
|
Whether the effective persona comes from the global setting. |
FinalizeExternalImportPayload
Section titled “FinalizeExternalImportPayload”Accepted external import finalization and its monitor warmup session.
Fields
| Name | Description |
|---|---|
monitorWarmupSessionIdID!
|
Monitor warmup session ID tracking accepted background work. |
finalizeSessionIdID!
|
Session ID of the background apply; poll |
progressExternalImportMonitorWarmupProgressPayload!
|
Status of the background apply at the moment finalize was accepted. |
FixTitleMatchPayload
Section titled “FixTitleMatchPayload”Result of repairing a title match and any follow-up scan work.
Fields
| Name | Description |
|---|---|
titleTitlePayload!
|
Title after the identity repair. |
hydratedBoolean!
|
Whether metadata became available during the repair. |
libraryScanLibraryScanSummaryPayload
|
Library scan summary, or null when no scan was accepted or run. |
warnings[String!]!
|
Non-fatal warnings produced while repairing the match. |
FloatConfigValuePayload
Section titled “FloatConfigValuePayload”Stored floating-point provider configuration value.
Fields
| Name | Description |
|---|---|
valueFloat!
|
Floating-point value. |
FolderMatchTitleRefPayload
Section titled “FolderMatchTitleRefPayload”A title taking part in a folder-match correction.
Fields
| Name | Description |
|---|---|
idID!
|
Title identity. |
nameString!
|
Title display name. |
folderPathString
|
Folder this title owns, or null when it owns none. |
ForceGrabPendingReleasePayload
Section titled “ForceGrabPendingReleasePayload”Result of requesting an immediate grab for a pending release.
Fields
| Name | Description |
|---|---|
idID!
|
Pending release ID. |
grabbedBoolean!
|
Whether the release was accepted for grabbing. |
GeneralSettingsPayload
Section titled “GeneralSettingsPayload”General service settings, including effective image-cache limits and trusted certificate data.
Fields
| Name | Description |
|---|---|
apiExplorerEnabledBoolean!
|
Whether administrators may use the API explorer. |
experimentalFeaturesEnabledBoolean!
|
Whether surfaces that are still being finished are shown on this instance. |
personalizedDiscoveryEnabledBoolean!
|
Whether this instance sends its library context to the metadata gateway for personalized discovery. |
srrdbFilenameRecoveryEnabledBoolean!
|
Whether automatic SABnzbd and NZBGet imports may ask srrdb.com to recover obfuscated filenames. |
keepHistoryForeverBoolean!
|
Whether import history is retained indefinitely. |
historyRetentionDaysInt!
|
History retention period in days when indefinite retention is false. |
imageCacheMaxSizeMbInt!
|
Configured image-cache maximum in megabytes. |
effectiveImageCacheMaxSizeBytesLong!
|
Effective image-cache maximum in bytes after environment overrides. |
effectiveImageCacheMaxSizeMbFloat!
|
Effective image-cache maximum in megabytes after environment overrides. |
imageCacheMaxSizeEnvOverrideActiveBoolean!
|
Whether an environment variable overrides the configured image-cache limit. |
pluginHttpCaBundlePemString!
|
PEM CA bundle used for plugin HTTP requests. |
pluginHttpTrustedCertificates[PluginHttpTrustedCertificatePayload!]!
|
Additional trusted plugin HTTP certificates. |
IgnorePendingImportPayload
Section titled “IgnorePendingImportPayload”Result of ignoring one pending import.
Fields
| Name | Description |
|---|---|
idID!
|
Pending-import item ID. |
statusPendingImportStatusValue!
|
Status after the ignore operation. |
ImportRecordPayload
Section titled “ImportRecordPayload”Persisted import record with lifecycle status, decision, IDs, and UTC timestamps.
Fields
| Name | Description |
|---|---|
idID!
|
Import record ID. |
sourceSystemString!
|
External system that supplied the import. |
sourceRefString!
|
Source-system reference identifying the download or item. |
sourceTitleString
|
Source title, or null when unavailable. |
facetMediaFacetValue
|
Media facet, or null when not yet classified. |
importTypeImportTypeValue!
|
Import operation type. |
statusImportStatusValue!
|
Current import lifecycle status. |
errorMessageString
|
Error message, or null when no error is recorded. |
decisionImportDecisionValue
|
Import decision, or null before a decision is made. |
skipReasonImportSkipReasonValue
|
Skip reason, or null when not skipped. |
titleIdID
|
Bound title ID, or null when no title was selected. |
sourcePathString
|
Source path, or null when not recorded. |
destPathString
|
Destination path, or null when no destination was produced. |
startedAtDateTime
|
UTC start time, or null before processing begins. |
finishedAtDateTime
|
UTC completion time, or null while incomplete. |
createdAtDateTime!
|
UTC record creation time. |
ImportResultPayload
Section titled “ImportResultPayload”Result of one import operation, including decision and source/destination paths.
Fields
| Name | Description |
|---|---|
importIdID!
|
Import record ID. |
decisionImportDecisionValue!
|
Final import decision. |
skipReasonImportSkipReasonValue
|
Skip reason when the decision skipped the import, or null otherwise. |
titleIdID
|
Imported title ID, or null when no title was bound. |
sourcePathString!
|
Source path examined by the import. |
destPathString
|
Destination path written by the import, or null when no destination was written. |
errorMessageString
|
Error message, or null when the operation completed without an error. |
IndexerCapsCategoryPayload
Section titled “IndexerCapsCategoryPayload”One category the indexer advertises in its caps document, used to offer indexer-specific routing categories that the standard newznab tree lacks.
Fields
| Name | Description |
|---|---|
codeString!
|
Category id exactly as the indexer expects it in the |
labelString
|
Human-readable name from the caps document, or null when it has none. |
IndexerConfigPayload
Section titled “IndexerConfigPayload”Indexer configuration, health, capability, routing, and masked secret metadata.
Fields
| Name | Description |
|---|---|
idID!
|
Indexer configuration ID. |
nameString!
|
User-facing indexer name. |
providerTypeString!
|
Stable provider implementation key for this indexer. |
baseUrlString!
|
Indexer base URL. |
proxyConfigIdID
|
Optional proxy configuration ID used by this indexer. |
downloadClientIdID
|
Optional download-client ID associated with this indexer. |
seedingProfileIdID
|
Optional seeding profile ID applied to torrents grabbed from this indexer. |
hasProwlarrSeedCriteriaBoolean!
|
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. |
prowlarrMinimumSeedersInt
|
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. |
hasApiKeyBoolean!
|
Whether an API key is configured without exposing it. |
isManagedBoolean!
|
Whether this configuration is managed by a parent configuration. |
managedParentConfigIdID
|
Parent managed configuration ID, or null when independent. |
supportsManagedChildrenSyncBoolean!
|
Whether managed child synchronization is supported. |
storedSecretKeys[String!]!
|
Names of stored secret fields, never their values. |
rateLimitSecondsInt
|
Minimum interval between requests in seconds, or null when unlimited. |
rateLimitBurstInt
|
Maximum burst size for rate limiting, or null when unspecified. |
disabledUntilDateTime
|
UTC time until which the indexer is disabled, or null when not disabled. |
isEnabledBoolean!
|
Whether the indexer is enabled. |
enableInteractiveSearchBoolean!
|
Whether interactive searches are enabled. |
enableAutoSearchBoolean!
|
Whether automatic searches are enabled. |
lastHealthStatusString
|
Most recent health status, or null before the first check. |
lastErrorMessageString
|
Most recent health error, or null when none is recorded. |
lastErrorAtDateTime
|
UTC time of the most recent health error, or null when none is recorded. |
lastQueryAtDateTime
|
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. |
createdAtDateTime!
|
UTC creation time. |
updatedAtDateTime!
|
UTC last-update time. |
IndexerConfigSyncPayload
Section titled “IndexerConfigSyncPayload”IDs created, updated, and deleted while synchronizing managed indexer configurations.
Fields
| Name | Description |
|---|---|
parentConfigIdID!
|
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
| Name | Description |
|---|---|
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. |
IndexerDownloadClientMappingClientPayload
Section titled “IndexerDownloadClientMappingClientPayload”Download client option used by the indexer mapping catalog.
Fields
| Name | Description |
|---|---|
idID!
|
Download client ID. |
nameString!
|
Download client name. |
clientTypeString!
|
Download client provider type. |
isEnabledBoolean!
|
Whether the client is enabled. |
healthStatusString!
|
Current health status string. |
IndexerDownloadClientMappingIndexerPayload
Section titled “IndexerDownloadClientMappingIndexerPayload”Indexer mapping state and compatible download-client IDs.
Fields
| Name | Description |
|---|---|
idID!
|
Indexer configuration ID. |
nameString!
|
Indexer name. |
downloadClientIdID
|
Currently mapped download-client ID, or null when unmapped. |
protocolFamilies[String!]!
|
Protocol families supported by the indexer. |
supportsMappingBoolean!
|
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
| Name | Description |
|---|---|
providerTypeString!
|
Stable indexer provider implementation key. |
protocolFamilies[String!]!
|
Protocol families supported by the provider. |
supportsMappingBoolean!
|
Whether the provider supports explicit mapping. |
compatibleClientIds[ID!]!
|
Compatible download-client IDs. |
IndexerErrorConnectionPayload
Section titled “IndexerErrorConnectionPayload”A newest-first page of persisted indexer errors.
Fields
| Name | Description |
|---|---|
items[IndexerErrorSummaryPayload!]!
|
Error events in newest-first order. |
nextCursorString
|
Cursor for the following page, or null at the end of the result set. |
IndexerErrorDetailPayload
Section titled “IndexerErrorDetailPayload”A persisted error event and, when available, its complete HTTP response.
Fields
| Name | Description |
|---|---|
errorIndexerErrorSummaryPayload!
|
List-safe metadata for the error event. |
responseIndexerErrorResponsePayload
|
Complete response data when the upstream returned one. |
IndexerErrorHeaderPayload
Section titled “IndexerErrorHeaderPayload”One raw response header retained for privileged diagnostics.
Fields
| Name | Description |
|---|---|
nameString!
|
Original response header name. |
valueBase64String!
|
Raw header value encoded as base64. |
valueString
|
Raw header value when it is valid UTF-8. |
IndexerErrorResponsePayload
Section titled “IndexerErrorResponsePayload”Complete persisted HTTP response retained for privileged diagnostics.
Fields
| Name | Description |
|---|---|
statusInt!
|
Original HTTP status code. |
headers[IndexerErrorHeaderPayload!]!
|
Repeated raw response headers in their retained order. |
bodyBase64String!
|
Raw response body encoded as base64. |
IndexerErrorSummaryPayload
Section titled “IndexerErrorSummaryPayload”List-safe metadata for a persisted indexer error.
Fields
| Name | Description |
|---|---|
idID!
|
Stable error-event identifier. |
indexerIdID!
|
Configured indexer identifier captured with the event. |
indexerNameString!
|
Indexer name captured when the event occurred. |
operationIndexerErrorOperationValue!
|
Operation that received the failed response. |
occurredAtString!
|
RFC 3339 time at which the response was accepted. |
httpStatusInt
|
HTTP response status code, when the upstream returned a response. |
classificationIndexerErrorClassificationValue!
|
Safe error classification derived from the response. |
providerErrorCodeInt
|
Newznab provider code when a known Newznab error was recognized. |
messageString!
|
Canonical safe error message that excludes response-body text. |
contentTypeString
|
Response Content-Type header when it was valid UTF-8. |
IndexerQueryStatsPayload
Section titled “IndexerQueryStatsPayload”Query and quota counters for one indexer.
Fields
| Name | Description |
|---|---|
indexerIdID!
|
ID of the indexer. |
indexerNameString!
|
Configured indexer name. |
queriesLast24HInt!
|
Queries during the trailing 24 hours. |
successfulLast24HInt!
|
Successful queries during the trailing 24 hours. |
failedLast24HInt!
|
Failed queries during the trailing 24 hours. |
grabsLast24HInt!
|
Releases grabbed through this indexer during the trailing 24 hours, counted by Scryer rather than reported by the provider. |
lastQueryAtDateTime
|
UTC time of the most recent query, or null when never queried. |
apiRequestsTodayInt!
|
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. |
apiRequestsWindowStartedAtDateTime
|
UTC time the current api_requests_today window opened, or null when the counter has never been persisted. |
apiRequestsObservedSinceDateTime
|
UTC time corrected Scryer-owned API request observation began. The first UTC day is partial. |
apiCurrentInt
|
Current API request count, or null when not reported. |
apiMaxInt
|
API request limit, or null when not reported. |
grabCurrentInt
|
Current grab count, or null when not reported. |
grabMaxInt
|
Grab limit, or null when not reported. |
IndexerRoutingEntryPayload
Section titled “IndexerRoutingEntryPayload”Indexer routing behavior for one indexer.
Fields
| Name | Description |
|---|---|
indexerIdID!
|
Indexer configuration ID. |
enabledBoolean!
|
Whether this route is enabled. |
categories[String!]!
|
Categories accepted by this route. |
priorityInt!
|
Relative routing priority. |
IndexerSearchResultPayload
Section titled “IndexerSearchResultPayload”Indexer search result with parsed release metadata, scoring, and queue eligibility.
Fields
| Name | Description |
|---|---|
sourceString!
|
Indexer source name. |
indexerIdID
|
Indexer configuration identity that returned the release, or null when unknown. |
titleString!
|
Release title shown by the indexer. |
linkString
|
Informational release link, or null when unavailable. |
downloadUrlString
|
Direct download URL, or null when unavailable. |
sourceKindDownloadSourceKindValue
|
Source kind such as Usenet or torrent, or null when unknown. |
sizeBytesLong
|
Release size in bytes, or null when unknown. |
publishedAtDateTime
|
Publication time in UTC, or null when unavailable. |
thumbsUpInt
|
Positive vote count, or null when not reported. |
thumbsDownInt
|
Negative vote count, or null when not reported. |
grabsInt
|
Grab count reported by the indexer, or null when not reported. |
parsedReleaseParsedReleasePayload
|
Parsed release fields, or null when parsing did not produce a result. |
qualityProfileDecisionQualityProfileDecisionPayload
|
Quality-profile decision, or null when no profile was evaluated. |
seedersInt
|
Torrent seeder count, or null for non-torrent results. |
peersInt
|
Torrent peer count, or null for non-torrent results. |
infoHashString
|
Torrent info hash, or null for non-torrent results. |
freeleechBoolean
|
Whether the torrent is marked freeleech, or null for non-torrent results. |
downloadVolumeFactorFloat
|
Torrent download volume factor, or null for non-torrent results. |
candidateTokenString
|
Opaque token accepted when queuing this candidate, or null when unavailable. |
queueScopeQueueDownloadScopePayload
|
Acquisition scope targeted by this result, or null when no scope was inferred. |
autoEligibleBoolean
|
Whether automatic acquisition may select this result. |
autoDecisionCodeString
|
Automatic acquisition decision code, or null when not evaluated. |
autoDecisionSummaryString
|
Human-readable automatic acquisition decision summary, or null when not evaluated. |
InstanceFeaturesPayload
Section titled “InstanceFeaturesPayload”Instance-wide feature switches readable by any signed-in user.
Fields
| Name | Description |
|---|---|
apiExplorerEnabledBoolean!
|
Whether the API explorer is enabled and the current user may access it. |
experimentalFeaturesEnabledBoolean!
|
Whether surfaces that are still being finished are shown on this instance. |
personalizedDiscoveryEnabledBoolean!
|
Whether this instance sends its library context to the metadata gateway for personalized discovery. |
IntConfigValuePayload
Section titled “IntConfigValuePayload”Stored integer provider configuration value.
Fields
| Name | Description |
|---|---|
valueInt!
|
Signed integer value. |
InteractiveReleaseSearchIndexerPayload
Section titled “InteractiveReleaseSearchIndexerPayload”Per-indexer progress and result count for an interactive release search.
Fields
| Name | Description |
|---|---|
indexerIdID!
|
Indexer configuration ID. |
nameString!
|
Indexer name. |
priorityInt!
|
Routing priority for this indexer; 0 when routing states none. |
statusInteractiveReleaseSearchIndexerStatusValue!
|
Current indexer lifecycle state. |
resultCountInt!
|
The indexer's own result count (before cross-indexer dedup). |
elapsedMsInt
|
Wall time of this indexer's own call in milliseconds, or null before it answered. |
failureReasonString
|
Failure reason, or null when the indexer did not fail. |
InteractiveReleaseSearchPayload
Section titled “InteractiveReleaseSearchPayload”Pollable snapshot of an interactive release-search job with partial results.
Fields
| Name | Description |
|---|---|
idID!
|
Interactive release-search job ID. |
stateInteractiveReleaseSearchStateValue!
|
Current search lifecycle state. |
results[IndexerSearchResultPayload!]!
|
Scored, cross-indexer-deduped snapshot of the merged results so far. |
indexers[InteractiveReleaseSearchIndexerPayload!]!
|
Per-indexer progress states. |
startedAtDateTime!
|
UTC search start time. |
completedAtDateTime
|
UTC completion time, or null while running. |
JellyfinServerUserPayload
Section titled “JellyfinServerUserPayload”User discovered on a Jellyfin server.
Fields
| Name | Description |
|---|---|
idString!
|
Server-side user identity. |
usernameString!
|
Username on the server. |
displayNameString
|
Optional display name. |
avatarUrlString
|
Optional avatar URL. |
JobDefinitionPayload
Section titled “JobDefinitionPayload”Metadata describing a configured job.
Fields
| Name | Description |
|---|---|
keyJobKeyValue!
|
Stable job key. |
displayNameString!
|
Display name of the job. |
descriptionString!
|
Human-readable job description. |
categoryJobCategoryValue!
|
Broad job category. |
sectionJobSectionValue!
|
Job section. |
manualTriggerAllowedBoolean!
|
Whether an explicit trigger is allowed. |
usesLibraryScanProgressBoolean!
|
Whether the run reports library-scan progress. |
scheduleJobScheduleInfoPayload!
|
Configured schedule details. |
JobRunPayload
Section titled “JobRunPayload”Current status and progress of one job run.
Fields
| Name | Description |
|---|---|
idID!
|
ID of the job run. |
jobKeyJobKeyValue!
|
Stable key of the job being run. |
displayNameString!
|
Display name of the job. |
categoryJobCategoryValue!
|
Broad job category. |
sectionJobSectionValue!
|
Job section. |
statusJobRunStatusValue!
|
Current run status. |
triggerSourceJobTriggerSourceValue!
|
Source that started the run. |
startedAtDateTime!
|
UTC time when the run started. |
completedAtDateTime
|
UTC completion time, or null while the run is active. |
summaryJsonJSON
|
Structured result summary, or null before completion or when unavailable. |
summaryTextString
|
Human-readable result summary, or null when unavailable. |
errorTextString
|
Failure detail, or null when the run has not failed. |
progressJsonJSON
|
Structured progress data, or null when the job does not expose it. |
libraryScanProgressLibraryScanProgressPayload
|
Library-scan progress, or null for jobs without scan progress. |
JobScheduleInfoPayload
Section titled “JobScheduleInfoPayload”Schedule details for a job definition.
Fields
| Name | Description |
|---|---|
kindJobScheduleKindValue!
|
Schedule kind. |
descriptionString!
|
Human-readable schedule description. |
intervalSecondsInt
|
Repeat interval in seconds, or null for non-interval schedules. |
initialDelaySecondsInt
|
Initial delay in seconds, or null when not applicable. |
nextRunAtDateTime
|
Next scheduled run as a UTC timestamp, or null when no run is scheduled. |
LibraryPathsPayload
Section titled “LibraryPathsPayload”Filesystem paths used by the three supported media facets.
Fields
| Name | Description |
|---|---|
moviePathString!
|
Movie library path. |
seriesPathString!
|
Series library path. |
animePathString!
|
Anime library path. |
LibraryPayload
Section titled “LibraryPayload”Library identity, facet, and configured storage roots.
Fields
| Name | Description |
|---|---|
idID!
|
Stable library identifier. |
facetMediaFacetValue!
|
Media facet managed by the library. |
nameString!
|
Display name of the library. |
slugString!
|
Stable URL-friendly library key. |
isDefaultBoolean!
|
Whether this is the configured default library for its facet. |
isBootstrapDefaultRootSetBoolean!
|
Whether the library was created by bootstrap root-folder setup. |
roots[LibraryRootPayload!]!
|
Root folders configured for the library. |
qualityProfileIdID!
|
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. |
requestQualityProfileDefaultIdID!
|
Default request quality-profile ID, selected from the library's effective allowed profiles. |
settingsLibrarySettingsPayload!
|
Effective library settings; requires library-management permission. |
LibraryRootPayload
Section titled “LibraryRootPayload”Library root-folder identity, path, and default marker.
Fields
| Name | Description |
|---|---|
idID!
|
Root-folder ID. |
pathString!
|
Filesystem path. |
isDefaultBoolean!
|
Whether this is the default root folder. |
LibraryScanPhaseProgressPayload
Section titled “LibraryScanPhaseProgressPayload”Counts for one phase of a library scan.
Fields
| Name | Description |
|---|---|
totalInt!
|
Total units in this phase; zero is valid when no work was found. |
completedInt!
|
Units completed so far. |
failedInt!
|
Units that failed in this phase. |
LibraryScanProgressPayload
Section titled “LibraryScanProgressPayload”Progress snapshot for one library scan.
Fields
| Name | Description |
|---|---|
sessionIdID!
|
ID of the scan session. |
facetMediaFacetValue!
|
Media facet being scanned. |
libraryIdID
|
ID of the library being scanned, or null for all libraries in the facet. |
modeLibraryScanModeValue!
|
Scan mode. |
statusLibraryScanStatusValue!
|
Current scan status. |
startedAtDateTime!
|
UTC time when the scan started. |
updatedAtDateTime!
|
UTC time when the progress snapshot was updated. |
foundTitlesInt!
|
Number of titles found so far. |
titleMatchTotalKnownBoolean!
|
Whether the total title-match count is known. |
titleMatchProgressLibraryScanPhaseProgressPayload!
|
Title matching progress counts. |
hydrationTotalKnownBoolean!
|
Whether the total hydration count is known. |
hydrationProgressLibraryScanPhaseProgressPayload!
|
Metadata hydration progress counts. |
mediaAnalysisTotalKnownBoolean!
|
Whether the total media-analysis count is known. |
mediaAnalysisProgressLibraryScanPhaseProgressPayload!
|
Media-analysis progress counts. |
summaryLibraryScanSummaryPayload
|
Final scan summary, or null until a summary is available. |
LibraryScanSummaryPayload
Section titled “LibraryScanSummaryPayload”Counts produced by a library scan.
Fields
| Name | Description |
|---|---|
scannedInt!
|
Number of files or records scanned. |
matchedInt!
|
Number matched to known titles. |
importedInt!
|
Number imported successfully. |
skippedInt!
|
Number skipped by scan or import policy. |
unmatchedInt!
|
Number left unmatched. |
LibrarySettingsPayload
Section titled “LibrarySettingsPayload”Effective library settings together with nullable per-library overrides.
Fields
| Name | Description |
|---|---|
requiredAudioLanguagesOverride[String!]
|
Library override for required audio language codes; |
requiredAudioLanguages[String!]!
|
Effective configured requirements after inheritance; |
metadataLanguageOverrideString
|
Library metadata-language override; null means inherit the global default. |
metadataLanguageString!
|
Effective metadata language after inheritance. |
useSeasonFoldersOverrideBoolean
|
Library override for season folders; null means inherit the facet setting. |
useSeasonFoldersBoolean!
|
Effective season-folder setting after inheritance. |
qualityProfileIdOverrideID
|
Library override quality-profile ID; null means inherit. |
qualityProfileIdID!
|
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. |
requestQualityProfileDefaultIdID!
|
Effective default request quality-profile ID. |
scoringPersonaOverrideScoringPersonaValue
|
Library override scoring persona; null means inherit. |
scoringPersonaScoringPersonaValue!
|
Effective scoring persona. |
fillerPolicyOverrideFillerPolicyValue
|
Library override filler policy; null means inherit. |
fillerPolicyFillerPolicyValue
|
Effective filler policy, or null when unset. |
recapPolicyOverrideRecapPolicyValue
|
Library override recap policy; null means inherit. |
recapPolicyRecapPolicyValue
|
Effective recap policy, or null when unset. |
monitorSpecialsOverrideBoolean
|
Library override for monitoring specials; null means inherit. |
monitorSpecialsBoolean
|
Effective specials monitoring setting, or null when unset. |
interSeasonMoviesOverrideBoolean
|
Library override for inter-season movies; null means inherit. |
interSeasonMoviesBoolean
|
Effective inter-season movie setting, or null when unset. |
monitorFillerMoviesOverrideBoolean
|
Library override for filler movies; null means inherit. |
monitorFillerMoviesBoolean
|
Effective filler-movie monitoring setting, or null when unset. |
nfoWriteOnImportOverrideBoolean
|
Library override for NFO writing; null means inherit. |
nfoWriteOnImportBoolean!
|
Effective NFO-on-import setting. |
plexmatchWriteOnImportOverrideBoolean
|
Library override for Plex match writing; null means inherit. |
plexmatchWriteOnImportBoolean
|
Effective Plex match-on-import setting, or null when unset. |
importModeOverrideImportModeValue
|
Library override import mode; null means inherit. |
importModeImportModeValue!
|
Effective import mode. |
setPermissionsLinuxOverrideBoolean
|
Library override for Linux permission updates; null means inherit. |
setPermissionsLinuxBoolean!
|
Effective Linux permission-update setting. |
fileChmodOverrideString
|
Library override file chmod mode; null means inherit. |
fileChmodString
|
Effective file chmod mode, or null when unset. |
folderChmodOverrideString
|
Library override folder chmod mode; null means inherit. |
folderChmodString
|
Effective folder chmod mode, or null when unset. |
chownGroupOverrideString
|
Library override chown group; null means inherit. |
chownGroupString
|
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. |
LinkedAccountPayload
Section titled “LinkedAccountPayload”External account link summary without provider credentials.
Fields
| Name | Description |
|---|---|
idID!
|
ID of the linked account. |
userIdID!
|
ID of the linked local user. |
providerExternalAccountProviderValue!
|
External provider. |
connectionIdID!
|
ID of the configured media-server connection. |
externalUserIdString
|
Provider-specific user ID, or null when unavailable. |
usernameString!
|
Provider username. |
displayNameString
|
Provider display name, or null when unavailable. |
avatarUrlString
|
Provider avatar URL, or null when unavailable. |
statusExternalAccountStatusValue!
|
Current link status. |
verifiedAtDateTime
|
UTC verification time, or null when not verified. |
lastLoginAtDateTime
|
UTC time of the last successful login, or null when unused. |
createdAtDateTime!
|
UTC time when the link was created. |
updatedAtDateTime!
|
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
| Name | Description |
|---|---|
titleIdID!
|
The candidate destination title. |
titleNameString!
|
Its name in the destination library. |
sharedIdentities[String!]!
|
The identities both titles carry, as |
LocationBlockedTitlePayload
Section titled “LocationBlockedTitlePayload”One title that cannot enter a root-scoped operation, named rather than silently dropped (FR-023).
Fields
| Name | Description |
|---|---|
titleIdID!
|
The title that is blocked. |
titleNameString!
|
Its name, so the ledger reads as titles rather than as ids. |
reasonString!
|
The sentence explaining what has to be repaired. |
reasonCodeString
|
Machine-readable reason, for grouping and translation. |
LocationClassificationGroupPayload
Section titled “LocationClassificationGroupPayload”One classification group: a class, its count, and the titles in it.
Fields
| Name | Description |
|---|---|
classTitleLocationClassValue!
|
Class shared by every title in this group. |
countLong!
|
How many selected titles fall into this class. |
titles[LocationClassifiedTitlePayload!]!
|
The titles in this class, in selection order. |
LocationClassifiedTitlePayload
Section titled “LocationClassifiedTitlePayload”One selected title and the class it was previewed as.
Fields
| Name | Description |
|---|---|
titleIdID!
|
Selected title identity. |
classTitleLocationClassValue!
|
Class this title falls into for the requested destination. |
sourceLibraryIdID!
|
Library this title lives in today. |
sourceRootIdID!
|
Root this title lives on today. |
sourceFolderPathString
|
Folder this title owns today, or null when it owns none. |
destinationLibraryIdID!
|
Library this title would end up in. |
destinationRootIdID!
|
Root this title would end up on. |
reasonCodeString
|
Machine-readable reason for the class, for grouping and translation. |
reasonString
|
Human-readable explanation, always present for blocking classes. |
blocksStartBoolean!
|
Whether this title stops the operation from starting. |
destinationIdentityMatchLocationDestinationIdentityMatchValue
|
What destination-title detection concluded, or null when the title stays in its own library and no detection was run. |
mergeTargetTitleIdID
|
The existing destination title this title merges into, or null for a transfer into a title the destination library does not have yet. |
mergeTargetTitleNameString
|
Name of that destination title, so the preview can say "merges into “X”"
rather than printing an id. Null whenever |
sameNamedDestinationTitleIdID
|
A destination title carrying the same name but no shared identity, or null when there is none. It is never merged into automatically. |
sameNamedDestinationTitleNameString
|
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. |
facetConversionLocationFacetConversionPayload
|
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
| Name | Description |
|---|---|
movingIntoUnusedFoldersLong!
|
Titles moving into destination folders nothing occupies. |
mergingWithDestinationTitlesLong!
|
Titles merging with a destination title they share an identity with. |
folderNameCollisionsLong!
|
Folder names already taken at the destination, so the incoming folder gets a unique previewed name. |
mediaCollisionsLong!
|
Media files whose destination name is already taken. |
dedupEligibleFilesLong!
|
Source files proven identical to destination content, so they are recycled rather than copied. |
companionCollisionsLong!
|
Companion assets whose destination name is already taken. |
untrackedSourceEntriesLong!
|
Entries beneath the source root that no title accounts for. |
catalogOnlyLong!
|
Titles with no tracked files: catalog reassignment only (FR-076). |
blockedLong!
|
Titles that cannot enter the operation. |
LocationDefaultRootTransferPayload
Section titled “LocationDefaultRootTransferPayload”Which root new content lands on after a consolidation (FR-022).
Fields
| Name | Description |
|---|---|
sourceWasDefaultBoolean!
|
Whether the root being folded away was the library default. |
destinationWasDefaultBoolean!
|
Whether the destination root was already the library default. |
destinationBecomesDefaultBoolean!
|
Whether the destination root is the library default afterwards. |
transfersTheDefaultBoolean!
|
Whether the default actually moves. Say so out loud when it does. |
LocationFacetConversionPayload
Section titled “LocationFacetConversionPayload”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
| Name | Description |
|---|---|
fromFacetMediaFacetValue!
|
The facet the title carries today. |
toFacetMediaFacetValue!
|
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. |
filesKeepTheirNamesString!
|
FR-058, as the sentence the preview shows: the conversion recalculates the folder name only. |
LocationFacetConvertedSettingPayload
Section titled “LocationFacetConvertedSettingPayload”One title-level setting the facet conversion affects, named individually so the client lists them rather than showing a blanket sentence (FR-057).
Fields
| Name | Description |
|---|---|
settingString!
|
Stable machine key for the setting, for grouping and translation. |
labelString!
|
Human-readable name of the setting. |
valueString
|
The value the title carries today, or null when it carries none explicitly and the conversion changes which default applies. |
dispositionLocationFacetSettingDispositionValue!
|
Whether the setting becomes invalid, resets, or changes meaning. |
detailString!
|
The sentence explaining the consequence. |
LocationFreeSpaceEstimatePayload
Section titled “LocationFreeSpaceEstimatePayload”Estimated free space the operation needs, including recycle-copy cost.
Fields
| Name | Description |
|---|---|
destinationRequiredBytesLong!
|
Bytes that must be free on the destination volume. |
destinationTotalRequiredBytesLong!
|
Destination requirement including the recycle cost when the bin shares that volume. |
destinationAvailableBytesLong
|
Bytes free on the destination volume, or null when it was not probed. |
recycleRequiredBytesLong!
|
Bytes that must be free wherever the recycle bin lives. |
recycleAvailableBytesLong
|
Bytes free on the recycle volume, or null when it was not probed. |
sameVolumeMoveBoolean!
|
Whether the move is a same-volume rename that needs no destination space. |
recycleOnOtherVolumeBoolean!
|
Whether recycling copies bytes because the bin is on another volume. |
recycleSharesDestinationVolumeBoolean!
|
Whether the recycle bin shares the destination volume. |
recyclingAvailableBoolean!
|
Whether recycling is configured and available for this operation. |
probedBoolean!
|
Whether the volumes behind this estimate were actually probed. |
sufficientBoolean
|
Whether the space suffices, or null when it could not be determined. |
LocationMergeBlockedRecordPayload
Section titled “LocationMergeBlockedRecordPayload”One record the merge engine could not map, so the merge cannot run (FR-066).
Fields
| Name | Description |
|---|---|
tableString!
|
The table whose source rows cannot be carried. |
reasonLocationMergeBlockReasonValue!
|
Why the record blocks the merge. |
sourceIdID!
|
The source identity that could not be mapped. |
detailString!
|
The sentence explaining what would otherwise be guessed at. |
LocationMergePreviewPayload
Section titled “LocationMergePreviewPayload”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
| Name | Description |
|---|---|
sourceTitleIdID!
|
The title that merges away. |
destinationTitleIdID!
|
The title that survives. |
destinationTitleNameString
|
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. |
sourceLibraryIdID
|
Library the merging title comes from. |
destinationLibraryIdID
|
Library the surviving title lives in. |
blockedBoolean!
|
Whether unmappable records stop this merge from running. |
blockedRecords[LocationMergeBlockedRecordPayload!]!
|
The records that block it, one per line the user can act on. |
mediaFilesRepointedLong!
|
Media file records repointed onto the surviving title. |
roleChanges[LocationMergeRoleChangePayload!]!
|
Every media-file role the merge changes. |
roleDemotionsLong!
|
How many of those role changes demote an incoming primary. |
historyRowsCarriedLong!
|
History rows carried onto the surviving title. |
sourceRecordsDroppedLong!
|
Everything else recorded against the merging title, as one count. Those rows retire with it. |
LocationMergeRoleChangePayload
Section titled “LocationMergeRoleChangePayload”One media-file role the merge resolves, never silently (FR-068 to FR-070).
Fields
| Name | Description |
|---|---|
fileIdID!
|
The media file whose role changes. |
sourceEpisodeIdID
|
The source episode the file was attached to. Null for a movie, whose only slot is the title itself. |
destinationEpisodeIdID
|
The destination episode it is attached to after the merge. Null for a movie. |
previousRoleLocationMergeMediaRoleValue!
|
The role it held. |
newRoleLocationMergeMediaRoleValue!
|
The role it holds after the merge. |
reasonLocationMergeRoleChangeReasonValue!
|
Why the role changed. |
detailString!
|
The sentence the preview shows for this change. |
episodeLabelString
|
The destination episode as a person would say it ( |
fileNameString
|
The file's name on disk, without its folder. Null when the catalog row could not name it. |
LocationOperationAssetListingPayload
Section titled “LocationOperationAssetListingPayload”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
| Name | Description |
|---|---|
operationIdID!
|
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. |
renamesTotalLong!
|
Renames the confirmed plan carries across every title. |
renamesDoneLong!
|
How many of those have happened. |
dedupsTotalLong!
|
Deduplications the confirmed plan carries across every title. |
dedupsDoneLong!
|
How many of those have happened. |
LocationOperationCountersPayload
Section titled “LocationOperationCountersPayload”Aggregate counters for a running or finished operation.
Fields
| Name | Description |
|---|---|
titlesTotalLong!
|
Titles the confirmed plan covers. |
titlesProcessedLong!
|
Titles the operation has finished processing. |
titlesBlockedLong!
|
Titles that could not enter the operation. |
filesTotalLong!
|
Files the confirmed plan covers. |
filesProcessedLong!
|
Files the operation has finished processing. |
bytesTotalLong!
|
Bytes the confirmed plan covers. |
bytesProcessedLong!
|
Bytes the operation has finished processing. |
mergesLong!
|
Titles merged into an existing destination title. |
dedupsLong!
|
Files recycled as proven duplicates. |
renamesLong!
|
Files renamed to avoid a collision. |
noOpsLong!
|
Titles that needed no change. |
unresolvedLong!
|
Items still needing a user decision. |
LocationOperationDeduplicatedAssetPayload
Section titled “LocationOperationDeduplicatedAssetPayload”One source file proven identical to destination content, so it is recycled instead of copied.
Fields
| Name | Description |
|---|---|
sourcePathString!
|
Path of the redundant source copy. |
sourceNameString!
|
Its file name. |
survivingPathString
|
Path of the destination copy that survives, or null when the plan does not carry enough placement to name it. |
survivingNameString
|
File name of that survivor. |
doneBoolean!
|
Whether this deduplication has happened. False means the title carrying it has not settled yet, so the source copy is still in place. |
LocationOperationPayload
Section titled “LocationOperationPayload”A confirmed location operation and everything Activity shows about it.
Fields
| Name | Description |
|---|---|
idID!
|
Operation identity. |
operationTypeLocationOperationTypeValue!
|
Which location workflow this operation belongs to. |
modeLocationExecutionModeValue!
|
How the filesystem side is performed. |
stateLocationOperationStateValue!
|
Lifecycle state. |
initiatedByUserIdID
|
User who confirmed the operation, or null once that user is deleted. |
sourceLibraryIdID
|
Source library, when the operation is scoped to one. |
destinationLibraryIdID
|
Destination library; differs from the source only for transfers. |
sourceRootIdID
|
Source root, for root-scoped operations. |
destinationRootIdID
|
Destination root. |
planFingerprintString!
|
Fingerprint of the full confirmed plan. |
verificationDepthVerificationDepthValue!
|
Depth the user's preference asked for at confirmation time. |
verificationFallbackCountLong!
|
Files that could only be proven at the quick floor. |
countersLocationOperationCountersPayload!
|
Aggregate counters shown in Activity. |
detailString
|
Concise failure or warning explanation. |
reasonCodeString
|
Machine-readable reason the operation stopped short, for guidance and
translation: |
jobRunIdID
|
The Activity job run this operation reports through, when it has one. |
workflowOperationIdID
|
The workflow-operation row this operation reports through, when it has one. |
cancelRequestedBoolean!
|
Whether a cancel was requested. |
cancelRequestedAtDateTime
|
When the cancel was requested. |
confirmedAtDateTime
|
When the user confirmed the fingerprinted plan. |
startedAtDateTime
|
When the runner first left the queued state. |
createdAtDateTime!
|
When the operation row was created. |
updatedAtDateTime!
|
When the operation row was last written. |
completedAtDateTime
|
When the operation reached a terminal state. |
titleCheckpoints[LocationTitleCheckpointPayload!]!
|
Per-title checkpoints in plan order. |
LocationOperationPreviewPayload
Section titled “LocationOperationPreviewPayload”A read-only preview of a location operation; nothing is changed.
Fields
| Name | Description |
|---|---|
folders[LocationTitleFoldersPayload!]!
|
Source and destination folder per previewed title, in selection order. |
planFingerprintString!
|
Fingerprint over the full plan, echoed back to confirm it. |
operationTypeLocationOperationTypeValue!
|
Which location workflow this plan belongs to. |
modeLocationExecutionModeValue!
|
How the filesystem side would be performed. |
sourceLibraryIdID
|
Source library, when the whole selection shares one. |
destinationLibraryIdID
|
Destination library for the selection. |
sourceRootIdID
|
Source root, when the whole selection shares one. |
destinationRootIdID
|
Destination root, when the request named one. |
selection[ID!]!
|
The selection this plan was built for, in a stable order. |
countsLocationPlanCountsPayload!
|
Complete counts across the whole plan. |
sections[LocationPlanSectionPayload!]!
|
Plan sections in a stable kind order, each a complete count plus a sample. |
classificationLocationSelectionClassificationPayload!
|
Every selected title grouped by class. |
freeSpaceLocationFreeSpaceEstimatePayload!
|
Estimated free space the operation needs. |
verificationLocationVerificationStatementPayload!
|
The verification depth that will apply. |
confirmationLocationPlanConfirmationPayload!
|
The confirmation this plan demands. |
warnings[String!]!
|
Warnings the user must see before confirming. |
blocksStartBoolean!
|
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. |
LocationOperationRenamedAssetPayload
Section titled “LocationOperationRenamedAssetPayload”One file the operation lands under a different name so destination content keeps its own.
Fields
| Name | Description |
|---|---|
sourcePathString
|
Path the file is read from, or null when the stored plan no longer carries the file this destination came from. |
sourceNameString
|
File name at the source. |
destinationPathString!
|
Path the file lands under. |
destinationNameString!
|
File name it lands under. |
provenanceLabelString
|
Source library named inside the rename suffix, or null when the rename only had a number appended. |
mediaFileIdID
|
Tracked media file, or null for a companion asset. |
sizeBytesLong!
|
Size of the file being renamed. |
doneBoolean!
|
Whether this rename has happened. False means the title carrying it has not settled yet, so the rename is still only planned. |
LocationOperationTitleAssetsPayload
Section titled “LocationOperationTitleAssetsPayload”One title’s renamed and deduplicated files inside an operation.
Fields
| Name | Description |
|---|---|
titleIdID!
|
Title these assets belong to. |
titleNameString!
|
Title name as the confirmed plan recorded it. |
sequenceLong!
|
Position of this title in the confirmed plan. |
settledBoolean!
|
Whether this title finished, which is what turns its planned renames and deduplications into things that actually happened. |
checkpointStateLocationTitleCheckpointStateValue
|
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. |
LocationPlanConfirmationPayload
Section titled “LocationPlanConfirmationPayload”The confirmation this plan demands before it may start.
Fields
| Name | Description |
|---|---|
requirementLocationConfirmationRequirementValue!
|
How much consent the operation demands. |
typedPhraseString
|
The phrase the user must type, when typed confirmation applies. |
typedPromptString
|
The prompt shown beside the typed-confirmation field. |
LocationPlanCountsPayload
Section titled “LocationPlanCountsPayload”Complete counts across the whole plan, independent of sampling.
Fields
| Name | Description |
|---|---|
itemsTotalLong!
|
Every plan item, of every kind. |
titlesTotalLong!
|
Titles the plan covers. |
filesTotalLong!
|
Files the plan covers. |
bytesTotalLong!
|
Bytes the plan covers. |
byKind[LocationPlanKindCountPayload!]!
|
Per-kind complete counts, including kinds with no sampled items. |
LocationPlanItemPayload
Section titled “LocationPlanItemPayload”One previewed change, in the vocabulary every location workflow shares.
Fields
| Name | Description |
|---|---|
kindLocationPlanItemKindValue!
|
What kind of change this item describes. |
titleIdID
|
Title this item belongs to, or null when it belongs to none. |
mediaFileIdID
|
Media file this item acts on, or null for untracked content. |
sourcePathString
|
Source path, or null when the item has no source. |
destinationPathString
|
Destination path, or null when the item has no destination. |
sizeBytesLong!
|
Bytes this item accounts for; zero for catalog-only items. |
sameVolumeBoolean
|
Whether source and destination share a volume, or null when undetermined. |
reasonCodeString
|
Machine-readable reason, for grouping and translation. |
detailString
|
Human-readable explanation, always present for blocking and warning items. |
LocationPlanKindCountPayload
Section titled “LocationPlanKindCountPayload”Complete item count for one plan-item kind.
Fields
| Name | Description |
|---|---|
kindLocationPlanItemKindValue!
|
The kind being counted. |
countLong!
|
How many items of that kind the whole plan contains. |
LocationPlanSectionPayload
Section titled “LocationPlanSectionPayload”One section of a plan: the complete count for a kind plus a sample of its items.
Fields
| Name | Description |
|---|---|
kindLocationPlanItemKindValue!
|
Kind every item in this section shares. |
itemsTotalLong!
|
Complete count for this section across the whole plan. |
bytesTotalLong!
|
Complete byte total for this section, not just the sampled items. |
completeBoolean!
|
Whether the sampled items are the complete section. |
items[LocationPlanItemPayload!]!
|
The sampled items the client renders. |
LocationRetrySelectionPayload
Section titled “LocationRetrySelectionPayload”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
| Name | Description |
|---|---|
operationIdID!
|
Operation the selection was read from. |
modeLocationExecutionModeValue!
|
Who moved the files last time. |
verificationDepthVerificationDepthValue!
|
Verification depth the operation ran at. |
destinationLibraryIdID
|
Library the unfinished titles were headed for, when the operation had one. |
destinationRootIdID
|
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. |
LocationRetryTitlePayload
Section titled “LocationRetryTitlePayload”One title a fresh plan should select, with where it is now.
Fields
| Name | Description |
|---|---|
titleIdID!
|
Title identity. |
titleNameString!
|
Title name as the plan recorded it. |
sourceLibraryIdID!
|
Library the title is in. |
sourceRootIdID!
|
Root the title is in. |
sourceFolderPathString
|
Folder the title owns, when the plan recorded one. |
LocationRootContentBucketPayload
Section titled “LocationRootContentBucketPayload”One of FR-027’s three content buckets: the complete counts plus a sample.
Fields
| Name | Description |
|---|---|
classLocationRootContentClassValue!
|
Which bucket this is. |
totalLong!
|
Complete count of files in this bucket, not just the sampled ones. |
bytesTotalLong!
|
Complete byte total for this bucket. |
completeBoolean!
|
Whether the sampled entries are the complete bucket. |
entries[LocationRootContentEntryPayload!]!
|
The sampled entries the client lists. |
LocationRootContentEntryPayload
Section titled “LocationRootContentEntryPayload”One file found beneath the root, with what the catalog could say about it.
Fields
| Name | Description |
|---|---|
pathString!
|
Where the file is today. |
sizeBytesLong!
|
Its size. |
classLocationRootContentClassValue!
|
Which of FR-027's three buckets it fell into. |
canonicalSidecarBoolean!
|
Whether it is a canonical folder-level sidecar such as |
LocationRootContentInventoryPayload
Section titled “LocationRootContentInventoryPayload”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
| Name | Description |
|---|---|
managedLocationRootContentBucketPayload!
|
Files the catalog tracks for titles assigned to this root. |
companionsLocationRootContentBucketPayload!
|
Untracked files inside a title's folder; they travel with their title. |
unknownLocationRootContentBucketPayload!
|
Everything else. Listed separately because it is what keeps the old location standing. |
unknownBytesLong!
|
Bytes of unexplained content. |
blocksSourceRemovalBoolean!
|
Whether unexplained content stops the source location from being removed. |
entryCountLong!
|
Every scanned file across the three buckets. |
prunableDirectoriesLocationSampledPathsPayload!
|
Directories outside every title folder that hold nothing unexplained, so cleanup may remove them once they are empty. |
retainedDirectoriesLocationSampledPathsPayload!
|
Directories that hold unexplained content and are therefore left standing, with their contents. |
LocationRootIdentityRetentionPayload
Section titled “LocationRootIdentityRetentionPayload”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
| Name | Description |
|---|---|
rootIdID!
|
The root whose identity is retained. |
keepsRootIdBoolean!
|
Whether the synthetic root id survives. It always does. |
wasLibraryDefaultBoolean!
|
Whether the root was the library default before the operation. |
remainsLibraryDefaultBoolean!
|
Whether it is the library default after the operation. |
retainedRoleString
|
The role the root carried, when it carries one. Roots have no role concept yet, so this is always null today. |
retainedTitleAssignmentsLong!
|
Title assignments the root keeps pointing at it. |
LocationRootRetirementBlockerPayload
Section titled “LocationRootRetirementBlockerPayload”One reason the source location cannot be retired (FR-028).
Fields
| Name | Description |
|---|---|
codeString!
|
Machine-readable code, for grouping and translation. |
detailString!
|
The sentence explaining what has to be resolved. |
LocationRootRetirementContractPayload
Section titled “LocationRootRetirementContractPayload”What happens to the old location after every title has settled (FR-028, FR-031, FR-087).
Fields
| Name | Description |
|---|---|
sourceRootPathString!
|
The path being retired. |
destinationRootPathString!
|
The path the root points at afterwards. For a consolidation this is the destination root's own configured path. |
retireConfigurationAfterRecyclingBoolean!
|
Whether the source configuration is retired only after all recycling for the operation completes. |
recycleAllowlistPathsLocationSampledPathsPayload!
|
Paths that stay allowlisted for recycling while the retirement runs. |
requiresVerificationBeforeSourceRemovalBoolean!
|
Whether verification has to succeed before anything at the source is removed. |
emptyDirectoriesOnlyBoolean!
|
Whether only empty directories may be removed automatically. |
removableDirectoriesLocationSampledPathsPayload!
|
Directories cleanup may remove once they are empty, deepest first. |
retainedDirectoriesLocationSampledPathsPayload!
|
Directories that are left standing with their contents. |
permitsSourceRemovalBoolean!
|
Whether the source location may be removed at all. |
blockers[LocationRootRetirementBlockerPayload!]!
|
Every reason it may not be, when there are any. |
LocationRootScopePreviewPayload
Section titled “LocationRootScopePreviewPayload”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
| Name | Description |
|---|---|
planLocationOperationPreviewPayload!
|
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 |
accountingLocationTitleAccountingPayload!
|
Every title assigned to the source root, with no way to exclude one. |
retentionLocationRootIdentityRetentionPayload
|
What the root keeps when only its path changes. Null when the root is being folded into another root instead. |
classificationLocationConsolidationClassificationPayload
|
FR-024's seven groups with their counts. Null for a change to a new, unconfigured path, whose destination holds nothing to classify against. |
defaultTransferLocationDefaultRootTransferPayload
|
Which root new content lands on afterwards. Null for a path change, which never moves the library default. |
contentLocationRootContentInventoryPayload!
|
Everything found beneath the source root, in three buckets. |
retirementLocationRootRetirementContractPayload!
|
What happens to the old location afterwards. |
LocationSampledPathsPayload
Section titled “LocationSampledPathsPayload”A complete count of paths beside the sample the client renders.
Fields
| Name | Description |
|---|---|
totalLong!
|
How many paths there are in total. |
completeBoolean!
|
Whether the sampled paths are the complete list. |
paths[String!]!
|
The sampled paths. |
LocationSelectionClassificationPayload
Section titled “LocationSelectionClassificationPayload”Every selected title grouped by class, with no title omitted.
Fields
| Name | Description |
|---|---|
groups[LocationClassificationGroupPayload!]!
|
One group per class, always all six, including empty ones. |
titlesTotalLong!
|
Selected titles across every group. |
blocksStartBoolean!
|
Whether any title in the selection blocks the start. |
LocationTitleAccountingPayload
Section titled “LocationTitleAccountingPayload”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
| Name | Description |
|---|---|
assignedTotalLong!
|
Every title assigned to the root. |
relocatingLong!
|
Titles whose files move. |
catalogOnlyLong!
|
Titles with no tracked files: catalog reassignment only (FR-076). |
blockedLong!
|
Titles that cannot enter the operation. |
accountsForEveryTitleBoolean!
|
Whether the three counts close against |
blocksStartBoolean!
|
Whether any blocked title stops the operation from starting. |
blockedTitles[LocationBlockedTitlePayload!]!
|
Every blocked title, named. Rendered with no exclude affordance. |
LocationTitleCheckpointPayload
Section titled “LocationTitleCheckpointPayload”Per-title progress inside an operation; the unit a resume restarts from.
Fields
| Name | Description |
|---|---|
titleIdID!
|
Title this checkpoint tracks. |
sequenceLong!
|
Position of this title in the confirmed plan. |
stateLocationTitleCheckpointStateValue!
|
How far this title has progressed. |
classificationTitleLocationClassValue
|
Class this title was previewed as, or null for workflows that do not classify. |
sourceLibraryIdID
|
Library the title started in. |
sourceRootIdID
|
Root the title started on. |
sourceFolderPathString
|
Folder the title started in. |
destinationLibraryIdID
|
Library the title ends up in. |
destinationRootIdID
|
Root the title ends up on. |
destinationFolderPathString
|
Folder the title ends up in. |
mergedIntoTitleIdID
|
Destination title this one merges into, when it merges. |
mergedIntoTitleNameString
|
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. |
filesTotalLong!
|
Files planned for this title. |
filesVerifiedLong!
|
Files whose destination is verified. |
bytesTotalLong!
|
Bytes planned for this title. |
bytesVerifiedLong!
|
Bytes whose destination is verified. |
detailString
|
Warning or failure explanation for this title. |
reasonCodeString
|
Machine-readable reason the title failed, for guidance and translation:
|
startedAtDateTime
|
When this title entered the operation. |
updatedAtDateTime!
|
When this checkpoint was last written. |
completedAtDateTime
|
When this title settled. |
LocationTitleFoldersPayload
Section titled “LocationTitleFoldersPayload”Where one previewed title’s folder is now and where the plan puts it.
Fields
| Name | Description |
|---|---|
titleIdID!
|
Identity of the previewed title. |
sourceString
|
The folder the title occupies today, when it owns one. |
destinationString
|
The folder the plan moves or adopts the title into, when it has one. |
LocationTransferFilePayload
Section titled “LocationTransferFilePayload”One file’s progress inside a location transfer, listed per title.
Fields
| Name | Description |
|---|---|
reasonCodeString
|
Machine-readable reason for a file that did not simply move: a conflict resolution or a transfer failure. |
originalDestinationPathString!
|
Destination path the plan assigned before any conflict resolution renamed it. |
verificationTotalBytesLong!
|
Bytes the current comparison has to read; the file size unless a comparison is in flight. |
sourcePathString!
|
Path the file is read from. |
destinationPathString!
|
Path the file lands at, after any conflict resolution. |
sizeBytesLong!
|
Size of the file in bytes. |
stateString!
|
Lifecycle of this file: QUEUED, MOVING, VERIFYING, COMPARING, WAITING_FOR_STORAGE, DONE, DUPLICATE, FAILED, BLOCKED, CANCELED, or NOT_PROCESSED. |
copyBytesLong!
|
Bytes copied so far. |
verificationBytesLong!
|
Bytes read back and compared so far. |
detailString
|
Operator-facing explanation of an exception on this file, when there is one. |
LocationTransferSnapshotPayload
Section titled “LocationTransferSnapshotPayload”A bounded view of a running or finished transfer: the operation, its aggregate progress, and one page of titles or files.
Fields
| Name | Description |
|---|---|
generationLong!
|
Server generation the revision counts within; a restart starts a new one. |
revisionLong!
|
Monotonic change counter within the generation. Reads never advance it; progress does. |
operationLocationOperationPayload!
|
The operation the snapshot describes. |
progressBasisPointsInt!
|
Overall progress in hundredths of a percent, 0 to 10000. |
etaSecondsLong
|
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. |
totalCountLong!
|
Total number of rows the page is drawn from. |
hasMoreBoolean!
|
True when rows beyond this page remain. |
LocationTransferTitlePayload
Section titled “LocationTransferTitlePayload”One title’s live progress inside a location transfer, as Activity shows it.
Fields
| Name | Description |
|---|---|
titleIdID!
|
Identity of the title this row tracks. |
nameString!
|
Display name of the title. |
stateLocationTitleCheckpointStateValue!
|
The title's checkpoint state at the time of the snapshot. |
filesTotalLong!
|
Number of files the plan walks for this title. |
filesDoneLong!
|
Files verified at the destination so far. |
bytesTotalLong!
|
Bytes the title's files add up to. |
copyBytesLong!
|
Bytes copied so far across the title's files. |
verificationBytesLong!
|
Bytes read back and compared so far across the title's files. |
copyingInt!
|
Files currently being copied. |
verifyingInt!
|
Files currently being verified. |
currentFileString
|
Path of the file the runner is working on, when one is in flight. |
hasExceptionBoolean!
|
True when the title carries a detail worth reading; fetch it with
|
LocationVerificationStatementPayload
Section titled “LocationVerificationStatementPayload”The verification depth this plan will apply, stated before anything moves.
Fields
| Name | Description |
|---|---|
depthVerificationDepthValue!
|
Depth resolved from the user preference at preview time. |
filesLong!
|
Files this depth will be applied to. |
bytesLong!
|
Bytes this depth will be applied to. |
appliesBoolean!
|
Whether any file in this plan will actually be verified. |
LoginMfaEnrollmentCompletePayload
Section titled “LoginMfaEnrollmentCompletePayload”Result of completing MFA enrollment during login.
Fields
| Name | Description |
|---|---|
statusTotpStatusPayload!
|
Updated TOTP status without the shared secret. |
recoveryCodes[String!]!
|
Newly generated one-time recovery codes. |
loginLoginPayload!
|
Authenticated login payload issued after enrollment completes. |
LoginPasskeyEnrollmentCompletePayload
Section titled “LoginPasskeyEnrollmentCompletePayload”Result of completing passkey enrollment during a restricted login enrollment session.
Fields
| Name | Description |
|---|---|
passkeyPasskeySummaryPayload!
|
Registered passkey summary. |
loginLoginPayload!
|
Authenticated login payload issued after enrollment completes. |
LoginPayload
Section titled “LoginPayload”Session or restricted authentication result returned after authentication.
Fields
| Name | Description |
|---|---|
tokenString!
|
Access token or short-lived MFA-enrollment token; clients must treat it as secret. |
userUserPayload!
|
Authenticated user summary without password or credential secrets. |
expiresAtDateTime!
|
Token expiry as a UTC timestamp. |
mfaVerifiedUntilDateTime
|
UTC time through which MFA verification remains fresh, or null when not verified. |
securityActionVerifiedUntilDateTime
|
UTC time through which account-security changes may be authorized. |
mfaEnrollmentRequiredBoolean!
|
True when the token can only complete MFA enrollment. |
passwordChangeRequiredBoolean!
|
True when the token can only replace an administrator-provided temporary password. |
persistSessionBoolean!
|
Whether the session was requested to persist. |
MaintenanceActionDescriptor
Section titled “MaintenanceActionDescriptor”Static registry entry describing one maintenance action to the rule builder.
Fields
| Name | Description |
|---|---|
supportedRuleScopes[MaintenanceRuleSubjectKind!]!
|
Scopes for which this build implements the action. |
kindMaintenanceActionKind!
|
Catalog action this descriptor describes. |
supportedSubjects[MaintenanceActionSubject!]!
|
Subjects the action may be configured against. |
riskClassMaintenanceRiskClass!
|
Risk class governing the controls the action requires. |
effectClasses[String!]!
|
Effect classes the action declares for conflict arbitration. |
timingModeString!
|
When a due action becomes eligible to execute. |
allowedRepeatModes[String!]!
|
Repeat semantics the registry allows for the action. |
requiresTargetQualityProfileBoolean!
|
Whether configuring the action requires a target quality profile. |
requiresTagsBoolean!
|
Whether configuring the action requires at least one title tag. |
supportsStorageScopeBoolean!
|
Whether this action remains valid when a configured storage root limits the files it may affect. |
MaintenanceActionJobReceipt
Section titled “MaintenanceActionJobReceipt”Durable receipt for an external job requested by a schema-2 action step.
Fields
| Name | Description |
|---|---|
dispatchAttemptInt!
|
Dispatch ordinal for this durable external-job request. |
logicalRequestKeyString!
|
Idempotent key identifying the requested external job. |
jobRunIdID
|
External job-run identifier after the request is accepted. |
stateString!
|
Latest reconciliation state of the external job request. |
createdAtDateTime!
|
UTC time this receipt was created. |
updatedAtDateTime!
|
UTC time this receipt was last reconciled. |
MaintenanceActionRun
Section titled “MaintenanceActionRun”One recorded action-handler attempt on one candidate, holds included.
Fields
| Name | Description |
|---|---|
subjectLabelString!
|
Exact subject display label from execution evidence or the current catalog. |
detailString!
|
Persisted per-file outcomes and policy provenance. |
subjectKindString!
|
Persisted subject scope: title, season, or episode. |
subjectIdID!
|
Persisted Scryer title, collection, or episode ID targeted by this attempt. |
idID!
|
Action-run ID. |
ruleSetIdID!
|
Rule set the attempt belongs to. |
candidateIdID!
|
Candidate the attempt acted on. |
titleIdID!
|
Title the attempt acted on. |
titleNameString!
|
Display name of the title, or its stored ID when the title is gone. |
actionKindMaintenanceActionKind!
|
Action the attempt performed or refused. |
actionSequenceMaintenanceActionSequence
|
The immutable schema-2 sequence this attempt executed. Legacy attempts
retain their original |
sequenceSteps[MaintenanceActionStepProgress!]!
|
Ordered latest evidence for every step in the immutable sequence. |
matchGenerationInt!
|
Match generation of the candidate at attempt time. |
attemptInt!
|
Attempt number for this candidate generation, starting at one. |
statusString!
|
Outcome: running, succeeded, already_satisfied, failed, or held. |
holdReasonString
|
Why a held attempt was refused; null otherwise. |
errorString
|
Error text of a failed attempt; null otherwise. |
startedAtDateTime!
|
UTC start time of the attempt. |
finishedAtDateTime
|
UTC finish time; null while the attempt is running. |
MaintenanceActionSequence
Section titled “MaintenanceActionSequence”The authoritative, schema-versioned sequence a revision authorizes.
Fields
| Name | Description |
|---|---|
schemaVersionInt!
|
Schema version that defines the accepted step representation. |
steps[MaintenanceActionStep!]!
|
Ordered steps that make up the revision's action sequence. |
MaintenanceActionSpec
Section titled “MaintenanceActionSpec”The closed, schema-versioned action configuration a rule revision stores.
Fields
| Name | Description |
|---|---|
kindMaintenanceActionKind!
|
Catalog action the revision authorizes. |
schemaVersionInt!
|
Schema version the stored parameters were validated against. |
targetQualityProfileIdString
|
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. |
MaintenanceActionStep
Section titled “MaintenanceActionStep”One ordered action in a revision-bound sequence.
Fields
| Name | Description |
|---|---|
idID!
|
Stable identifier used by durable execution receipts and history. |
kindMaintenanceActionStepKind!
|
Catalog primitive this ordered step executes. |
parametersMaintenanceActionStepParameters!
|
Typed parameters accepted by this step's catalog primitive. |
MaintenanceActionStepDescriptor
Section titled “MaintenanceActionStepDescriptor”Backend-owned capabilities for one schema-2 primitive.
Fields
| Name | Description |
|---|---|
idString!
|
Stable catalog identifier for this primitive. |
kindMaintenanceActionStepKind!
|
Primitive represented by this descriptor. |
labelString!
|
Operator-facing label for the primitive. |
supportedSubjects[MaintenanceActionSubject!]!
|
Subjects that may use this primitive. |
parameterSchemaString!
|
Name of the typed parameter shape accepted by this primitive. |
effectClasses[String!]!
|
Effects used when arbitrating conflicts with other steps. |
riskClassMaintenanceRiskClass!
|
Risk class that determines the required arming level. |
requires[String!]!
|
Preconditions this primitive requires before it can execute. |
terminalBoolean!
|
Whether this primitive ends the sequence when it succeeds. |
completionPolicyString!
|
How completion for this primitive is determined. |
storageRootAllowedBoolean!
|
Whether this primitive is permitted for a storage-root-scoped rule. |
MaintenanceActionStepParameters
Section titled “MaintenanceActionStepParameters”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
| Name | Description |
|---|---|
includeDescendantsBoolean
|
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. |
targetQualityProfileIdString
|
Target profile for a quality-profile step. |
searchConditionMaintenanceSearchCondition
|
Dispatch condition for a search step. |
tags[String!]!
|
Tags written by an add-tags or remove-tags step. |
MaintenanceActionStepProgress
Section titled “MaintenanceActionStepProgress”One configured step with the latest outcome and any durable job receipts.
Fields
| Name | Description |
|---|---|
stepMaintenanceActionStep!
|
Immutable step definition from the sequence revision. |
runMaintenanceActionStepRun
|
Latest durable checkpoint for this step, or null before execution starts. |
receipts[MaintenanceActionJobReceipt!]!
|
Durable external-job receipts associated with this step. |
MaintenanceActionStepRun
Section titled “MaintenanceActionStepRun”The latest durable checkpoint for one ordered schema-2 step.
Fields
| Name | Description |
|---|---|
stepIdID!
|
Stable identifier of the sequence step this checkpoint belongs to. |
stepKindString!
|
Stored catalog kind for the step checkpoint. |
stateString!
|
Latest durable state for this step. |
attemptInt!
|
Number of durable attempts made for this step. |
holdReasonString
|
Reason execution is waiting, when the step is held. |
errorString
|
Failure message for the latest step attempt, when any. |
createdAtDateTime!
|
UTC time the step checkpoint was created. |
updatedAtDateTime!
|
UTC time the step checkpoint was last updated. |
finishedAtDateTime
|
UTC time the latest step attempt finished, or null while active. |
MaintenanceCandidate
Section titled “MaintenanceCandidate”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
| Name | Description |
|---|---|
fileCountInt
|
Number of current subject files, or null if the subject is unavailable. |
totalSizeBytesInt
|
Current subject file size in bytes, or null if the subject is unavailable. |
storageRootFileCountInt
|
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. |
storageRootTotalSizeBytesInt
|
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 |
subjectLabelString!
|
Exact subject display label, falling back to its ID if unavailable. |
subjectKindString!
|
Subject scope: title, season, or episode. |
subjectIdID!
|
Scryer title, collection, or episode ID identifying this candidate's subject. |
idID!
|
Candidate ID. |
ruleSetIdID!
|
Rule set that produced the candidate. |
ruleNameString!
|
Name of that rule set. |
revisionNumberInt!
|
Rule revision in force when the candidate was opened. |
titleIdID!
|
Subject title ID. |
titleNameString!
|
Subject title name, or the stored title ID when the title is gone. |
libraryIdString!
|
Library the subject belonged to when the candidate was opened. |
facetString!
|
Media facet of the subject. |
stateMaintenanceCandidateState!
|
Current lifecycle state. |
stateReasonString!
|
Why the candidate is in that state. |
reasonCodes[String!]!
|
Reason codes the matcher emitted on the most recent match. |
actionKindMaintenanceActionKind!
|
Action the rule revision authorizes, and the one the handler will run if
this candidate becomes due while the rule is in |
actionSequenceMaintenanceActionSequence
|
The immutable schema-2 sequence that opened this candidate. Legacy
candidates retain their original |
sequenceSteps[MaintenanceActionStepProgress!]!
|
Ordered latest evidence for each schema-2 step. An empty sequence is an observe-only candidate rather than a missing action. |
graceDaysInt!
|
Days the subject must match continuously before the action is due. |
matchGenerationInt!
|
Increments each time a fresh candidate is opened for this subject, so a cancel-then-rematch is distinguishable from a continuing membership. |
firstMatchedAtDateTime!
|
When the subject started matching. Never reset while the candidate lives. |
lastMatchedAtDateTime!
|
When the subject most recently matched. |
dueAtDateTime!
|
When the grace period elapses, equal to |
heldSinceDateTime
|
Set while the latest evaluation could not decide, and null otherwise. |
updatedAtDateTime!
|
UTC last-update time. |
MaintenanceEvaluationRun
Section titled “MaintenanceEvaluationRun”One rule set’s pass through one evaluation run.
Fields
| Name | Description |
|---|---|
idID!
|
Evaluation-run ID. |
ruleSetIdID!
|
Rule set that was evaluated. |
revisionNumberInt!
|
Rule revision that was evaluated. |
statusString!
|
One of running, succeeded, or failed. A run left running is the trace of an interrupted pass. |
startedAtDateTime!
|
When the pass started. |
finishedAtDateTime
|
When the pass finished, or null while it is still running. |
evaluatedCountInt!
|
Subjects the matcher was run against. |
matchedCountInt!
|
Subjects the matcher matched. |
noMatchCountInt!
|
Subjects the matcher did not match. |
unknownCountInt!
|
Subjects the matcher could not decide, which are held. |
errorCountInt!
|
Subjects whose evaluation failed, which are also held. |
durationMsInt
|
How long the pass took, or null while it is still running. |
errorString
|
Why the pass failed, or null when it did not. |
MaintenanceEvaluationTriggerPayload
Section titled “MaintenanceEvaluationTriggerPayload”Outcome of asking for an immediate evaluation pass.
Fields
| Name | Description |
|---|---|
startedBoolean!
|
Whether a pass was started. False when a gate, a disabled rule, or a run already in progress stopped it. |
messageString
|
What happened, suitable for showing to an operator. |
MaintenanceExclusion
Section titled “MaintenanceExclusion”A subject a maintenance rule must never act on.
Fields
| Name | Description |
|---|---|
subjectLabelString!
|
Exact excluded subject label, falling back to its ID if unavailable. |
subjectKindString!
|
Excluded scope: title, season, or episode. Parent exclusions cover descendants. |
subjectIdID!
|
Scryer title, collection, or episode ID of the excluded subject. |
idID!
|
Exclusion ID. |
ruleSetIdID
|
Rule the exclusion is confined to, or null when it is global. |
titleIdID!
|
Excluded title ID. |
titleNameString!
|
Excluded title name, or the stored title ID when the title is gone. |
reasonString!
|
Why the subject was excluded; empty when the author gave no reason. |
createdByID
|
ID of the user who added the exclusion, or null when unattributed. |
createdAtDateTime!
|
UTC creation time. |
MaintenanceInstanceGates
Section titled “MaintenanceInstanceGates”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
| Name | Description |
|---|---|
evaluationEnabledBoolean!
|
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. |
resultDisplayEnabledBoolean!
|
Whether candidate results are returned to clients. |
presentationEffectsEnabledBoolean!
|
Reserved for provider collection projection and lifecycle notifications. Nothing reads it yet. |
reversibleEffectsEnabledBoolean!
|
Whether low and medium risk actions may execute, such as unmonitoring a
title or changing its quality profile. A rule armed as |
destructiveEffectsEnabledBoolean!
|
Whether high risk actions may execute, meaning the ones that delete media
files. Turning this on lets every rule already armed as |
MaintenancePreviewPayload
Section titled “MaintenancePreviewPayload”Outcome of running one matcher against a bounded subject selection. Preview persists nothing.
Fields
| Name | Description |
|---|---|
ruleSetIdString!
|
Stored rule set the preview ran, or the throwaway ID an unsaved draft compiled under. |
matcherContentHashString!
|
Hash of the exact source that produced these outcomes. |
evaluatedAtDateTime!
|
UTC time the preview evaluated the selection. |
titles[MaintenancePreviewTitle!]!
|
One entry per evaluated subject, including its owning title. |
MaintenancePreviewTitle
Section titled “MaintenancePreviewTitle”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
| Name | Description |
|---|---|
excludedBoolean!
|
Whether a direct or inherited exclusion protects this subject. |
dueAtDateTime
|
Existing grace deadline, or an estimated deadline for a new match. |
dueAtIsEstimateBoolean!
|
True when the deadline is estimated rather than persisted on a candidate. |
subjectLabelString!
|
Display label for the exact title, season, or episode being evaluated. |
fileCountInt!
|
Number of current files associated with this subject. |
totalSizeBytesInt!
|
Combined size in bytes of this subject's current files. |
storageRootFileCountInt
|
Number of files eligible for deletion on the selected storage root, or null when this matcher does not select a resolvable root. |
storageRootTotalSizeBytesInt
|
Combined bytes eligible for deletion on the selected storage root, or null when this matcher does not select a resolvable root. |
subjectKindString!
|
Subject scope: title, season, or episode. |
subjectIdID!
|
Scryer title, collection, or episode ID for the selected scope. |
titleIdID!
|
Evaluated title ID. |
titleNameString!
|
Evaluated title name. |
facetString!
|
Media facet of the evaluated title. |
libraryIdString!
|
Library containing the evaluated title. |
outcomeMaintenanceOutcome
|
Decision the matcher reached, or null when evaluation failed. |
reasonCodes[String!]!
|
Reason codes the matcher emitted; empty when it emitted none. |
errorString
|
Why evaluation failed for this subject, or null when it succeeded. |
MaintenanceRuleRevision
Section titled “MaintenanceRuleRevision”One immutable revision of a maintenance rule set’s matcher and action.
Fields
| Name | Description |
|---|---|
idID!
|
Revision ID. |
ruleSetIdID!
|
ID of the rule set this revision belongs to. |
revisionNumberInt!
|
Revision number, starting at one and incremented on every matcher edit. |
regoSourceString!
|
Rego source as the editor should show it, with the package declaration and the rego.v1 import stripped. |
graceDaysInt!
|
Days a subject must match continuously before the action becomes due. |
storageRootIdString
|
Configured library root whose capacity and owned files this revision uses, or null when it is not storage-scoped. |
matcherContentHashString!
|
Hash of the exact stored source, used to attribute a decision to the revision that produced it. |
createdByID
|
ID of the user who wrote the revision, or null when unattributed. |
createdAtDateTime!
|
UTC creation time. |
MaintenanceRuleSet
Section titled “MaintenanceRuleSet”A maintenance rule set: identity, scope, and evaluation state. The matcher and the action it authorizes live on the revision, never here.
Fields
| Name | Description |
|---|---|
idID!
|
Rule-set ID. |
nameString!
|
Rule-set name. |
descriptionString!
|
Rule-set description; empty when the author supplied none. |
enabledBoolean!
|
Whether the rule set is enabled. Derived from |
evaluationModeMaintenanceEvaluationMode!
|
Evaluation mode currently stored for the rule set. |
effectArmingMaintenanceEffectArming!
|
How far this rule's effects are armed, independent of its mode. |
destructiveRearmRequiredBoolean!
|
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. |
subjectKindMaintenanceRuleSubjectKind!
|
Granularity the rule is scoped to. |
currentRevisionNumberInt!
|
Revision number of the matcher currently in force. |
graceDaysInt!
|
Grace period of the revision currently in force, in days. |
actionSpecMaintenanceActionSpec!
|
Action the revision currently in force authorizes. |
actionSequenceMaintenanceActionSequence
|
Ordered schema-2 actions for the revision currently in force. Legacy rows expose their unchanged action spec and leave this null. |
createdAtDateTime!
|
UTC creation time. |
updatedAtDateTime!
|
UTC last-update time. |
MaintenanceRuleSetDetail
Section titled “MaintenanceRuleSetDetail”A rule set together with the revision currently in force.
Fields
| Name | Description |
|---|---|
ruleSetMaintenanceRuleSet!
|
The rule set itself. |
revisionMaintenanceRuleRevision!
|
The revision currently in force. |
actionSpecMaintenanceActionSpec!
|
The action that revision authorizes, already decoded. |
actionSequenceMaintenanceActionSequence
|
Ordered actions for a schema-2 revision. Legacy revisions keep this
null and continue to expose their original |
MaintenanceRuleValidationPayload
Section titled “MaintenanceRuleValidationPayload”Result of validating maintenance rule source without saving it.
Fields
| Name | Description |
|---|---|
validBoolean!
|
Whether the source is valid. |
errors[String!]!
|
Validation errors; empty when valid. |
ManualImportFilePreviewPayload
Section titled “ManualImportFilePreviewPayload”Candidate file details used to preview a manual import selection.
Fields
| Name | Description |
|---|---|
candidateIdID!
|
Candidate ID within the persisted manual-import selection; use it only with that selection. |
fileNameString!
|
Candidate file name. |
sizeBytesLong!
|
Candidate file size in bytes. |
videoFactsManualImportVideoFactsPayload
|
Media facts when the native content probe can identify the file. |
qualityString
|
Parsed quality label, or null when unavailable. |
parsedSeasonInt
|
Parsed season number, or null when unavailable. |
parsedEpisodes[Int!]!
|
Parsed episode numbers; empty means none were detected. |
suggestedEpisodeIdID
|
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. |
suggestedEpisodeLabelString
|
Label for the suggested episode, or null when no suggestion exists. |
suggestedSeriesMovieLinkIdString
|
Suggested series-movie link, or null when this is not a grabbed series movie. |
ManualImportSelectionPayload
Section titled “ManualImportSelectionPayload”Persisted manual-import selection that can be submitted for execution.
Fields
| Name | Description |
|---|---|
selectionIdID!
|
Identifier of the persisted selection. |
archiveExtractionNeededBoolean!
|
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. |
ManualImportSeriesMovieTargetPayload
Section titled “ManualImportSeriesMovieTargetPayload”Series-movie target candidate for a manual import.
Fields
| Name | Description |
|---|---|
seriesMovieLinkIdString!
|
Series-movie link identity targeted by the candidate. |
movieTitleString!
|
Movie title associated with the target. |
yearInt
|
Release year, or null when unavailable. |
runtimeMinutesInt
|
Runtime in minutes, or null when unavailable. |
ManualImportVideoFactsPayload
Section titled “ManualImportVideoFactsPayload”Media facts obtained while qualifying a manual-import candidate.
Fields
| Name | Description |
|---|---|
containerFormatString
|
Detected container format, or null when unavailable. |
videoCodecString
|
Detected video codec, or null when unavailable. |
audioCodecString
|
Detected audio codec, or null when unavailable. |
videoWidthInt
|
Detected video width in pixels, or null when unavailable. |
videoHeightInt
|
Detected video height in pixels, or null when unavailable. |
durationSecondsInt
|
Detected runtime in seconds, or null when unavailable. |
discMediaDiscMetadataPayload
|
Detected disc structure and authored titles for an ISO image. |
reportMediaProbeReportPayload!
|
Probe status, limits, and reasons for incomplete qualification. |
ManualPluginPreviewPayload
Section titled “ManualPluginPreviewPayload”Preview of a manually supplied plugin repository.
Fields
| Name | Description |
|---|---|
githubRepoUrlString!
|
GitHub repository URL used for the preview. |
pluginRegistryPluginPayload!
|
Resolved registry metadata. |
MediaAnalysisAttemptPayload
Section titled “MediaAnalysisAttemptPayload”Latest analysis attempt, retained separately from the last successful metadata.
Fields
| Name | Description |
|---|---|
revisionInt!
|
Analysis schema revision; zero denotes legacy metadata. |
attemptedAtString!
|
Timestamp of the analysis attempt in RFC 3339 form. |
succeededBoolean!
|
Whether this attempt published successful metadata. |
reportMediaProbeReportPayload!
|
Inspection status, coverage counters, and warnings. |
discMediaDiscMetadataPayload
|
Detected disc metadata, when this source is a disc image. |
MediaAnalysisDetailsPayload
Section titled “MediaAnalysisDetailsPayload”Versioned native analysis shared by imports, scans, rules, and media details.
Fields
| Name | Description |
|---|---|
is3DBoolean!
|
Explicit media metadata detected stereoscopic video. |
revisionInt!
|
Analysis schema revision; zero denotes legacy metadata. |
durationSecondsFloat
|
Playback duration in seconds, when established. |
durationProvenanceMediaProvenanceValue!
|
Evidence source for playback duration. |
overallBitrateBpsLong
|
Overall source bitrate in bits per second, distinct from video bitrate. |
selectedVideoIdString
|
Container ID of the primary non-cover video stream. |
selectedProgramIdInt
|
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. |
discMediaDiscMetadataPayload
|
Detected disc metadata, when this source is a disc image. |
reportMediaProbeReportPayload!
|
Inspection status, coverage counters, and warnings. |
MediaAttachmentPayload
Section titled “MediaAttachmentPayload”Embedded attachment inventory without extracting the attachment.
Fields
| Name | Description |
|---|---|
idString!
|
Identifier within the source metadata. |
nameString
|
Name supplied by the container metadata. |
mediaTypeString
|
Attachment media type, when supplied. |
sizeBytesLong!
|
Attachment size in bytes. |
MediaCaptionServicePayload
Section titled “MediaCaptionServicePayload”Caption service detected in sampled headers; no transcription is performed.
Fields
| Name | Description |
|---|---|
streamIdString!
|
Container stream ID associated with this result. |
standardString!
|
Caption standard, such as CEA-608 or CEA-708. |
serviceNumberInt
|
Caption service number, when available. |
languageString
|
Normalized language tag, when known. |
MediaChapterPayload
Section titled “MediaChapterPayload”Chapter timing on the relevant media or selected-title timeline.
Fields
| Name | Description |
|---|---|
idString!
|
Identifier within the source metadata. |
titleString
|
Authored chapter title, when supplied. |
startSecondsFloat!
|
Chapter start time in seconds. |
endSecondsFloat
|
Chapter end time in seconds, when known. |
MediaColorMetadataPayload
Section titled “MediaColorMetadataPayload”Color signaling and static HDR metadata, with evidence provenance.
Fields
| Name | Description |
|---|---|
primariesInt
|
Numeric color primaries code. |
transferInt
|
Numeric transfer characteristic code. |
matrixInt
|
Numeric matrix coefficients code. |
fullRangeBoolean
|
Whether full-range samples are explicitly signaled. |
provenanceMediaProvenanceValue!
|
Evidence source used for these values. |
masteringDisplayMediaMasteringDisplayPayload
|
Static mastering display metadata, when present. |
contentLightMediaContentLightPayload
|
Static content light metadata, when present. |
MediaContentLightPayload
Section titled “MediaContentLightPayload”Content light level metadata in candelas per square metre.
Fields
| Name | Description |
|---|---|
maxCllInt
|
Maximum content light level in candelas per square metre. |
maxFallInt
|
Maximum frame-average light level in candelas per square metre. |
MediaDiagnosticCoveragePayload
Section titled “MediaDiagnosticCoveragePayload”Byte range read during structural diagnostics.
Fields
| Name | Description |
|---|---|
offsetLong!
|
Byte offset from the start of the inspected source. |
lengthLong!
|
Length of this inspected range in bytes. |
MediaDiscEpisodeMappingPayload
Section titled “MediaDiscEpisodeMappingPayload”Persisted association between an authored disc title and catalogued episodes.
Fields
| Name | Description |
|---|---|
discTitleIdString!
|
Authored disc title or playlist ID. |
episodeIds[String!]!
|
Catalogued episodes explicitly associated with this authored title. |
MediaDiscEpisodeTargetPayload
Section titled “MediaDiscEpisodeTargetPayload”An episode eligible for explicit disc-title mapping.
Fields
| Name | Description |
|---|---|
episodeIdID!
|
Catalogued episode ID. |
labelString!
|
Display label for this episode. |
durationSecondsLong
|
Playback duration in seconds, when established. |
MediaDiscMetadataPayload
Section titled “MediaDiscMetadataPayload”Detected disc structure, title inventory, and current selection.
Fields
| Name | Description |
|---|---|
discTypeString!
|
Detected disc type, independent of the physical file extension. |
filesystemString!
|
Detected image filesystem. |
volumeLabelString
|
Filesystem volume label, when present. |
titles[MediaDiscTitlePayload!]!
|
Distinct authored titles retained by bounded inspection. |
selectedTitleIdString
|
Currently resolved authored title ID; null means no valid selection. |
automaticSelectionBoolean!
|
Whether the current title was chosen automatically. |
selectionMediaDiscSelectionPayload!
|
Persisted override and explicit episode mappings. |
MediaDiscSegmentPayload
Section titled “MediaDiscSegmentPayload”One ordered segment and trim range in an authored playback sequence.
Fields
| Name | Description |
|---|---|
pathString!
|
Referenced media path inside the disc image. |
inSecondsFloat!
|
Playback trim start in seconds. |
outSecondsFloat!
|
Playback trim end in seconds. |
angleInt!
|
Selected authored angle number. |
sequenceIdInt
|
Authored sequence identifier used to preserve playback ordering. |
MediaDiscSelectionPayload
Section titled “MediaDiscSelectionPayload”Saved manual title override and episode mappings.
Fields
| Name | Description |
|---|---|
titleIdString
|
Manual authored title ID; null requests automatic selection. |
episodeMappings[MediaDiscEpisodeMappingPayload!]!
|
Explicit authored-title-to-episode associations for this physical image. |
MediaDiscTitlePayload
Section titled “MediaDiscTitlePayload”Distinct authored playback title, its timeline, and inspected stream facts.
Fields
| Name | Description |
|---|---|
idString!
|
Identifier within the source metadata. |
aliases[String!]!
|
Other title IDs with the same ordered segment and trim sequence. |
durationSecondsFloat
|
Playback duration in seconds, when established. |
angleCountInt!
|
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. |
reportMediaProbeReportPayload!
|
Inspection status, coverage counters, and warnings. |
MediaDolbyVisionPayload
Section titled “MediaDolbyVisionPayload”Dolby Vision configuration reported by the container or bitstream.
Fields
| Name | Description |
|---|---|
profileInt
|
Codec profile reported for this stream. |
levelInt
|
Codec-specific level identifier. |
baseLayerCompatibilityIdInt
|
Dolby Vision base layer compatibility identifier. |
rpuPresentBoolean
|
Whether Dolby Vision reference processing metadata is signaled. |
enhancementLayerPresentBoolean
|
Whether a Dolby Vision enhancement layer is signaled. |
baseLayerPresentBoolean
|
Whether a Dolby Vision base layer is signaled. |
MediaHdrCapabilitiesPayload
Section titled “MediaHdrCapabilitiesPayload”Independent HDR capabilities; combinations are preserved and null means unknown.
Fields
| Name | Description |
|---|---|
dolbyVisionBoolean
|
Whether Dolby Vision is established by the available evidence. |
hdr10PlusBoolean
|
Whether HDR10+ dynamic metadata was detected. |
hdr10Boolean
|
Whether the available bit-depth and color evidence establishes HDR10. |
hlgBoolean
|
Whether Hybrid Log-Gamma transfer is signaled. |
pqBoolean
|
Whether Perceptual Quantizer transfer is signaled; this alone does not establish HDR10. |
doviMediaDolbyVisionPayload
|
Dolby Vision configuration details. |
MediaMasteringDisplayPayload
Section titled “MediaMasteringDisplayPayload”Mastering display chromaticity coordinates and luminance.
Fields
| Name | Description |
|---|---|
redXFloat
|
X chromaticity coordinate of the red primary. |
redYFloat
|
Y chromaticity coordinate of the red primary. |
greenXFloat
|
X chromaticity coordinate of the green primary. |
greenYFloat
|
Y chromaticity coordinate of the green primary. |
blueXFloat
|
X chromaticity coordinate of the blue primary. |
blueYFloat
|
Y chromaticity coordinate of the blue primary. |
whiteXFloat
|
X chromaticity coordinate of the white point. |
whiteYFloat
|
Y chromaticity coordinate of the white point. |
minLuminanceFloat
|
Minimum mastering display luminance in candelas per square metre. |
maxLuminanceFloat
|
Maximum mastering display luminance in candelas per square metre. |
MediaProbeReportPayload
Section titled “MediaProbeReportPayload”Probe coverage, resource usage, and reasons for incomplete metadata.
Fields
| Name | Description |
|---|---|
statusMediaProbeStatusValue!
|
Outcome of this bounded inspection. |
bytesReadLong!
|
Total bytes read while probing, including repeated reads. |
seeksLong!
|
Number of seek operations performed. |
elapsedMsLong!
|
Elapsed probe time in milliseconds. |
budgetExhaustedBoolean!
|
Whether any configured inspection budget was exhausted. |
warnings[MediaProbeWarningPayload!]!
|
Structured warnings explaining conflicts, unsupported features, or incomplete coverage. |
MediaProbeWarningPayload
Section titled “MediaProbeWarningPayload”A structured warning from bounded media inspection.
Fields
| Name | Description |
|---|---|
codeString!
|
Stable warning code. |
messageString!
|
Human-readable warning details. |
streamIdString
|
Container stream ID associated with this result. |
offsetLong
|
Byte offset from the start of the inspected source. |
MediaProgramPayload
Section titled “MediaProgramPayload”Container program and its member streams.
Fields
| Name | Description |
|---|---|
idInt!
|
Identifier within the source metadata. |
nameString
|
Name supplied by the container metadata. |
streamIds[String!]!
|
Container stream IDs belonging to this program. |
durationSecondsFloat
|
Playback duration in seconds, when established. |
MediaRationalPayload
Section titled “MediaRationalPayload”Exact rational value with a nonzero denominator.
Fields
| Name | Description |
|---|---|
numeratorLong!
|
Signed numerator. |
denominatorLong!
|
Positive denominator. |
MediaRenameApplyItemPayload
Section titled “MediaRenameApplyItemPayload”Result for one applied media rename plan item.
Fields
| Name | Description |
|---|---|
collectionIdID
|
Collection ID, or null when not part of a collection. |
seriesMovieLinkIds[ID!]!
|
Series-movie link IDs associated with the item. |
currentPathString!
|
Path before the apply operation. |
proposedPathString
|
Planned path, or null when no rename was proposed. |
finalPathString
|
Final path after application, or null when not moved. |
writeActionString!
|
Write action attempted. |
statusString!
|
Apply status. |
reasonCodeString!
|
Machine-readable reason for the outcome. |
errorMessageString
|
Error message, or null when the item succeeded or was skipped without error. |
MediaRenameApplyPayload
Section titled “MediaRenameApplyPayload”Aggregate result of applying a previously generated rename plan.
Fields
| Name | Description |
|---|---|
planFingerprintString!
|
Fingerprint of the plan that was applied. |
totalInt!
|
Total plan-item count. |
appliedInt!
|
Number of items applied. |
skippedInt!
|
Number of items skipped. |
failedInt!
|
Number of items that failed. |
items[MediaRenameApplyItemPayload!]!
|
Per-item apply results. |
MediaRenamePlanItemPayload
Section titled “MediaRenamePlanItemPayload”One media rename plan item with current and proposed paths and decision details.
Fields
| Name | Description |
|---|---|
collectionIdID
|
Collection ID, or null when not part of a collection. |
seriesMovieLinkIds[ID!]!
|
Series-movie link IDs associated with the item. |
currentPathString!
|
Current filesystem path. |
proposedPathString
|
Proposed filesystem path, or null when no rename is possible. |
normalizedFilenameString
|
Normalized filename, or null when metadata is insufficient. |
collisionBoolean!
|
Whether the proposed path collides with another path. |
reasonCodeString!
|
Machine-readable reason for the plan decision. |
writeActionString!
|
Planned write action. |
sourceSizeBytesLong
|
Source file size in bytes, or null when unavailable. |
sourceMtimeUnixMsLong
|
Source modification time as Unix milliseconds, or null when unavailable. |
MediaRenamePlanPayload
Section titled “MediaRenamePlanPayload”Read-only media rename plan and stable fingerprint for later application.
Fields
| Name | Description |
|---|---|
facetMediaFacetValue!
|
Media facet covered by the plan. |
titleIdID
|
Target title ID, or null when the plan covers the whole facet. |
templateString!
|
Rename template used to generate proposed paths. |
collisionPolicyRenameCollisionPolicyValue!
|
Collision policy used by the plan. |
missingMetadataPolicyRenameMissingMetadataPolicyValue!
|
Missing-metadata policy used by the plan. |
fingerprintString!
|
Stable fingerprint required to apply this exact plan. |
totalInt!
|
Total plan-item count. |
renamableInt!
|
Number of items eligible for rename. |
noopInt!
|
Number of items already matching the desired path. |
conflictsInt!
|
Number of collision items. |
errorsInt!
|
Number of items with planning errors. |
items[MediaRenamePlanItemPayload!]!
|
Plan items in deterministic service order. |
MediaRequestActionPayload
Section titled “MediaRequestActionPayload”Identifier returned after a media-request action.
Fields
| Name | Description |
|---|---|
requestIdID!
|
The media request the action applied to. |
MediaRequestChangedPayload
Section titled “MediaRequestChangedPayload”Event payload identifying a changed media request.
Fields
| Name | Description |
|---|---|
eventIdID!
|
ID of the event. |
eventTypeDomainEventTypeValue!
|
Domain event type that caused the notification. |
requestIdID!
|
ID of the changed media request. |
libraryIdID!
|
ID of the library containing the request. |
MediaRequestCountsPayload
Section titled “MediaRequestCountsPayload”Media-request counts grouped by media facet.
Fields
| Name | Description |
|---|---|
movieInt!
|
Movie request count. |
seriesInt!
|
Series request count. |
animeInt!
|
Anime request count. |
MediaRequestExternalRatingPayload
Section titled “MediaRequestExternalRatingPayload”One provider-specific rating captured when a media request was submitted.
Fields
| Name | Description |
|---|---|
sourceString!
|
Rating provider name. |
valueFloat
|
Provider rating value before normalization, or null when absent. |
scoreFloat
|
Provider score on its native scale, or null when absent. |
normalizedFloat!
|
Score normalized to the shared comparison scale. |
votesInt
|
Number of votes reported by the provider, or null when absent. |
urlString!
|
Provider page for this rating. |
MediaRequestLease
Section titled “MediaRequestLease”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
| Name | Description |
|---|---|
requestedDaysInt
|
Days the requester asked for; null means forever. |
approvedDaysInt
|
Days the approver granted; null means forever. |
stateLifecycleClaimStateValue!
|
State of the claim holding the title. |
startsAtDateTime
|
When the lease started running, which is the title's first import. Null while the claim is dormant. |
expiresAtDateTime
|
When the lease runs out. Null while dormant and for a forever request. |
MediaRequestMetadataPayload
Section titled “MediaRequestMetadataPayload”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
| Name | Description |
|---|---|
partialBoolean!
|
True when enrichment did not fully succeed. |
missing[String!]!
|
Groups that could not be established ( |
genres[String!]!
|
Genres captured at submit time. |
contentRatings[DiscoveryContentRatingPayload!]!
|
Content ratings captured at submit time, one entry per country. |
ageRatingInt
|
Minimum age the captured ratings imply, or null when none of them said. |
certificationLabelString
|
US certification label, or null when the title has no US certification. |
certificationRankInt
|
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. |
isAdultBoolean!
|
True when any captured canonical tag is flagged adult. |
tmdbVoteAverageFloat
|
TMDB vote average, published for movies only. |
tmdbVoteCountInt
|
TMDB vote count, published for movies only. |
popularityFloat
|
TMDB popularity, published for movies only. |
awardCountInt!
|
How many awards the snapshot captured. |
MediaRequestPayload
Section titled “MediaRequestPayload”Media request with current status, title identity, and resolution metadata.
Fields
| Name | Description |
|---|---|
idID!
|
ID of the media request. |
libraryIdID!
|
ID of the library targeted by the request. |
facetMediaFacetValue!
|
Media facet targeted by the request. |
statusMediaRequestStatusValue!
|
Current request lifecycle status. |
identityFingerprintString!
|
Stable identity fingerprint used to deduplicate requests. |
titleString!
|
Display title at request time. |
sortTitleString
|
Sort title, or null when unavailable. |
slugString
|
Provider slug, or null when unavailable. |
posterUrlString
|
Poster URL, or null when unavailable. |
backgroundUrlString
|
Background art URL captured at submit time, or null when unavailable. |
yearInt
|
Release year, or null when unknown. |
overviewString
|
Overview text, or null when unavailable. |
runtimeMinutesInt
|
Runtime in minutes, or null when unknown. |
languageString
|
Original language code, or null when unknown. |
contentStatusString
|
Provider content status, or null when unavailable. |
ratingFloat
|
Combined metadata rating, or null when unavailable. |
ratingSources[String!]!
|
Sources contributing to the combined metadata rating. |
externalRatings[MediaRequestExternalRatingPayload!]!
|
Provider-specific metadata ratings. |
requestedQualityProfileIdID
|
ID of the quality profile requested, or null when none was selected. |
requestedQualityProfileNameString
|
Name of the requested quality profile, or null when none was selected. |
requestedMonitorTypeMonitorTypeValue
|
Requested monitoring mode, or null when not specified. |
requestedMonitorSelectionMonitorSelectionPayload
|
Seasons and series movies requested under |
resolvedByUserIdID
|
ID of the user who resolved the request, or null while unresolved. |
resolvedAtDateTime
|
UTC time when the request was resolved, or null while unresolved. |
createdTitleIdID
|
ID of the title created from the request, or null when not created. |
approvedQualityProfileIdID
|
ID of the approved quality profile, or null before approval. |
approvedQualityProfileNameString
|
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. |
createdByUserIdID!
|
ID of the user who created the request. |
createdAtDateTime!
|
UTC time when the request was created. |
updatedAtDateTime!
|
UTC time when the request was last changed. |
requestedLeaseDaysInt
|
Days the requester asked the media to be kept for; null means forever. |
approvedLeaseDaysInt
|
Days the approver granted; null means forever, and it stays null until the request is approved. |
leaseMediaRequestLease
|
The lease actually holding the created title, or null until an approval creates the claim. |
decisionRequestRuleDecision
|
The decision request rules recorded for this request, or null when it
was never evaluated. A requester reading their own request gets it with
|
policyTags[String!]!
|
Tags the policy emitted for this request. Stamped on the title only when the request is approved. |
metadataMediaRequestMetadataPayload!
|
The metadata the request was decided against, as captured at submit time. |
MediaRequestRequesterPayload
Section titled “MediaRequestRequesterPayload”User who submitted a media request.
Fields
| Name | Description |
|---|---|
userIdID!
|
ID of the requesting user. |
usernameString!
|
Requesting user's username. |
avatarUrlString
|
Avatar URL, or null when unavailable. |
requestedAtDateTime!
|
UTC time when this user submitted the request. |
MediaServerConnectionPayload
Section titled “MediaServerConnectionPayload”Configured media-server connection with secrets represented by presence flags.
Fields
| Name | Description |
|---|---|
idID!
|
Connection identity. |
providerMediaServerProviderValue!
|
Media-server provider type. |
displayNameString!
|
Display name of the connection. |
baseUrlString!
|
Server base URL. |
externalUrlString
|
Browser-facing URL used for playback deep links. |
enabledBoolean!
|
Whether the connection is active. |
loginEnabledBoolean!
|
Whether login through this server is enabled. |
linkingEnabledBoolean!
|
Whether account linking through this server is enabled. |
autoAddEnabledBoolean!
|
Whether automatic account addition is enabled. |
defaultAppPermissions[AppPermissionValue!]!
|
Default application permissions for auto-added users. |
defaultLibraryGrants[MediaServerDefaultLibraryGrantPayload!]!
|
Default library grants for auto-added users. |
machineIdPresentBoolean!
|
Whether a machine identity is configured. |
apiKeyPresentBoolean!
|
Whether an API key is configured. |
embyServerIdPresentBoolean!
|
Whether an Emby server id is configured. |
embyConnectEnabledBoolean!
|
Whether Emby Connect is enabled. |
pathMappings[MediaServerPathMappingPayload!]!
|
Configured external-to-local path mappings. |
createdAtDateTime!
|
Creation timestamp in RFC 3339 format. |
updatedAtDateTime!
|
Last update timestamp in RFC 3339 format. |
MediaServerConnectionTestPayload
Section titled “MediaServerConnectionTestPayload”Result of a media-server connection test.
Fields
| Name | Description |
|---|---|
statusString!
|
Machine-readable test status. |
messageString
|
Optional human-readable detail. |
MediaServerDefaultLibraryGrantPayload
Section titled “MediaServerDefaultLibraryGrantPayload”Default library permission grant for a media-server connection.
Fields
| Name | Description |
|---|---|
libraryIdID!
|
Library identity receiving the grant. |
permissions[LibraryPermissionValue!]!
|
Permissions granted by default. |
MediaServerPathMappingPayload
Section titled “MediaServerPathMappingPayload”Mapping from an external media-server path to a local path.
Fields
| Name | Description |
|---|---|
sourcePathString!
|
Path reported by the external server. |
destinationPathString!
|
Corresponding local filesystem path. |
MediaServerPlaybackLinkPayload
Section titled “MediaServerPlaybackLinkPayload”A provider-native playback link for a server linked to the current user.
Fields
| Name | Description |
|---|---|
connectionIdID!
|
Connection identity. This is not a credential or provider token. |
displayNameString!
|
User-configured server name. |
providerMediaServerProviderValue!
|
Provider that owns the destination item. |
hrefString!
|
Browser URL for the exact provider media item. |
MediaServerUserGroupPayload
Section titled “MediaServerUserGroupPayload”Grouped media-server users and discovery status.
Fields
| Name | Description |
|---|---|
connectionIdID!
|
Media-server connection identity. |
connectionNameString!
|
Connection display name. |
providerExternalAccountProviderValue!
|
External provider type. |
statusMediaServerUserGroupStatusValue!
|
Discovery status. |
errorMessageString
|
Error detail when discovery failed. |
users[MediaServerUserPayload!]!
|
Users discovered from the server. |
MediaServerUserPayload
Section titled “MediaServerUserPayload”User returned from a media-server account discovery operation.
Fields
| Name | Description |
|---|---|
idString!
|
Server-side user identity. |
usernameString!
|
Username on the server. |
displayNameString
|
Optional display name. |
avatarUrlString
|
Optional avatar URL. |
MediaSettingsPayload
Section titled “MediaSettingsPayload”Effective media path, naming, import, permission, and monitoring settings for one content scope.
Fields
| Name | Description |
|---|---|
scopeContentScopeValue!
|
Content scope to which these settings apply. |
libraryPathString!
|
Primary library path. |
rootFolders[RootFolderPayload!]!
|
Configured root folders. |
requiredAudioLanguages[String!]!
|
Effective configured requirements; |
useSeasonFoldersBoolean!
|
Whether episodic titles use season folders. |
folderTemplateString!
|
Folder naming template. |
seasonFolderTemplateString
|
Season-folder template, or null for facets without seasons. |
specialsFolderTemplateString
|
Specials-folder template, or null when not configured. |
renameEnabledBoolean!
|
Whether automatic renaming is enabled. |
renameTemplateString!
|
Rename filename template. |
renameCollisionPolicyRenameCollisionPolicyValue!
|
Collision policy for renames. |
renameMissingMetadataPolicyRenameMissingMetadataPolicyValue!
|
Missing-metadata policy for renames. |
fillerPolicyFillerPolicyValue
|
Effective filler policy, or null when unset. |
recapPolicyRecapPolicyValue
|
Effective recap policy, or null when unset. |
monitorSpecialsBoolean
|
Whether specials are monitored, or null when unset. |
interSeasonMoviesBoolean
|
Whether inter-season movies are monitored, or null when unset. |
monitorFillerMoviesBoolean
|
Whether filler movies are monitored, or null when unset. |
nfoWriteOnImportBoolean!
|
Whether NFO files are written on import. |
plexmatchWriteOnImportBoolean
|
Whether Plex match files are written on import, or null when unset. |
importModeImportModeValue!
|
Import mode applied to this scope. |
setPermissionsLinuxBoolean!
|
Whether Linux permissions are updated after import. |
fileChmodString
|
File chmod mode, or null when unset. |
folderChmodString
|
Folder chmod mode, or null when unset. |
chownGroupString
|
Chown group, or null when unset. |
MediaStreamDetailPayload
Section titled “MediaStreamDetailPayload”One detected stream, including supplementary streams excluded from scoring.
Fields
| Name | Description |
|---|---|
kindMediaStreamKindValue!
|
Video, audio, or subtitle stream kind. |
codecString
|
Normalized codec name. |
widthInt
|
Video width in pixels. |
heightInt
|
Video height in pixels. |
channelsInt
|
Number of audio channels; this does not imply a speaker layout. |
languageString
|
Normalized language tag, when known. |
inferredLanguageString
|
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. |
nameString
|
Name supplied by the container metadata. |
metadataMediaStreamMetadataPayload!
|
Precise stream properties and evidence. |
MediaStreamDispositionPayload
Section titled “MediaStreamDispositionPayload”Declared stream roles; null means the role is unknown.
Fields
| Name | Description |
|---|---|
defaultBoolean
|
Whether the container marks this stream as the default. |
forcedBoolean
|
Whether the container marks this stream as forced. |
originalBoolean
|
Whether the container marks this as the original track. |
commentaryBoolean
|
Whether this track is explicitly marked as commentary. |
hearingImpairedBoolean
|
Whether this track is marked for viewers with hearing impairments. |
visualImpairedBoolean
|
Whether this track is marked as audio description. |
attachedPictureBoolean
|
Whether this stream is an attached cover picture. |
stillImageBoolean
|
Whether this stream is explicitly marked as a still image. |
MediaStreamMetadataPayload
Section titled “MediaStreamMetadataPayload”Precise properties of one stream; missing values remain unknown.
Fields
| Name | Description |
|---|---|
idString
|
Identifier within the source metadata. |
programIdInt
|
Program containing this stream, when known. |
originalLanguageString
|
Original container language tag before normalization. |
languageProvenanceMediaProvenanceValue!
|
Evidence source for the language tag. |
dispositionMediaStreamDispositionPayload!
|
Declared stream roles and accessibility flags. |
durationSecondsFloat
|
Playback duration in seconds, when established. |
bitrateBpsLong
|
Declared or completely accounted stream bitrate in bits per second. |
bitrateProvenanceMediaProvenanceValue!
|
Evidence source for the stream bitrate. |
estimatedBitrateBpsLong
|
Bounded stream bitrate estimate in bits per second, separate from measured bitrate. |
sampleRateInt
|
Audio sample rate in samples per second. |
sampleFormatString
|
Encoded sample representation, when known; no decoder output format is inferred. |
sampleBitDepthInt
|
Encoded audio sample precision in bits. |
channelLayoutString
|
Declared speaker layout; unknown layouts remain null. |
pixelFormatString
|
Video pixel sampling and component representation. |
profileString
|
Codec profile reported for this stream. |
levelInt
|
Codec-specific level identifier. |
bitDepthInt
|
Video component precision in bits. |
fieldOrderString
|
Declared or observed field order. |
sampleAspectRatioMediaRationalPayload
|
Pixel width-to-height ratio. |
displayAspectRatioMediaRationalPayload
|
Displayed image width-to-height ratio. |
rotationDegreesFloat
|
Display rotation in degrees. |
declaredFrameRateMediaRationalPayload
|
Container or bitstream frame-rate declaration in frames per second. |
observedFrameRateMediaRationalPayload
|
Rational frame rate from bounded timestamp observations. |
variableFrameRateBoolean
|
Whether bounded timing observations establish variable frame rate; null is inconclusive. |
colorMediaColorMetadataPayload!
|
Color signaling and static HDR metadata. |
hdrMediaHdrCapabilitiesPayload!
|
Independent HDR capability evidence. |
MediaStructuralDiagnosticsPayload
Section titled “MediaStructuralDiagnosticsPayload”Opt-in packet and frame-header sampling without decoding media.
Fields
| Name | Description |
|---|---|
reportMediaProbeReportPayload!
|
Inspection status, coverage counters, and warnings. |
sourceLengthLong!
|
Length of the complete physical source in bytes. |
coverage[MediaDiagnosticCoveragePayload!]!
|
Recorded byte ranges read during diagnostics. |
coverageTruncatedBoolean!
|
Whether the bounded coverage inventory omitted additional ranges. |
warningsTruncatedBoolean!
|
Whether additional diagnostic warnings exceeded the inventory limit. |
packetsSampledLong!
|
Number of packet headers inspected. |
frameHeadersSampledLong!
|
Number of elementary frame headers inspected. |
checks[String!]!
|
Names of structural checks performed. |
MetadataAnimeMoviePayload
Section titled “MetadataAnimeMoviePayload”Metadata gateway companion-movie record for an anime series.
Fields
| Name | Description |
|---|---|
nameString!
|
Movie name. |
yearInt
|
Release year, or null when unavailable. |
associationConfidenceString!
|
How confidently the provider associates the movie with the series. |
continuityStatusString!
|
Whether the movie is canon to the series. |
placementString!
|
Where the movie sits relative to the series seasons. |
externalIds[ExternalIdPayload!]!
|
Provider identifiers for the movie. |
MetadataEpisodePayload
Section titled “MetadataEpisodePayload”Metadata gateway episode record.
Fields
| Name | Description |
|---|---|
tvdbIdString!
|
TVDB episode ID. |
episodeNumberInt!
|
Episode number within the season. |
seasonNumberInt!
|
Numeric season containing this episode. |
nameString!
|
Episode title. |
airedDate!
|
Original air date. |
runtimeMinutesInt!
|
Runtime in minutes. |
isFillerBoolean!
|
Whether the episode is marked filler. |
imageUrlString!
|
Episode image URL. |
MetadataMoviePayload
Section titled “MetadataMoviePayload”Full metadata gateway movie record.
Fields
| Name | Description |
|---|---|
tvdbIdString!
|
TVDB movie ID. |
smgIdInt
|
SMG canonical movie title ID, or null when unavailable. |
tmdbIdInt
|
TMDB movie ID, or null when unavailable. |
nameString!
|
Movie title. |
slugString!
|
Provider slug. |
yearInt
|
Release year, or null when unavailable. |
statusString!
|
Provider status. |
overviewString!
|
Overview text. |
posterUrlString!
|
Metadata-provider URL for the poster image. |
languageString!
|
Metadata language code. |
runtimeMinutesInt!
|
Runtime in minutes. |
sortTitleString!
|
Normalized sort title. |
imdbIdString!
|
IMDb title identifier. |
studioString!
|
Studio name. |
tmdbReleaseDateDate
|
TMDB release date, or null when unavailable. |
MetadataSearchItemPayload
Section titled “MetadataSearchItemPayload”Search result from the metadata gateway with nullable provider metadata.
Fields
| Name | Description |
|---|---|
tvdbIdString!
|
TVDB provider ID. |
smgIdInt
|
SMG canonical title ID, or null for legacy-only results. |
tmdbIdInt
|
TMDB provider ID, or null when unavailable. |
primarySourceString
|
Primary metadata-provider source, or null for legacy-only results. |
externalIds[ExternalIdPayload!]!
|
Every external identity supplied by the metadata provider. |
nameString!
|
Metadata title. |
imdbIdString
|
IMDb ID, or null when unavailable. |
slugString
|
Provider slug, or null when unavailable. |
typeString
|
Provider content-type hint, or null when unavailable. |
yearInt
|
Release year, or null when unavailable. |
statusString
|
Provider status, or null when unavailable. |
overviewString
|
Overview text, or null when unavailable. |
popularityFloat
|
Popularity score, or null when unavailable. |
posterUrlString
|
Poster URL, or null when unavailable. |
languageString
|
Metadata language, or null when unavailable. |
runtimeMinutesInt
|
Runtime in minutes, or null when unavailable. |
sortTitleString
|
Normalized sort title, or null when unavailable. |
existingTitleIdID
|
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. |
MetadataSearchMultiPayload
Section titled “MetadataSearchMultiPayload”Metadata search results grouped by content facet.
Fields
| Name | Description |
|---|---|
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. |
MetadataSeasonPayload
Section titled “MetadataSeasonPayload”Metadata gateway season record.
Fields
| Name | Description |
|---|---|
tvdbIdString!
|
TVDB season ID. |
numberInt!
|
Numeric season number assigned by the metadata provider. |
labelString!
|
Season label. |
episodeTypeString!
|
Episode classification. |
MetadataSeriesPayload
Section titled “MetadataSeriesPayload”Full metadata gateway series record with seasons and optional episodes.
Fields
| Name | Description |
|---|---|
tvdbIdString!
|
TVDB series ID. |
nameString!
|
Series title. |
sortNameString!
|
Normalized sort name. |
slugString!
|
Provider slug. |
yearInt
|
First release year, or null when unavailable. |
statusString!
|
Provider status. |
firstAiredDate!
|
First-air date. |
overviewString!
|
Overview text. |
networkString!
|
Network name. |
runtimeMinutesInt!
|
Runtime in minutes. |
posterUrlString!
|
Metadata-provider URL for the poster image. |
countryString!
|
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. |
MonitorSelectionMoviePayload
Section titled “MonitorSelectionMoviePayload”One canon series movie inside an advanced monitoring selection.
Fields
| Name | Description |
|---|---|
nameString!
|
Movie name as it was presented when the selection was made. |
externalIds[ExternalIdPayload!]!
|
Provider identifiers for the selected movie. |
MonitorSelectionPayload
Section titled “MonitorSelectionPayload”Seasons and canon series movies chosen under the ADVANCED monitor type.
Anything absent from the selection stays unmonitored.
Fields
| Name | Description |
|---|---|
seasonNumbers[Int!]!
|
Season numbers to monitor; 0 is specials. |
seriesMovies[MonitorSelectionMoviePayload!]!
|
Canon series movies to monitor. |
MovieEntityPayload
Section titled “MovieEntityPayload”Persisted movie metadata.
Fields
| Name | Description |
|---|---|
idID!
|
Stable movie identifier. |
titleString!
|
Movie title. |
slugString
|
URL-friendly movie key, or null when unavailable. |
yearInt
|
Release year, or null when unknown. |
overviewString
|
Plot or synopsis text, or null before metadata provides it. |
posterUrlString
|
Poster URL, or null when no poster source is available. |
runtimeMinutesInt
|
Runtime in minutes, or null when unknown. |
contentStatusString
|
Catalog content status, or null when unavailable. |
imdbIdString
|
IMDb identifier, or null when unmatched. |
tvdbIdString
|
TVDB identifier, or null when unmatched. |
tmdbIdString
|
TMDB identifier, or null when unmatched. |
malIdString
|
MyAnimeList identifier, or null when unmatched. |
anidbIdString
|
AniDB identifier, or null when unmatched. |
ratingsTitleRatingPayload!
|
Aggregated ratings cached during the movie's latest metadata hydration. |
credits[TitleCreditPayload!]!
|
Cast and crew cached during the movie's latest metadata hydration. |
MutationRoot
Section titled “MutationRoot”Fields
| Name | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
startApplicationUpgradeApplicationUpgradeStartPayload!
|
Begin a signed in-application upgrade for the currently advertised release. Arguments
|
||||||||||||||
addTitleAddTitleResult!
|
Create or reuse a title in an accessible library and return its hydration state. Arguments
|
||||||||||||||
addTitleAndQueueDownloadAddTitleResult!
|
Create or reuse a title and enqueue a download using the supplied source metadata. Arguments
|
||||||||||||||
updateTitleTitlePayload!
|
Patch title metadata and settings while preserving omitted fields. Arguments
|
||||||||||||||
updateTitleTags[TitlePayload!]!
|
Add and remove user tags across a set of titles, returning the updated titles. A patch, not a replacement: reserved Arguments
|
||||||||||||||
setPrimaryMovieFileTitlePayload!
|
Set the primary media file for a movie title. Arguments
|
||||||||||||||
applyTitleFolderChangeChangeTitleFolderPayload!
|
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
|
||||||||||||||
fixTitleMatchFixTitleMatchPayload!
|
Associate a title with a metadata identity and return any hydration or scan result. Arguments
|
||||||||||||||
deleteTitleDeleteTitlePayload!
|
Delete one title, optionally removing its files after preview confirmation. Arguments
|
||||||||||||||
deleteTitlesDeleteTitlesPayload!
|
Accept a background job to delete selected titles and optionally their files. Arguments
|
||||||||||||||
clearTitleReleaseBlocklistEntryClearTitleReleaseBlocklistEntryPayload!
|
Clear one title release blocklist entry so it can be considered again. Arguments
|
||||||||||||||
setTitleMonitoredTitlePayload!
|
Replace a title's monitored state. Arguments
|
||||||||||||||
setCollectionMonitoredSetCollectionMonitoredPayload!
|
Set collection monitoring and return the affected collection episodes. Arguments
|
||||||||||||||
setEpisodeMonitoredEpisodePayload!
|
Set episode monitoring and return the updated episode. Arguments
|
||||||||||||||
setSeriesMovieMonitoredSeriesMovieLinkPayload!
|
Set monitoring for a series-movie link and return the updated link. Arguments
|
||||||||||||||
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 Arguments
|
||||||||||||||
queueExistingTitleDownloadQueueDownloadPayload!
|
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
|
||||||||||||||
queueReplacementReleaseQueueDownloadPayload!
|
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
|
||||||||||||||
queueBestReleaseQueueDownloadPayload!
|
Select and queue the best available release for a title within the requested scope. Arguments
|
||||||||||||||
queueManualImportDownloadQueueActionPayload!
|
Accept a manual file-to-title mapping and enqueue the import for background processing. Arguments
|
||||||||||||||
beginManualImportSelectionManualImportSelectionPayload!
|
Inspect a tracked download and persist a server-owned selection of importable files. Arguments
|
||||||||||||||
retryImportImportResultPayload!
|
Retry a previously failed import, optionally with an archive password. Arguments
|
||||||||||||||
cancelActiveImportBoolean!
|
Cancel a queued or copying import operation by its server-issued stream identity. Arguments
|
||||||||||||||
ignoreTrackedDownloadDownloadQueueActionPayload!
|
Mark a tracked download ignored without deleting it from the download client. Arguments
|
||||||||||||||
markTrackedDownloadFailedDownloadQueueActionPayload!
|
Mark a tracked download failed and optionally suppress automatic reacquisition. Arguments
|
||||||||||||||
assignTrackedDownloadTitleDownloadQueueActionPayload!
|
Attach a tracked download to a title and acquisition scope. Arguments
|
||||||||||||||
pauseDownloadDownloadQueueActionPayload!
|
Pause a tracked download through its configured download client. Arguments
|
||||||||||||||
resumeDownloadDownloadQueueActionPayload!
|
Resume a paused tracked download through its configured download client. Arguments
|
||||||||||||||
deleteDownloadDownloadQueueActionPayload!
|
Delete a tracked download through its configured client and return its prior queue state. Arguments
|
||||||||||||||
triggerJobJobRunPayload!
|
Start the configured background job and return its accepted run snapshot. Arguments
|
||||||||||||||
createIndexerConfigIndexerConfigPayload!
|
Create an indexer configuration with provider, routing, and search defaults. Arguments
|
||||||||||||||
updateIndexerConfigIndexerConfigPayload!
|
Patch an indexer configuration while preserving omitted fields and stored secrets. Arguments
|
||||||||||||||
setIndexerDownloadClientMappingIndexerConfigPayload!
|
Set or clear the download client associated with an indexer. Arguments
|
||||||||||||||
setIndexerSeedingProfileIndexerConfigPayload!
|
Set or clear the seeding profile applied to torrents from an indexer. Arguments
|
||||||||||||||
createSeedingProfileSeedingProfilePayload!
|
Create a torrent seeding profile. Arguments
|
||||||||||||||
updateSeedingProfileSeedingProfilePayload!
|
Patch a torrent seeding profile. Arguments
|
||||||||||||||
deleteSeedingProfileDeleteSeedingProfilePayload!
|
Delete a seeding profile that nothing references. Arguments
|
||||||||||||||
setDefaultSeedingProfileDefaultSeedingProfilePayload!
|
Set or clear the seeding profile applied when nothing more specific matches. Arguments
|
||||||||||||||
setMinimumSeedersFloorDefaultSeedingProfilePayload!
|
Set the minimum-seeder floor applied when no seeding profile resolves. Arguments
|
||||||||||||||
createProxyConfigProxyConfigPayload!
|
Create a proxy configuration. Arguments
|
||||||||||||||
updateProxyConfigProxyConfigPayload!
|
Patch a proxy configuration while preserving omitted fields. Arguments
|
||||||||||||||
deleteProxyConfigDeleteProxyConfigPayload!
|
Delete a proxy configuration. Arguments
|
||||||||||||||
testProxyConfigProxyTestResultPayload!
|
Test a proxy connection and return provider validation details. Arguments
|
||||||||||||||
resetProxyHostKeyProxyConfigPayload!
|
Forget the pinned tunnel host key so the next connection trusts the server again. Arguments
|
||||||||||||||
deleteIndexerConfigDeleteIndexerConfigPayload!
|
Delete an indexer configuration. Arguments
|
||||||||||||||
createDownloadClientConfigDownloadClientConfigPayload!
|
Create a download-client configuration and seed supported routing defaults. Arguments
|
||||||||||||||
updateDownloadClientConfigDownloadClientConfigPayload!
|
Patch a download-client configuration while preserving omitted provider secrets. Arguments
|
||||||||||||||
deleteDownloadClientConfigDeleteDownloadClientConfigPayload!
|
Delete a download-client configuration and clear dependent indexer mappings. Arguments
|
||||||||||||||
reorderDownloadClientConfigsReorderDownloadClientConfigsPayload!
|
Persist the ordering of download-client configurations. Arguments
|
||||||||||||||
testDownloadClientConnectionProviderValidationPayload!
|
Test a download-client connection using stored or supplied configuration values. Arguments
|
||||||||||||||
createSubtitleProviderConfigSubtitleProviderConfigPayload!
|
Create a subtitle-provider configuration. Arguments
|
||||||||||||||
updateSubtitleProviderConfigSubtitleProviderConfigPayload!
|
Patch a subtitle-provider configuration while preserving omitted fields and secrets. Arguments
|
||||||||||||||
deleteSubtitleProviderConfigDeleteSubtitleProviderConfigPayload!
|
Delete a subtitle-provider configuration. Arguments
|
||||||||||||||
testSubtitleProviderConnectionProviderValidationPayload!
|
Test a subtitle-provider connection and return provider validation details. Arguments
|
||||||||||||||
testIndexerConnectionProviderValidationPayload!
|
Test an indexer connection and return provider validation details. Arguments
|
||||||||||||||
syncIndexerConfigIndexerConfigSyncPayload!
|
Synchronize an indexer configuration with its provider and return the sync result. Arguments
|
||||||||||||||
triggerRssSyncRssSyncReportPayload!
|
Run RSS synchronization for accessible indexers and return its report. |
||||||||||||||
setMyUiSettingsUiSettingsPayload!
|
Replaces the authenticated actor's UI settings, retaining the current date-time format when the input omits or nulls it. Arguments
|
||||||||||||||
updateSubtitleSettingsSubtitleSettingsPayload!
|
Saves subtitle preferences after checking the catalog-settings permission. Arguments
|
||||||||||||||
updateAcquisitionSettingsAcquisitionSettingsPayload!
|
Saves acquisition thresholds and polling intervals after checking the catalog-settings permission. Arguments
|
||||||||||||||
updateGeneralSettingsGeneralSettingsPayload!
|
Saves general system settings after checking the system-settings permission. Arguments
|
||||||||||||||
clearTitleImageCacheClearTitleImageCachePayload!
|
Requests title-image cache clearing and returns the request timestamp after authorization. |
||||||||||||||
updateRecycleBinSettingsRecycleBinSettingsPayload!
|
Saves recycle-bin settings after checking the system-settings permission. Arguments
|
||||||||||||||
updateVerificationSettingsVerificationSettingsPayload!
|
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
|
||||||||||||||
updatePluginAutoUpdateSettingsPluginAutoUpdateSettingsPayload!
|
Saves the automatic official-plugin patch update setting after checking the system-settings permission. Arguments
|
||||||||||||||
updateAutoBackupSettingsAutoBackupSettingsPayload!
|
Saves auto-backup scheduling and key changes after checking the system-settings permission. Arguments
|
||||||||||||||
updateBackupSettingsBackupSettingsPayload!
|
Saves the custom backup path after checking the system-settings permission. Arguments
|
||||||||||||||
acknowledgeAutoBackupDisabledMissingKeyNoticeAutoBackupSettingsPayload!
|
Marks the missing auto-backup-key notice as acknowledged and returns refreshed backup status. |
||||||||||||||
updateSecuritySettingsSecuritySettingsPayload!
|
Saves security and MFA requirements, applies effective login state, and revokes authless OAuth refresh grants when login becomes enabled. Arguments
|
||||||||||||||
createOauthClientRegistrationOauthClientRegistrationPayload!
|
Registers a public OAuth application with exact HTTPS callbacks and mandatory S256 PKCE. Arguments
|
||||||||||||||
updateOauthClientRegistrationOauthClientRegistrationPayload!
|
Replaces custom OAuth application metadata and callback allowlist. Disabling revokes all of its grants. Arguments
|
||||||||||||||
deleteOauthClientRegistrationDeleteOAuthClientRegistrationPayload!
|
Deletes a custom OAuth application and revokes every active grant issued to it. Arguments
|
||||||||||||||
createMediaServerConnectionMediaServerConnectionPayload!
|
Creates a media-server connection with defaults for omitted enablement flags and redacted secret fields in the result. Arguments
|
||||||||||||||
updateMediaServerConnectionMediaServerConnectionPayload!
|
Patches a media-server connection by ID, leaving omitted fields unchanged and honoring explicit clear flags for secrets. Arguments
|
||||||||||||||
deleteMediaServerConnectionDeleteMediaServerConnectionPayload!
|
Deletes the media-server connection identified by Arguments
|
||||||||||||||
testMediaServerConnectionProviderValidationPayload!
|
Validates the selected media-server connection without changing its saved configuration. Arguments
|
||||||||||||||
discoverPlexMediaServers[PlexServerDiscoveryPayload!]!
|
Discovers Plex servers for the supplied token without saving a connection. Arguments
|
||||||||||||||
discoverEmbyConnectServers[EmbyConnectServerPayload!]!
|
Discovers Emby Connect servers using credentials without saving a connection. Arguments
|
||||||||||||||
testEmbyConnectMediaServerConnectionTestPayload!
|
Validates an Emby Connect configuration without changing saved settings. Arguments
|
||||||||||||||
upsertDelayProfileDelayProfilePayload!
|
Creates or updates a delay profile after checking the catalog-settings permission. Arguments
|
||||||||||||||
deleteDelayProfileDelayProfileDeletionPayload!
|
Deletes the delay profile identified by Arguments
|
||||||||||||||
createTitleTagDefinitionTitleTagDefinitionMutationPayload!
|
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 Arguments
|
||||||||||||||
updateTitleTagDefinitionTitleTagDefinitionMutationPayload!
|
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
|
||||||||||||||
deleteTitleTagDefinitionTitleTagDefinitionDeletionPayload!
|
Deletes a title tag and strips it from every title and delay profile. Arguments
|
||||||||||||||
updateMediaSettingsMediaSettingsPayload!
|
Saves media settings for one content scope, with nullable fields passed through as application update semantics. Arguments
|
||||||||||||||
updateLibraryPathsLibraryPathsPayload!
|
Replace nonblank default library roots for movie, series, and anime facets. Arguments
|
||||||||||||||
updateServiceSettingsServiceSettingsPayload!
|
Saves service TLS paths after checking the system-settings permission. Arguments
|
||||||||||||||
saveQualityProfileSettingsQualityProfileSettingsPayload!
|
Saves quality profiles and global or facet selections, using profile IDs to match existing profiles. Arguments
|
||||||||||||||
updateDownloadClientRouting[DownloadClientRoutingEntryPayload!]!
|
Replaces download-client routing entries for one content scope after authorization. Arguments
|
||||||||||||||
updateIndexerRouting[IndexerRoutingEntryPayload!]!
|
Replaces indexer routing entries for one content scope after authorization. Arguments
|
||||||||||||||
deleteQualityProfileQualityProfileSettingsPayload!
|
Deletes the quality profile identified by Arguments
|
||||||||||||||
webauthnRegisterStartWebauthnChallengePayload!
|
Starts passkey registration and returns a short-lived challenge without credential material. |
||||||||||||||
webauthnRegisterCompletePasskeySummaryPayload!
|
Completes passkey registration using the authorized enrollment challenge. Arguments
|
||||||||||||||
webauthnLoginEnrollmentStartWebauthnChallengePayload!
|
Starts passkey enrollment for a restricted post-primary MFA-enrollment session. |
||||||||||||||
webauthnLoginEnrollmentCompleteLoginPasskeyEnrollmentCompletePayload!
|
Completes passkey enrollment for a restricted post-primary MFA-enrollment session and issues a full session. Arguments
|
||||||||||||||
totpEnrollmentStartTotpEnrollmentStartPayload!
|
Starts TOTP enrollment for the authenticated session or MFA-enrollment session. |
||||||||||||||
totpEnrollmentCompleteTotpEnrollmentCompletePayload!
|
Completes TOTP enrollment with the one-time challenge code and returns status plus recovery codes. Arguments
|
||||||||||||||
completeLoginMfaEnrollmentLoginMfaEnrollmentCompletePayload!
|
Completes required login MFA enrollment, returns one-time recovery codes, and issues the authenticated login payload. Arguments
|
||||||||||||||
mfaVerifyStepUpLoginPayload!
|
Verifies TOTP for a configuration step-up and issues a session with the resulting freshness window. Arguments
|
||||||||||||||
accountSecurityPasswordVerifyLoginPayload!
|
Verifies the current local password and returns a fresh account-security session. Arguments
|
||||||||||||||
accountSecurityPasskeyStartWebauthnChallengePayload!
|
Starts a passkey assertion that reauthenticates the current interactive session. |
||||||||||||||
accountSecurityPasskeyCompleteLoginPayload!
|
Completes a passkey reauthentication assertion and returns a fresh account-security session. Arguments
|
||||||||||||||
totpDisableTotpStatusPayload!
|
Disables TOTP after verifying the current TOTP code. Arguments
|
||||||||||||||
totpRegenerateRecoveryCodesTotpEnrollmentCompletePayload!
|
Regenerates recovery codes after verifying TOTP; returned codes are one-time secrets. Arguments
|
||||||||||||||
webauthnAuthenticateStartWebauthnChallengePayload!
|
Starts passkey authentication, masking failures when form login is enabled. Arguments
|
||||||||||||||
webauthnAuthenticateCompleteLoginPayload!
|
Completes passkey authentication and issues a login payload without exposing the credential response. Arguments
|
||||||||||||||
loginVerificationPasskeyStartWebauthnChallengePayload!
|
Starts the user-bound passkey assertion required after primary credentials succeed. Arguments
|
||||||||||||||
loginVerificationPasskeyCompleteLoginPayload!
|
Completes the passkey assertion required after primary credentials succeed. Arguments
|
||||||||||||||
loginVerificationTotpCompleteLoginPayload!
|
Completes the TOTP or recovery-code fallback required after primary credentials succeed. Arguments
|
||||||||||||||
deleteMyPasskeyDeleteMyPasskeyPayload!
|
Deletes the authenticated actor's passkey identified by Arguments
|
||||||||||||||
revokeMyOauthAppRevokeMyOauthAppPayload!
|
Revokes the authenticated actor's OAuth grant identified by Arguments
|
||||||||||||||
createMyApiKeyCreateMyApiKeyPayload!
|
Creates an API key for the interactive actor and returns its secret once. Arguments
|
||||||||||||||
revokeMyApiKeyRevokeMyApiKeyPayload!
|
Revokes one user-created API key owned by the interactive actor. Arguments
|
||||||||||||||
loginLoginPayload!
|
Authenticates local credentials, optionally verifies required TOTP, and issues a session or MFA-enrollment token. Arguments
|
||||||||||||||
completeRequiredPasswordChangeLoginPayload!
|
Replaces an administrator-provided temporary password and issues the full session. Arguments
|
||||||||||||||
completeSetupCompleteSetupPayload!
|
Mark the setup wizard as complete. |
||||||||||||||
createUserUserPayload!
|
Creates a user with normalized app and library permissions after checking the manage-users permission. Arguments
|
||||||||||||||
setUserPasswordUserPayload!
|
Sets another user's password or changes the authenticated actor's password after validating the target and credentials. Arguments
|
||||||||||||||
setUserAppPermissionsUserPayload!
|
Replaces a user's app permissions after checking the manage-permissions permission. Arguments
|
||||||||||||||
setUserLibraryPermissionsUserPayload!
|
Replaces a user's library grants after checking the manage-permissions permission. Arguments
|
||||||||||||||
setUserLoginEnabledUserPayload!
|
Enables or disables login for the user identified in the input and invalidates active connections. Arguments
|
||||||||||||||
deleteUserDeleteUserPayload!
|
Deletes the user identified by Arguments
|
||||||||||||||
resetUserMfaUserPayload!
|
Resets all authentication factors for the user identified by Arguments
|
||||||||||||||
createExternalAccountInviteLinkedAccountPayload!
|
Creates an external-account invite for a target user and connection without returning provider credentials. Arguments
|
||||||||||||||
linkPlexAccountLinkedAccountPayload!
|
Links the authenticated actor to Plex using a connection ID and token. Arguments
|
||||||||||||||
linkJellyfinAccountLinkedAccountPayload!
|
Links the authenticated actor to Jellyfin using a connection ID and credentials. Arguments
|
||||||||||||||
linkCurrentOAuthJellyfinAccountLinkedAccountPayload!
|
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
|
||||||||||||||
linkEmbyAccountLinkedAccountPayload!
|
Links the authenticated actor to Emby using the selected connection mode and credentials. Arguments
|
||||||||||||||
unlinkExternalAccountUnlinkExternalAccountPayload!
|
Unlinks the external account identified by Arguments
|
||||||||||||||
loginWithPlexLoginPayload!
|
Authenticates through Plex and issues a session token. Arguments
|
||||||||||||||
loginWithJellyfinLoginPayload!
|
Authenticates through Jellyfin, applies configured TOTP requirements, and issues a session or MFA-enrollment token. Arguments
|
||||||||||||||
loginWithEmbyLoginPayload!
|
Authenticates through Emby, applies configured TOTP requirements, and issues a session or MFA-enrollment token. Arguments
|
||||||||||||||
createLibraryLibraryPayload!
|
Create a media library with roots and optional acquisition or import settings. Arguments
|
||||||||||||||
updateLibraryLibraryPayload!
|
Patch a library while preserving omitted fields. Arguments
|
||||||||||||||
deleteLibraryDeleteLibraryPayload!
|
Delete the library configuration identified by the supplied ID. Arguments
|
||||||||||||||
scanLibraryLibraryScanProgressPayload!
|
Start a library scan and return the accepted scan session snapshot. Arguments
|
||||||||||||||
scanTitleLibraryLibraryScanSummaryPayload!
|
Scan the library paths associated with one title and return the summary. Arguments
|
||||||||||||||
cancelLibraryScanCancelLibraryScanPayload!
|
Request cancellation of a library scan and return the cancellation result. Arguments
|
||||||||||||||
resolvePendingImportResolvePendingImportPayload!
|
Resolve a pending import by creating or selecting its title metadata. Arguments
|
||||||||||||||
bindPendingImportResolvePendingImportPayload!
|
Bind a pending import to an existing collection and optional episodes. Arguments
|
||||||||||||||
ignorePendingImportIgnorePendingImportPayload!
|
Mark a pending import ignored without importing its files. Arguments
|
||||||||||||||
applyMediaRenameMediaRenameApplyPayload!
|
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
|
||||||||||||||
mediaFileDiscEpisodeTargets[MediaDiscEpisodeTargetPayload!]!
|
List catalogued episodes eligible for explicit mapping to this registered disc image. Arguments
|
||||||||||||||
mapMediaFileDiscEpisodesTitleMediaFilePayload!
|
Save explicit disc-title-to-episode associations on the existing physical image. Arguments
|
||||||||||||||
diagnoseMediaFileMediaStructuralDiagnosticsPayload!
|
Opt-in bounded header diagnostics; this does not change import acceptance or stored analysis. Arguments
|
||||||||||||||
selectMediaFileDiscTitleTitleMediaFilePayload!
|
Select a playback title in a registered ISO; null restores automatic selection. Arguments
|
||||||||||||||
deleteMediaFileDeleteMediaFilePayload!
|
Accept a background job to delete a media file, optionally removing it from disk. Arguments
|
||||||||||||||
deleteEpisodeFilesDeleteEpisodeFilesPayload!
|
Accept a background job deleting every media file linked to the supplied episodes of one title. The aggregate preview from Arguments
|
||||||||||||||
renameTitlesRenameTitlesPayload!
|
Start a background job renaming the files of the given titles. Arguments
|
||||||||||||||
applyMediaRenameBulkMediaRenameApplyPayload!
|
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
|
||||||||||||||
rehydrateAllMetadataRehydrateAllMetadataPayload!
|
Rehydrate accessible title metadata for one language and report cleared title counts. Arguments
|
||||||||||||||
startLocationOperationStartLocationOperationPayload!
|
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 A root change (US4) and a root consolidation (US5) confirm through the
same mutation, the same Arguments
|
||||||||||||||
cancelLocationOperationCancelLocationOperationPayload!
|
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
|
||||||||||||||
abandonLocationOperationAbandonLocationOperationPayload!
|
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
|
||||||||||||||
resumeLocationOperationResumeLocationOperationPayload!
|
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
|
||||||||||||||
submitMediaRequestSubmitMediaRequestPayload!
|
Create a media request with the requested metadata and acquisition preferences. Arguments
|
||||||||||||||
approveMediaRequestApproveMediaRequestPayload!
|
Approve a request, create or update its title, and report any queued search attempt. Arguments
|
||||||||||||||
dismissMediaRequestMediaRequestActionPayload!
|
Dismiss a media request without creating a catalog title. Arguments
|
||||||||||||||
updateMyMediaRequestMediaRequestPayload!
|
Update the caller's pending request preferences and return the current request. Arguments
|
||||||||||||||
cancelMyMediaRequestMediaRequestActionPayload!
|
Cancel the caller's request without deleting an already-created title. Arguments
|
||||||||||||||
triggerTitleMismatchRecoverySearchTriggerTitleMismatchRecoverySearchPayload!
|
Reopen title-mismatch scopes after a rematch so acquisition coverage can converge again. Arguments
|
||||||||||||||
pauseWantedItemPauseWantedItemPayload!
|
Pause acquisition for a scope. Arguments
|
||||||||||||||
resumeWantedItemResumeWantedItemPayload!
|
Resume acquisition for a paused scope. Arguments
|
||||||||||||||
forceGrabPendingReleaseForceGrabPendingReleasePayload!
|
Force a pending release to be grabbed and report whether the grab was accepted. Arguments
|
||||||||||||||
dismissPendingReleaseDismissPendingReleasePayload!
|
Dismiss a pending release so it is not considered for the current pending state. Arguments
|
||||||||||||||
triggerAcquisitionSearchAcquisitionSearchJobPayload!
|
Start a background acquisition search for the selected wanted or upgrade scopes. Arguments
|
||||||||||||||
cancelAcquisitionSearchCancelAcquisitionSearchPayload!
|
Request cancellation of an acquisition-search job and report whether its state changed. Arguments
|
||||||||||||||
createRuleSetRuleSetPayload!
|
Create a catalog rule set with optional facet scope, priority, and enabled state. Arguments
|
||||||||||||||
updateRuleSetRuleSetPayload!
|
Patch a rule set while preserving omitted fields. Arguments
|
||||||||||||||
deleteRuleSetDeleteRuleSetPayload!
|
Delete a rule set. Arguments
|
||||||||||||||
toggleRuleSetRuleSetPayload!
|
Set whether a rule set is enabled. Arguments
|
||||||||||||||
setTitleRequiredAudioSetTitleRequiredAudioPayload!
|
Replace required audio languages for one title and facet. Arguments
|
||||||||||||||
validateRuleSetRuleValidationResultPayload!
|
Validate rule source without saving it, using a supplied or temporary rule identity. Arguments
|
||||||||||||||
testRuleSetTestRuleSetPayload!
|
Evaluate the current unsaved editor draft against title-aware release facts without saving it. Arguments
|
||||||||||||||
installTrackedRulePackTrackedRulePackPayload!
|
Install the whole verified pack with selected templates enabled. Arguments
|
||||||||||||||
previewTrackedRulePackUpdateTrackedRulePackPreviewPayload!
|
Preview the exact template changes from the latest compatible source version. Arguments
|
||||||||||||||
updateTrackedRulePackTrackedRulePackPayload!
|
Apply a previously reviewed immutable source version to a tracked rule pack. Arguments
|
||||||||||||||
setTrackedRulePackSettingsTrackedRulePackPayload!
|
Atomically retain editable member settings and the automatic-update preference. Arguments
|
||||||||||||||
copyTrackedRulePackRuleRuleSetPayload!
|
Copy one tracked rule to an editable custom rule and disable the source binding. Arguments
|
||||||||||||||
uninstallTrackedRulePackDeleteTrackedRulePackPayload!
|
Uninstall a tracked rule pack and its owned rules. Arguments
|
||||||||||||||
createMaintenanceRuleSetMaintenanceRuleSetDetail!
|
Create a maintenance rule set together with its first matcher revision. Arguments
|
||||||||||||||
updateMaintenanceRuleMatcherMaintenanceRuleSetDetail!
|
Replace a rule set's matcher, action, and grace period by appending a revision. Arguments
|
||||||||||||||
updateMaintenanceRuleMetadataMaintenanceRuleSet!
|
Rename and re-scope a rule set without touching its matcher, so no revision is created. Arguments
|
||||||||||||||
deleteMaintenanceRuleSetDeleteMaintenanceRuleSetPayload!
|
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 Arguments
|
||||||||||||||
validateMaintenanceRuleMaintenanceRuleValidationPayload!
|
Compile and check maintenance rule source without saving it. Arguments
|
||||||||||||||
previewMaintenanceRuleMaintenancePreviewPayload!
|
Evaluate one matcher against a bounded title selection without saving anything. Arguments
|
||||||||||||||
setMaintenanceRuleModeMaintenanceRuleSet!
|
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
|
||||||||||||||
setMaintenanceRuleArmingMaintenanceRuleSet!
|
Set how far one rule set's effects are armed. Destructive arming requires acknowledging the rule's current candidate count. Arguments
|
||||||||||||||
runMaintenanceActionHandlerNowMaintenanceEvaluationTriggerPayload!
|
Run the maintenance action handler immediately instead of waiting for its schedule. |
||||||||||||||
setMaintenanceInstanceGatesMaintenanceInstanceGates!
|
Arm or disarm the instance-wide maintenance gates. Omitted fields keep their stored value. Arguments
|
||||||||||||||
excludeMaintenanceSubjectMaintenanceExclusion!
|
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
|
||||||||||||||
removeMaintenanceExclusionDeleteMaintenanceExclusionPayload!
|
Remove a maintenance exclusion. Arguments
|
||||||||||||||
runMaintenanceEvaluationNowMaintenanceEvaluationTriggerPayload!
|
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
|
||||||||||||||
createRequestRuleSetRequestRuleSetDetail!
|
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
|
||||||||||||||
updateRequestRuleMatcherRequestRuleSetDetail!
|
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
|
||||||||||||||
updateRequestRuleMetadataRequestRuleSet!
|
Rename and re-scope a rule set without touching its matcher, so no revision is created. Arguments
|
||||||||||||||
setRequestRuleModeRequestRuleSetDetail!
|
Move a request rule set between evaluation modes. Arguments
|
||||||||||||||
deleteRequestRuleSetDeleteRequestRuleSetPayload!
|
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
|
||||||||||||||
validateRequestRuleRequestRuleValidationPayload!
|
Compile and check request rule source without saving it. Arguments
|
||||||||||||||
previewRequestRuleRequestRulePreviewPayload!
|
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 Arguments
|
||||||||||||||
setRequestRuleInstanceGatesRequestRuleInstanceGates!
|
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
|
||||||||||||||
extendTitleClaimTitleClaim!
|
Push a live claim's window out. Requires title management on the claim's own library. Arguments
|
||||||||||||||
convertTitleClaimToPermanentTitleClaim!
|
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
|
||||||||||||||
releaseTitleClaimTitleClaim!
|
Withdraw a claim by hand. The reason is required and kept as history. Arguments
|
||||||||||||||
refreshPluginCatalog[RegistryPluginPayload!]!
|
Refresh the configured plugin registry catalogs and return the available plugins. |
||||||||||||||
beginInstallPluginPluginInstallProgressPayload!
|
Start background installation of a catalog plugin and return the initial progress snapshot. Arguments
|
||||||||||||||
uninstallPluginUninstallPluginPayload!
|
Uninstall a plugin and remove its installation record. Arguments
|
||||||||||||||
togglePluginPluginInstallationPayload!
|
Enable or disable an installed plugin. Arguments
|
||||||||||||||
beginUpgradePluginPluginInstallProgressPayload!
|
Start background upgrade of an installed catalog plugin and return the initial progress snapshot. Arguments
|
||||||||||||||
inspectManualPluginRepoManualPluginPreviewPayload!
|
Inspect a GitHub plugin repository without installing its artifact. Arguments
|
||||||||||||||
installManualPluginPluginInstallationPayload!
|
Install a plugin directly from an inspected GitHub repository. Arguments
|
||||||||||||||
installUploadedPluginPluginInstallationPayload!
|
Install a base64-encoded WebAssembly plugin after explicit risk acknowledgement. Arguments
|
||||||||||||||
createNotificationChannelNotificationChannelPayload!
|
Create an enabled notification channel with provider configuration. Arguments
|
||||||||||||||
updateNotificationChannelNotificationChannelPayload!
|
Patch a notification channel while preserving omitted fields and provider secrets. Arguments
|
||||||||||||||
deleteNotificationChannelDeleteNotificationChannelPayload!
|
Delete a notification channel. Arguments
|
||||||||||||||
testNotificationChannelNotificationChannelTestPayload!
|
Test a notification channel and return the delivery result. Arguments
|
||||||||||||||
createNotificationSubscriptionNotificationSubscriptionPayload!
|
Create an enabled notification subscription for a target and event. Arguments
|
||||||||||||||
updateNotificationSubscriptionNotificationSubscriptionPayload!
|
Patch a notification subscription while preserving omitted fields. Arguments
|
||||||||||||||
deleteNotificationSubscriptionDeleteNotificationSubscriptionPayload!
|
Delete a notification subscription. Arguments
|
||||||||||||||
createBackupBackupInfoPayload!
|
Create a password-protected backup and return its stored backup metadata. Arguments
|
||||||||||||||
prepareBackupDownloadBackupDownloadUrlPayload!
|
Create a short-lived authorization token for downloading an existing backup. Arguments
|
||||||||||||||
deleteBackupDeleteBackupPayload!
|
Delete a stored backup by filename and report whether it existed. Arguments
|
||||||||||||||
inspectRestoreBundleRestoreInspectPayload!
|
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
|
||||||||||||||
applyRestoreBundleRestoreApplyPayload!
|
Stage an inspected restore bundle for application on restart and schedule that restart. Arguments
|
||||||||||||||
saveExternalImportSetupSecretDraftSaveExternalImportSetupSecretDraftPayload!
|
Save the caller's external-import secret draft and report whether another draft was replaced. Arguments
|
||||||||||||||
clearExternalImportSetupSecretDraftClearExternalImportSetupSecretDraftPayload!
|
Clear the caller's external-import secret draft; clearing an absent draft is harmless. |
||||||||||||||
startExternalImportArrSourceWarmupExternalImportMonitorWarmupProgressPayload!
|
Start or reuse a background Sonarr or Radarr warmup and return its current progress snapshot. Arguments
|
||||||||||||||
startExternalImportProwlarrWarmupExternalImportMonitorWarmupProgressPayload!
|
Start or reuse a background Prowlarr warmup and return its current progress snapshot. Arguments
|
||||||||||||||
cancelExternalImportArrSourceWarmupCancelExternalImportMonitorWarmupPayload!
|
Request cancellation of an Arr source warmup and report whether cancellation was accepted. Arguments
|
||||||||||||||
validateExternalImportConnectionExternalImportConnectionValidationPayload!
|
Test one Sonarr, Radarr, or Prowlarr connection without starting a full warmup. Arguments
|
||||||||||||||
previewExternalImportExternalImportPreviewPayload!
|
Connect to Sonarr and/or Radarr, fetch their configs, return a preview. Arguments
|
||||||||||||||
finalizeExternalImportFinalizeExternalImportPayload!
|
Apply selected source mappings, imported monitoring state, scan hints, and safe settings. The operation consumes completed warmup sessions after successful reconciliation. Arguments
|
||||||||||||||
executeExternalImportExternalImportResultPayload!
|
Re-connect to Sonarr/Radarr, fetch configs, and create selected items in Scryer. Arguments
|
||||||||||||||
createPostProcessingScriptPostProcessingScriptPayload!
|
Create an enabled post-processing script after validating its type and content. Arguments
|
||||||||||||||
updatePostProcessingScriptPostProcessingScriptPayload!
|
Update selected fields of a post-processing script and revalidate changed executable content. Arguments
|
||||||||||||||
deletePostProcessingScriptDeletePostProcessingScriptPayload!
|
Delete a post-processing script; this requires catalog-settings permission. Arguments
|
||||||||||||||
togglePostProcessingScriptPostProcessingScriptPayload!
|
Enable or disable a post-processing script, requiring acknowledgement when enabling inline shell code. Arguments
|
||||||||||||||
searchSubtitlesSubtitleSearchPayload!
|
Search configured providers for subtitles matching a media file, and report why the search returned what it did. Arguments
|
||||||||||||||
downloadSubtitleDownloadSubtitlePayload!
|
Download a provider subtitle and save it beside the selected media file. Arguments
|
||||||||||||||
deleteExternalSubtitleDeleteExternalSubtitlePayload!
|
Delete an external subtitle file and its tracked record. Arguments
|
||||||||||||||
blocklistExternalSubtitleBlocklistExternalSubtitlePayload!
|
Delete a provider-backed subtitle and add its provider result to the subtitle blocklist. Arguments
|
||||||||||||||
restoreRecycledItemRestoreRecycledItemPayload!
|
Restore a recycled item back to its original path on disk. Arguments
|
||||||||||||||
restoreRecycledItemsRestoreRecycledItemsPayload!
|
Restore selected recycled items using one background job. Arguments
|
||||||||||||||
deleteRecycledItemDeleteRecycledItemPayload!
|
Permanently delete a single recycled item and its retained file when applicable. Arguments
|
||||||||||||||
deleteRecycledItemsDeleteRecycledItemsPayload!
|
Permanently delete selected recycled items using one background job. Arguments
|
||||||||||||||
emptyRecycleBinEmptyRecycleBinPayload!
|
Empty recycle bins for the selected libraries using a background job. Arguments
|
||||||||||||||
startInteractiveReleaseSearchInteractiveReleaseSearchPayload!
|
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
|
||||||||||||||
cancelInteractiveReleaseSearchCancelInteractiveReleaseSearchPayload!
|
Cancel a running interactive release-search job. Arguments
|
||||||||||||||
issueInteractiveReleaseCandidateTokenIndexerSearchResultPayload!
|
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
|
||||||||||||||
queueUnlinkedReleaseQueueUnlinkedReleasePayload!
|
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
|
NavigationBadgeCountsPayload
Section titled “NavigationBadgeCountsPayload”Authorization-filtered counts used for application navigation indicators.
Fields
| Name | Description |
|---|---|
pendingImportCountsPendingImportCountsPayload!
|
Pending imports visible to the caller. |
pendingMediaRequestCountsMediaRequestCountsPayload!
|
Pending media requests visible to the caller. |
activityImportCountInt!
|
Count of imports awaiting operator attention and visible to the caller. |
pluginUpdateCountInt!
|
Count of available plugin updates visible to the caller. |
pluginBlockedCountInt!
|
Count of installed plugins blocked on this version of Scryer and visible to the caller. |
NotificationChannelPayload
Section titled “NotificationChannelPayload”Configured notification channel and its redacted provider settings.
Fields
| Name | Description |
|---|---|
idID!
|
Notification channel ID. |
nameString!
|
Channel display name. |
channelTypeString!
|
Provider channel type. |
config[ProviderConfigValuePayload!]!
|
Non-secret channel configuration values. |
storedSecretKeys[String!]!
|
Configuration keys whose secret values are stored but not returned. |
mediaServerConnectionIdID
|
Media-server connection used by this channel, when applicable. |
isEnabledBoolean!
|
Whether notifications are enabled for this channel. |
blockedReasonString
|
Why the channel's plugin is blocked on this version of Scryer, or null when it is running. |
createdAtDateTime!
|
Channel creation time in UTC. |
updatedAtDateTime!
|
Time of the latest channel update in UTC. |
NotificationChannelTestPayload
Section titled “NotificationChannelTestPayload”Result of testing a notification channel configuration.
Fields
| Name | Description |
|---|---|
idID!
|
Tested notification channel ID. |
statusString!
|
Test outcome status. |
messageString
|
Provider response or failure detail, when available. |
retryAfterSecondsInt
|
Suggested retry delay in seconds, when the provider requests one. |
NotificationSubscriptionPayload
Section titled “NotificationSubscriptionPayload”Subscription connecting a notification channel to an event target and scope.
Fields
| Name | Description |
|---|---|
idID!
|
Subscription ID. |
channelIdID
|
Notification channel ID, or null when the subscription has no channel. |
targetKindString!
|
Target category for the subscription. |
targetIdID!
|
ID of the subscribed target. |
eventTypeString!
|
Event type that triggers delivery. |
scopeString!
|
Scope category used to limit matching events. |
scopeIdString
|
Scope key, or null when the scope is global. |
isEnabledBoolean!
|
Whether this subscription is enabled. |
createdAtDateTime!
|
Subscription creation time in UTC. |
updatedAtDateTime!
|
Time of the latest subscription update in UTC. |
NotificationTargetPayload
Section titled “NotificationTargetPayload”Enabled notification target available for subscription.
Fields
| Name | Description |
|---|---|
idID!
|
Target ID. |
targetKindString!
|
Target category. |
nameString!
|
Target display name. |
providerTypeString!
|
Provider type associated with the target. |
mediaServerProviderMediaServerProviderValue
|
Media-server provider, when the target is a media-server connection. |
mediaServerConnectionIdID
|
Media-server connection ID, when applicable. |
isEnabledBoolean!
|
Whether this target can receive notifications. |
OauthAuthorizationClientPayload
Section titled “OauthAuthorizationClientPayload”Public authorization-screen identity for a validated OAuth request.
Fields
| Name | Description |
|---|---|
clientIdString!
|
Requested OAuth client identifier. |
displayNameString!
|
Client name safe to display after callback validation. |
scopeString!
|
Server-validated, canonical requested scope set for this authorization decision. |
OauthClientRegistrationPayload
Section titled “OauthClientRegistrationPayload”An OAuth application allowed to receive Scryer authorization codes.
Fields
| Name | Description |
|---|---|
clientIdString!
|
Immutable OAuth client identifier. |
displayNameString!
|
Name shown to users on the authorization screen. |
redirectUris[String!]!
|
Exact callback URL allowlist. Managed native clients may use an empty list. |
enabledBoolean!
|
Whether the application can authorize or refresh tokens. |
sourceOauthClientSourceValue!
|
Whether the application is managed by Scryer or an administrator. |
kindOauthClientKindValue!
|
What the application is for. Immutable after creation. |
OauthConnectedAppPayload
Section titled “OauthConnectedAppPayload”Non-secret summary of an OAuth grant.
Fields
| Name | Description |
|---|---|
grantIdID!
|
Grant ID used to revoke this authorization. |
clientIdString!
|
OAuth client identifier. |
clientNameString!
|
OAuth client display name. |
authorizedAtDateTime!
|
UTC time when authorization was granted. |
lastUsedAtDateTime
|
UTC time when the grant was last used, or null when unused. |
OrphanScopePayload
Section titled “OrphanScopePayload”Union member indicating that no known acquisition scope is attached.
Fields
| Name | Description |
|---|---|
orphanedBoolean!
|
Always true when this marker is emitted. |
ParsedEpisodePayload
Section titled “ParsedEpisodePayload”Parsed episode numbering extracted from a release title.
Fields
| Name | Description |
|---|---|
seasonInt
|
Season number, or null when no season was parsed. |
episodeNumbers[Int!]!
|
Parsed episode numbers; empty means none were detected. |
ParsedReleasePayload
Section titled “ParsedReleasePayload”Parsed release title metadata and parser confidence.
Fields
| Name | Description |
|---|---|
rawTitleString!
|
Original release title before normalization. |
normalizedTitleString!
|
Normalized title used for matching. |
releaseGroupString
|
Release group, or null when not detected. |
qualityString
|
Quality label, or null when not detected. |
sourceString
|
Source label, or null when not detected. |
videoCodecString
|
Video codec, or null when not detected. |
videoEncodingString
|
Video encoding, or null when not detected. |
stereoscopyParsedStereoscopyPayload
|
Null means no reliable presentation claim, not verified 2D. |
audioString
|
Audio description, or null when not detected. |
isDualAudioBoolean!
|
Whether dual audio was detected. |
isAtmosBoolean!
|
Whether Atmos audio was detected. |
isDolbyVisionBoolean!
|
Whether Dolby Vision was detected. |
detectedHdrBoolean!
|
Whether HDR was detected. |
isProperUploadBoolean!
|
Whether the release is marked as a proper upload. |
isRemuxBoolean!
|
Whether the release is a remux. |
isBdDiskBoolean!
|
Whether the release is a Blu-ray disc image. |
isAiEnhancedBoolean!
|
Whether an AI-enhanced marker was detected. |
parseConfidenceFloat!
|
Parser confidence on the service's 0 through 1 scale. |
parseHints[String!]!
|
Parser hints retained for diagnostics. |
episodeParsedEpisodePayload
|
Parsed episode numbering, or null for non-episodic releases. |
ParsedStereoscopyPayload
Section titled “ParsedStereoscopyPayload”Stereoscopic claims in the release name, not verified stream properties.
Fields
| Name | Description |
|---|---|
presentationStereoPresentationValue!
|
Whether the release claims 2D, 3D, or a bundle containing both presentations. |
layoutStereoLayoutValue
|
Null when not stated, conflicting, or scoped to an unspecified bundle member. |
samplingStereoSamplingValue
|
Half/full sampling for side-by-side or top/bottom packing. |
encodingStereoEncodingValue
|
Optional stereoscopic encoding, independent of packing layout. |
PasskeySummaryPayload
Section titled “PasskeySummaryPayload”Non-secret summary of a registered passkey.
Fields
| Name | Description |
|---|---|
idID!
|
ID of the passkey. |
friendlyNameString
|
Optional user-assigned passkey name; null when none was saved. |
createdAtDateTime!
|
UTC time when the passkey was created. |
lastUsedAtDateTime
|
UTC time when the passkey was last used, or null when unused. |
PauseWantedItemPayload
Section titled “PauseWantedItemPayload”Identifier returned after pausing a wanted state row or convergence scope.
Fields
| Name | Description |
|---|---|
idID!
|
State-row ID or convergence scope key that was paused. |
PendingImportBindingFilePreviewPayload
Section titled “PendingImportBindingFilePreviewPayload”Parsed file details and suggested episode bindings for a pending import.
Fields
| Name | Description |
|---|---|
filePathString!
|
Full file path. |
fileNameString!
|
File name component. |
sizeBytesLong!
|
File size in bytes. |
parsedSeasonInt
|
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. |
PendingImportBindingPreviewPayload
Section titled “PendingImportBindingPreviewPayload”Preview of binding an unmatched imported file to a title and episode.
Fields
| Name | Description |
|---|---|
titleTitlePayload!
|
Title selected for the pending import. |
filePendingImportBindingFilePreviewPayload!
|
File identity and parsed metadata available for binding. |
availableEpisodes[EpisodePayload!]!
|
Episodes eligible for binding under the selected title. |
PendingImportConnectionPayload
Section titled “PendingImportConnectionPayload”Offset-paginated pending-import connection.
Fields
| Name | Description |
|---|---|
items[PendingImportItemPayload!]!
|
Items in the requested page; empty means no items matched. |
totalCountInt!
|
Total matching items before pagination. |
hasMoreBoolean!
|
Whether more matching items exist after this page. |
PendingImportCountsPayload
Section titled “PendingImportCountsPayload”Pending-import counts grouped by media facet.
Fields
| Name | Description |
|---|---|
movieInt!
|
Pending movie count. |
seriesInt!
|
Pending series count. |
animeInt!
|
Pending anime count. |
PendingImportItemPayload
Section titled “PendingImportItemPayload”One unmatched library item awaiting import resolution.
Fields
| Name | Description |
|---|---|
idID!
|
Pending-import item ID. |
libraryIdID!
|
Library ID containing the item. |
facetMediaFacetValue!
|
Media facet inferred for the item. |
statusPendingImportStatusValue!
|
Current pending-import status. |
titleIdID
|
Bound title ID, or null before resolution. |
titleNameString
|
Bound title name, or null before resolution. |
titleSlugString
|
Bound title slug, or null before resolution. |
titleFolderPathString
|
Folder currently owned by the bound title, or null before resolution. |
displayNameString!
|
Display name derived from the unmatched item. |
pathString!
|
Full source path. |
folderPathString
|
Containing folder path, or null when not applicable. |
queryString!
|
Metadata query suggested for resolution. |
yearHintInt
|
Parsed year hint, or null when unavailable. |
reasonString!
|
Explanation for the pending state. |
reasonClassPendingImportReasonClassValue!
|
Coarse bucket for |
searchAttempts[PendingImportSearchAttemptPayload!]!
|
Metadata search attempts made for this item. |
sizeBytesLong
|
Size of the pending file; null for folder items and unreadable files. |
createdAtDateTime!
|
When the scanner first recorded this item. |
PendingImportSearchAttemptPayload
Section titled “PendingImportSearchAttemptPayload”One metadata search attempt made while resolving a pending import.
Fields
| Name | Description |
|---|---|
queryString!
|
Search query submitted. |
resultCountInt!
|
Number of metadata results returned. |
topResults[String!]!
|
Top result titles retained for diagnostics. |
summaryString!
|
Human-readable attempt summary. |
PendingReleasePayload
Section titled “PendingReleasePayload”A release held for delayed acquisition evaluation.
Fields
| Name | Description |
|---|---|
idID!
|
Stable pending-release identifier. |
wantedItemIdID!
|
Identifier of the wanted scope awaiting this release. |
titleIdID!
|
Identifier of the title targeted by the pending release. |
releaseTitleString!
|
Release title held for later evaluation. |
releaseUrlString
|
Release URL, or null when the provider did not supply one. |
releaseSizeBytesLong
|
Release size in bytes, or null when unavailable. |
releaseScoreInt!
|
Score assigned to the pending release. |
scoringLogJsonJSON
|
Structured scoring explanation, or null when unavailable. |
indexerSourceString
|
Provider label, or null when unavailable. |
indexerIdID
|
Provider identifier, or null when the source is not linked. |
publishedAtDateTime
|
RFC3339 publication time reported by the indexer, or null when unavailable. |
seedersInt
|
Number of torrent seeders reported when this release was saved, or null when unknown. |
addedAtDateTime!
|
Time when the release entered the pending set, in UTC. |
delayUntilDateTime!
|
Time before which the release is held, in UTC. |
lastDecisionCodeString
|
Current machine-readable reason this release is held, or null when none was recorded. |
rolePendingReleaseRoleValue!
|
Arbitration role independent of the release lifecycle state. |
statusPendingReleaseStatusValue!
|
Lifecycle state of the pending release. |
titleTitlePayload
|
Title associated with this pending release, or null when it is no longer available to the caller. |
wantedItemWantedItemPayload
|
Wanted scope holding this release, or null when it is no longer available to the caller. |
PendingReleasesPayload
Section titled “PendingReleasesPayload”A page of pending releases with count and continuation metadata.
Fields
| Name | Description |
|---|---|
items[PendingReleasePayload!]!
|
Pending releases in stable order. |
hasMoreBoolean!
|
Whether another page exists after this page. |
totalCountInt!
|
Number of matching pending releases across all pages. |
PendingReleaseStatusCountPayload
Section titled “PendingReleaseStatusCountPayload”Count of pending releases grouped by lifecycle status.
Fields
| Name | Description |
|---|---|
statusPendingReleaseStatusValue!
|
Pending-release status. |
countInt!
|
Number of releases with this status. |
PlexServerDiscoveryPayload
Section titled “PlexServerDiscoveryPayload”A media server discovered through Plex.
Fields
| Name | Description |
|---|---|
idString!
|
Discovered server identity. |
nameString!
|
Discovered server name. |
PluginAutoUpdateSettingsPayload
Section titled “PluginAutoUpdateSettingsPayload”Automatic official-plugin patch update setting.
Fields
| Name | Description |
|---|---|
enabledBoolean!
|
Whether the scheduled plugin catalog refresh installs official patch updates automatically. |
PluginCatalogStatusPayload
Section titled “PluginCatalogStatusPayload”Plugin catalog refresh state, trust warnings, and blocked actions.
Fields
| Name | Description |
|---|---|
refreshStateCatalogRefreshStateValue!
|
Catalog refresh lifecycle state. |
githubAvailableBoolean!
|
Whether the remote catalog source is reachable. |
lastCheckedAtDateTime
|
UTC time of the last catalog check, or null when never checked. |
outageMessageString
|
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. |
lastErrorString
|
Last catalog error, or null when none is recorded. |
PluginConfigFieldOptionPayload
Section titled “PluginConfigFieldOptionPayload”One selectable value for a plugin configuration field.
Fields
| Name | Description |
|---|---|
valueString!
|
Machine-readable option value. |
labelString!
|
Display label for the option. |
configOverrides[PluginConfigFieldOverridePayload!]!
|
Other configuration fields populated when this option is selected. |
PluginConfigFieldOverridePayload
Section titled “PluginConfigFieldOverridePayload”One field value supplied by a selected plugin configuration preset.
Fields
| Name | Description |
|---|---|
keyString!
|
Configuration field key to populate. |
valueString!
|
Configuration field value to populate. |
PluginConfigFieldPayload
Section titled “PluginConfigFieldPayload”Provider configuration field schema.
Fields
| Name | Description |
|---|---|
keyString!
|
Stable field key. |
labelString!
|
Human-readable field label. |
fieldTypePluginConfigFieldTypeValue!
|
Value type that controls field validation and presentation. |
requiredBoolean!
|
Whether a value is required. |
defaultValueString
|
Default value, or null when none is defined. |
valueSourcePluginConfigValueSourceValue!
|
Source of the effective value. |
rolePluginConfigFieldRoleValue
|
Optional semantic role. |
hostBindingString
|
Host binding name, or null when not applicable. |
options[PluginConfigFieldOptionPayload!]!
|
Enumerated options, empty for non-select fields. |
helpTextString
|
Help text, or null when unavailable. |
visibleWhenPluginFieldConditionPayload
|
Condition gating visibility, or null when always shown. |
requiredWhenPluginFieldConditionPayload
|
Condition that makes the field required, or null when it never applies. |
advancedBoolean!
|
Whether the field belongs behind the form's advanced disclosure. |
PluginFieldConditionPayload
Section titled “PluginFieldConditionPayload”Predicate over another configuration field’s current value.
Fields
| Name | Description |
|---|---|
keyString!
|
Key of the field whose value is tested. |
opPluginConditionOpValue!
|
Comparison applied to that field's value. |
values[String!]!
|
Values compared against; empty for NON_EMPTY. |
PluginHttpTrustedCertificatePayload
Section titled “PluginHttpTrustedCertificatePayload”Trusted plugin HTTP certificate identified by SHA-256 fingerprint.
Fields
| Name | Description |
|---|---|
fingerprintSha256String!
|
Lower-level certificate SHA-256 fingerprint. |
pemString!
|
PEM-encoded certificate body. |
PluginInstallationPayload
Section titled “PluginInstallationPayload”Installed plugin identity, trust metadata, artifact digests, and timestamps.
Fields
| Name | Description |
|---|---|
idID!
|
Installation record ID. |
pluginIdID!
|
Registry plugin ID. |
nameString!
|
Installed plugin name. |
descriptionString!
|
Installed plugin description. |
versionString!
|
Installed plugin version. |
sdkVersionString!
|
Plugin SDK version. |
sdkConstraintString!
|
SDK compatibility constraint. |
pluginTypeString!
|
Manifest classification of the installed plugin. |
providerTypeString!
|
Provider type exposed by the plugin. |
isEnabledBoolean!
|
Whether the plugin is enabled. |
isBuiltinBoolean!
|
Whether the plugin is built in. |
sourceKindString!
|
Installation source kind. |
sourceUrlString
|
Installation source URL, or null when unavailable. |
publisherString
|
Publisher identity, or null when unavailable. |
supportTierString!
|
Trust or support tier. |
docsUrlString
|
Documentation URL, or null when unavailable. |
sourceRepoString
|
Source repository URL, or null when unavailable. |
manifestUrlString
|
Manifest URL, or null when unavailable. |
wasmDigestString
|
Verified WASM digest, or null when unavailable. |
artifactDigestString
|
Verified artifact digest, or null when unavailable. |
installedAtDateTime!
|
UTC installation time. |
updatedAtDateTime!
|
UTC last-update time. |
PluginInstallProgressPayload
Section titled “PluginInstallProgressPayload”Progress snapshot for a background plugin installation or upgrade.
Fields
| Name | Description |
|---|---|
pluginIdID!
|
Plugin ID being installed or upgraded. |
operationKindPluginInstallOperationKindValue!
|
Installation operation kind. |
statePluginInstallStateValue!
|
Current installation state. |
labelString!
|
Current progress label. |
stepIndexInt!
|
Current step number, from 1 through the total step count. |
stepCountInt!
|
Total step count. |
messageString
|
Progress message, or null when none is available. |
errorString
|
Error message, or null when the operation has not failed. |
PostProcessingScriptPayload
Section titled “PostProcessingScriptPayload”Configured post-processing script and execution policy.
Fields
| Name | Description |
|---|---|
idID!
|
Post-processing script ID. |
nameString!
|
Script display name. |
descriptionString!
|
Script description. |
scriptTypeString!
|
Script source type. |
scriptContentString!
|
Source text executed by the post-processing runtime. |
appliedFacets[String!]!
|
Media facets to which the script applies. |
executionModeExecutionModeValue!
|
Workflow phase in which the script runs. |
timeoutSecsInt!
|
Maximum runtime in seconds. |
priorityInt!
|
Relative execution priority. |
enabledBoolean!
|
Whether execution is enabled. |
debugBoolean!
|
Whether debug output is enabled. |
createdAtDateTime!
|
Creation time in UTC. |
updatedAtDateTime!
|
Last update time in UTC. |
PostProcessingScriptRunPayload
Section titled “PostProcessingScriptRunPayload”Result of one post-processing script execution.
Fields
| Name | Description |
|---|---|
idID!
|
Script run ID. |
scriptIdID!
|
ID of the configured script that produced this run. |
scriptNameString!
|
Script name at execution time. |
titleIdID
|
Associated title ID, or null when not title-specific. |
titleNameString
|
Associated title name, or null when not title-specific. |
facetMediaFacetValue
|
Media facet processed, or null when not facet-specific. |
filePathString
|
File path processed, or null when no file path applied. |
statusString!
|
Run status. |
exitCodeInt
|
Process exit code, or null when the process did not exit normally. |
stdoutTailString
|
Tail of standard output, when captured. |
stderrTailString
|
Tail of standard error, when captured. |
durationMsInt
|
Runtime in milliseconds. |
startedAtDateTime!
|
Start time in UTC. |
completedAtDateTime
|
Completion time in UTC, or null while the run is active. |
ProviderConfigValuePayload
Section titled “ProviderConfigValuePayload”Provider configuration field metadata and its masked stored value.
Fields
| Name | Description |
|---|---|
keyString!
|
Stable provider configuration key. |
labelString
|
Human-readable field label, or null when the provider supplies none. |
fieldTypePluginConfigFieldTypeValue
|
Configuration field type, or null when unspecified. |
requiredBoolean!
|
Whether a value is required by the provider. |
defaultValueString
|
Provider default value, or null when no default exists. |
valueSourcePluginConfigValueSourceValue
|
Source of the effective value, or null when no source is recorded. |
rolePluginConfigFieldRoleValue
|
Semantic role of the field, or null when unspecified. |
hostBindingString
|
Host binding required by the field, or null when not applicable. |
options[PluginConfigFieldOptionPayload!]!
|
Allowed field options; empty means the field has no enumerated options. |
helpTextString
|
Provider help text, or null when unavailable. |
valueProviderConfigFieldValue
|
The stored value as a typed union; null when the field is unset. |
ProviderTypePayload
Section titled “ProviderTypePayload”Provider type metadata and configuration schema.
Fields
| Name | Description |
|---|---|
providerTypeString!
|
Provider implementation identifier. |
nameString!
|
Provider display name. |
configFields[PluginConfigFieldPayload!]!
|
Configuration field schemas. |
defaultBaseUrlString
|
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. |
supportsTestBoolean!
|
Whether a connection test is supported. |
ProviderValidationPayload
Section titled “ProviderValidationPayload”Provider connection validation result.
Fields
| Name | Description |
|---|---|
statusString!
|
Machine-readable validation status. |
messageString
|
Diagnostic message, or null when unavailable. |
retryAfterSecondsInt
|
Retry delay in seconds, or null when no retry delay applies. |
ProxyConfigPayload
Section titled “ProxyConfigPayload”Proxy configuration and latest health state.
Fields
| Name | Description |
|---|---|
idID!
|
Proxy configuration ID. |
nameString!
|
Proxy configuration name. |
providerTypeString!
|
Proxy provider type. |
protocolString
|
Challenge-solver protocol, or null for transport proxies, which speak no protocol of their own. |
baseUrlString!
|
Proxy base URL. |
requestTimeoutSecondsInt!
|
Request timeout in seconds. |
hasCredentialsBoolean!
|
Whether a username or password is stored for this proxy, without exposing either value. Always false for challenge solvers, which take no credentials. |
remoteDnsBoolean!
|
Whether destination hostnames are resolved at the proxy ( |
hasPrivateKeyBoolean!
|
Whether a private key is stored for this tunnel, without exposing it. Always false outside the tunnel providers. |
peerPublicKeyString
|
WireGuard peer public key, from the |
hasPresharedKeyBoolean!
|
Whether a WireGuard preshared key is stored, without exposing it. Always false outside WireGuard. |
tunnelPublicKeyString
|
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 |
tunnelAddresses[String!]!
|
WireGuard interface addresses, from the |
tunnelDnsServers[String!]!
|
WireGuard resolvers reached through the tunnel, from the
|
tunnelMtuInt
|
WireGuard tunnel MTU, or null to use the engine's default. |
tunnelKeepaliveSecondsInt
|
WireGuard persistent keepalive in seconds, or null to use the engine's default. Zero means keepalive is switched off. |
hostKeyFingerprintString
|
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. |
hostKeyPinnedAtDateTime
|
UTC time the host key above was pinned, or null when none is pinned. |
isEnabledBoolean!
|
Whether the proxy is enabled. |
lastHealthStatusString
|
Most recent health status, or null before the first check. |
lastErrorMessageString
|
Most recent health error, or null when none is recorded. |
lastErrorAtDateTime
|
UTC time of the most recent health error, or null when none is recorded. |
createdAtDateTime!
|
UTC creation time. |
updatedAtDateTime!
|
UTC last-update time. |
ProxyTestResultPayload
Section titled “ProxyTestResultPayload”Result of testing a proxy connection.
Fields
| Name | Description |
|---|---|
okBoolean!
|
Whether the connection test succeeded. |
statusString!
|
Machine-readable test status. |
messageString
|
Optional diagnostic message. |
durationMsInt
|
Test duration in milliseconds, or null when unavailable. |
observedIpString
|
Public outbound IP reported by the destination, or null when unrecognized. |
httpStatusInt
|
Destination HTTP status, or null when no destination response was received. |
QualityProfileCriteriaPayload
Section titled “QualityProfileCriteriaPayload”Quality acceptance criteria and scoring controls.
Fields
| Name | Description |
|---|---|
qualityTiers[String!]!
|
Ordered quality tiers accepted by the profile. |
archivalQualityString
|
Archival quality label, or null when not configured. |
allowUnknownQualityBoolean!
|
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. |
dolbyVisionAllowedBoolean!
|
Whether Dolby Vision is accepted. |
detectedHdrAllowedBoolean!
|
Whether detected HDR is accepted. |
preferRemuxBoolean!
|
Whether remux releases are preferred. |
allowBdDiskBoolean!
|
Whether Blu-ray disc releases are accepted. |
allowUpgradesBoolean!
|
Whether quality upgrades are allowed. |
scoringOverridesScoringOverridesPayload!
|
Optional boolean scoring overrides. |
cutoffTierString
|
Cutoff quality tier, or null when no cutoff is configured. |
minScoreToGrabInt
|
Minimum score required to grab, or null when no threshold is configured
(Sonarr's |
cutoffScoreInt
|
Score past which a file is good enough and same-tier upgrades stop, or
null when upgrades never stop (Sonarr's |
QualityProfileDecisionPayload
Section titled “QualityProfileDecisionPayload”Quality-profile acceptance and score breakdown for a release.
Fields
| Name | Description |
|---|---|
allowedBoolean!
|
Whether the release passed the profile decision. |
blockCodes[String!]!
|
Blocking rule codes that prevented acceptance. |
releaseScoreInt!
|
Aggregate release score. |
preferenceScoreInt!
|
Aggregate preference score. |
scoringLog[ScoringEntryPayload!]!
|
Ordered scoring contributions used to compute the decision. |
QualityProfilePayload
Section titled “QualityProfilePayload”Named quality profile and its acceptance criteria.
Fields
| Name | Description |
|---|---|
idID!
|
Quality-profile ID. |
nameString!
|
Quality-profile name. |
criteriaQualityProfileCriteriaPayload!
|
Acceptance criteria and scoring controls. |
QualityProfileSelectionPayload
Section titled “QualityProfileSelectionPayload”Effective quality-profile selection for one content scope.
Fields
| Name | Description |
|---|---|
scopeContentScopeValue!
|
Content scope to which the selection applies. |
overrideProfileIdID
|
Scope-specific profile override ID, or null when inherited. |
effectiveProfileIdID!
|
Quality-profile ID selected after applying inheritance and overrides. |
inheritsGlobalBoolean!
|
Whether the effective profile comes from the global setting. |
QualityProfileSettingsPayload
Section titled “QualityProfileSettingsPayload”Quality profiles, global defaults, and per-content-scope selections.
Fields
| Name | Description |
|---|---|
profiles[QualityProfilePayload!]!
|
Available quality profiles. |
globalProfileIdID!
|
Global quality-profile ID. |
globalScoringPersonaScoringPersonaValue!
|
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. |
QueryRoot
Section titled “QueryRoot”Read-only GraphQL query root for authenticated HTTP requests.
Fields
| Name | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
titlesTitleCatalogPayload!
|
List a permission-filtered title catalog page with optional facet, filter, search, sort, and pagination controls. Arguments
|
||||||||||||||||||
titleCatalogFilterOptionsTitleCatalogFilterOptionsPayload!
|
Return available catalog filter values for the requested facet and library scope. Arguments
|
||||||||||||||||||
libraries[LibraryPayload!]!
|
List libraries visible to the caller that grant at least the requested permission. Arguments
|
||||||||||||||||||
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
|
||||||||||||||||||
myMediaRequests[MediaRequestPayload!]!
|
List only the caller's media requests, optionally filtered by facet, libraries, and status. Arguments
|
||||||||||||||||||
librarySettingsLibrarySettingsPayload!
|
Read settings for a library by ID, subject to the caller's library-settings permission. Arguments
|
||||||||||||||||||
titlesByExternalIds[TitlePayload!]!
|
Find visible titles by external IDs from a named metadata source. Arguments
|
||||||||||||||||||
titleTitlePayload
|
Fetch a visible title by ID, returning null when it does not exist or is not accessible. Arguments
|
||||||||||||||||||
movieEntityMovieEntityPayload
|
Fetch locally cached movie metadata through a visible title relationship. Arguments
|
||||||||||||||||||
episodeEpisodePayload
|
Fetch an episode by ID while verifying that it belongs to the supplied parent title. Arguments
|
||||||||||||||||||
episodeByIdEpisodePayload
|
Fetch an episode by globally unique ID without requiring a parent title ID. Arguments
|
||||||||||||||||||
collectionByIdCollectionPayload
|
Fetch a collection by globally unique ID, returning null when it is absent or inaccessible. Arguments
|
||||||||||||||||||
titleBySlugTitlePayload
|
Fetch a visible title by facet, optional library slug, and title slug. Arguments
|
||||||||||||||||||
mediaRenamePreviewMediaRenamePlanPayload!
|
Preview the rename plan for a title or an entire facet without changing files. Arguments
|
||||||||||||||||||
mediaRenamePreviewBulk[MediaRenamePlanPayload!]!
|
Preview rename plans for several titles of one facet without changing files. Arguments
|
||||||||||||||||||
changeTitleFolderPreviewChangeTitleFolderPreviewPayload!
|
Preview correcting which existing folder a title owns; no files are moved. Arguments
|
||||||||||||||||||
locationOperationPreviewLocationOperationPreviewPayload!
|
Preview moving selected titles to another library or root; nothing is moved. The returned fingerprint is what The mode picks which preview runs: the managed move plans the copy, and
Arguments
|
||||||||||||||||||
locationRootScopePreviewLocationRootScopePreviewPayload!
|
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 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 Arguments
|
||||||||||||||||||
locationTransferSummaryLocationTransferSnapshotPayload
|
Aggregate progress of one transfer with no title rows; poll this for the operation header. Arguments
|
||||||||||||||||||
locationTransferPageLocationTransferSnapshotPayload
|
One page of up to 50 title rows of a transfer, exceptions first. Arguments
|
||||||||||||||||||
locationTransferFilesLocationTransferSnapshotPayload
|
One page of up to 50 file rows for one title of a transfer. Arguments
|
||||||||||||||||||
locationTransferTitleDetailString
|
The operator-facing detail behind a title's exception, or null when it has none. Arguments
|
||||||||||||||||||
locationOperationLocationOperationPayload
|
Read one location operation with its per-title checkpoints. Arguments
|
||||||||||||||||||
locationOperationRetrySelectionLocationRetrySelectionPayload
|
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
|
||||||||||||||||||
locationOperationAssetsLocationOperationAssetListingPayload
|
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 Arguments
|
||||||||||||||||||
deleteTitlePreviewDeletePreviewPayload!
|
Preview deleting all media files for one title without changing files. Arguments
|
||||||||||||||||||
deleteTitlesPreviewDeleteTitlesPreviewPayload!
|
Preview deleting media files for the supplied title IDs without changing files. Arguments
|
||||||||||||||||||
deleteEpisodeFilesPreviewDeleteEpisodeFilesPreviewPayload!
|
Preview deleting the media files of the supplied episodes without changing files. Arguments
|
||||||||||||||||||
deleteMediaFilePreviewDeletePreviewPayload!
|
Preview deleting one media file without changing files. Arguments
|
||||||||||||||||||
deleteExternalSubtitlePreviewDeletePreviewPayload!
|
Preview deleting one external subtitle file without changing files. Arguments
|
||||||||||||||||||
wantedItemWantedItemPayload
|
Fetch one wanted item by ID, returning null when it is absent or inaccessible. Arguments
|
||||||||||||||||||
searchReleases[IndexerSearchResultPayload!]!
|
Search indexers for a title, series movie link, or episode and return at most 200 results. Arguments
|
||||||||||||||||||
interactiveReleaseSearchInteractiveReleaseSearchPayload
|
Poll an interactive release-search job; null means no visible snapshot exists. Arguments
|
||||||||||||||||||
titleHistoryTitleHistoryPagePayload!
|
List title history events with optional identity, event, grouping, and offset filters. Arguments
|
||||||||||||||||||
titleReleaseBlocklist[TitleReleaseBlocklistEntryPayload!]!
|
List blocklisted releases for one title; the limit defaults to 100 and values below 1 become 1. Arguments
|
||||||||||||||||||
dashboardActivityStatsDashboardActivityStatsPayload!
|
Return grab, upgrade, import, and failure counts for a trailing window and the window before it. Arguments
|
||||||||||||||||||
activityEvents[ActivityEventPayload!]!
|
List recent activity events with zero-based offset pagination. Arguments
|
||||||||||||||||||
auditLog[DomainEventEnvelopePayload!]!
|
List audit events visible to the caller, filtered by event type, title, facet, sequence, and limit. Arguments
|
||||||||||||||||||
activeLibraryScans[LibraryScanProgressPayload!]!
|
List active library scan sessions visible to the caller. |
||||||||||||||||||
libraryScanSessionLibraryScanProgressPayload
|
Recover an active or completed scan snapshot visible to the caller. Arguments
|
||||||||||||||||||
externalImportArrSourceWarmupStatusExternalImportMonitorWarmupProgressPayload!
|
Deprecated: use externalImportWarmupStatus Poll deprecated external movie or series source warmup status for one session. Arguments
|
||||||||||||||||||
externalImportWarmupStatusExternalImportMonitorWarmupProgressPayload!
|
Poll warmup status for one external movie, series, or indexer discovery session. Arguments
|
||||||||||||||||||
externalImportAggregateWarmupProgressExternalImportAggregateWarmupProgressPayload!
|
Aggregate Arr-source warmup progress; an empty list returns completed status with zero totals. Arguments
|
||||||||||||||||||
pendingImportCountsPendingImportCountsPayload!
|
Return pending-import counts visible to the caller. |
||||||||||||||||||
navigationBadgeCountsNavigationBadgeCountsPayload!
|
Return navigation counts while omitting categories the caller is not authorized to view. |
||||||||||||||||||
pendingImportsPendingImportConnectionPayload!
|
List pending imports by facet, library scope, status, and offset pagination. Arguments
|
||||||||||||||||||
pendingImportTitleSearch[MetadataSearchItemPayload!]!
|
Search metadata candidates for one pending import. Arguments
|
||||||||||||||||||
pendingImportBindingPreviewPendingImportBindingPreviewPayload!
|
Preview the title binding for one pending import without applying it. Arguments
|
||||||||||||||||||
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
|
||||||||||||||||||
recentJobRuns[JobRunPayload!]!
|
List recent job runs; the limit defaults to 50 and values below 1 become 1. Arguments
|
||||||||||||||||||
discoveryHomeDiscoveryHomePayload!
|
Return discovery home results using optional facet, filter, and pagination input. Arguments
|
||||||||||||||||||
discoveryHomeCardsDiscoveryHomeCardsPayload!
|
Return discovery home cards using optional facet, filter, and pagination input. Arguments
|
||||||||||||||||||
discoveryHomeFilterOptionsDiscoveryHomeFilterOptionsPayload!
|
Return discovery home filter options for an optional facet and library scope. Arguments
|
||||||||||||||||||
discoveryItemsDiscoveryItemsPayload!
|
List discovery items using optional filters, sorting, and pagination. Arguments
|
||||||||||||||||||
discoveryItemDetailDiscoveryItemPayload
|
Fetch one discovery item by identity and scope, returning null when unavailable. Arguments
|
||||||||||||||||||
catalogDiscoveryCatalogDiscoveryPayload!
|
Return catalog discovery results for the requested target and filters. Arguments
|
||||||||||||||||||
downloadQueuePageDownloadQueuePagePayload!
|
Return a bounded download queue page with readiness, revision, staleness, filters, and stable sorting metadata. Arguments
|
||||||||||||||||||
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
|
||||||||||||||||||
downloadImportDownloadImportPagePayload!
|
List a bounded page of download-import activity; the limit defaults to 50 and is clamped to 1 through 100. Arguments
|
||||||||||||||||||
downloadHistoryDownloadHistoryPagePayload!
|
List a bounded page of download history with optional client, activity, and sort filters. Arguments
|
||||||||||||||||||
subtitleSettingsSubtitleSettingsPayload!
|
Returns the current subtitle settings available to the authenticated actor. |
||||||||||||||||||
acquisitionSettingsAcquisitionSettingsPayload!
|
Returns acquisition thresholds and polling settings for the authenticated actor. |
||||||||||||||||||
generalSettingsGeneralSettingsPayload!
|
Returns system settings, effective image-cache limits, and trusted plugin certificates. |
||||||||||||||||||
recycleBinSettingsRecycleBinSettingsPayload!
|
Returns whether the recycle bin is enabled for the authenticated actor. |
||||||||||||||||||
verificationSettingsVerificationSettingsPayload!
|
Returns the verification depth applied to download-client completed-download copies. Location operations always verify in full and ignore it. |
||||||||||||||||||
pluginAutoUpdateSettingsPluginAutoUpdateSettingsPayload!
|
Returns whether the scheduled plugin catalog refresh installs official patch updates automatically. |
||||||||||||||||||
autoBackupSettingsAutoBackupSettingsPayload!
|
Returns auto-backup scheduling metadata without exposing the backup key. |
||||||||||||||||||
backupSettingsBackupSettingsPayload!
|
Returns configured, default, and effective backup paths. |
||||||||||||||||||
myUiSettingsUiSettingsPayload!
|
Returns the current UI settings for the authenticated actor. |
||||||||||||||||||
securitySettingsSecuritySettingsPayload!
|
Returns saved security settings together with effective and environment-overridden login state. |
||||||||||||||||||
oauthClientRegistrations[OauthClientRegistrationPayload!]!
|
Lists managed and administrator-created OAuth applications. |
||||||||||||||||||
oauthAuthorizationClientOauthAuthorizationClientPayload!
|
Resolves the display name for an OAuth authorization request after validating its callback URL. Arguments
|
||||||||||||||||||
externalAuthRuntimeSettingsExternalAuthRuntimeSettingsPayload!
|
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
|
||||||||||||||||||
jellyfinServerUsers[JellyfinServerUserPayload!]!
|
Lists users from the media-server connection identified by Arguments
|
||||||||||||||||||
mediaServerUsers[MediaServerUserGroupPayload!]!
|
Lists grouped media-server users, optionally filtered by search text. Arguments
|
||||||||||||||||||
authRuntimeStateAuthRuntimeStatePayload!
|
Returns effective authentication and MFA requirements after runtime overrides are applied. |
||||||||||||||||||
myPasskeys[PasskeySummaryPayload!]!
|
Lists the authenticated actor's passkey summaries without credential material. |
||||||||||||||||||
myTotpTotpStatusPayload!
|
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. |
||||||||||||||||||
canCreateMyApiKeysBoolean!
|
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. |
||||||||||||||||||
mediaSettingsMediaSettingsPayload!
|
Returns media settings for the requested content scope. Arguments
|
||||||||||||||||||
libraryPathsLibraryPathsPayload!
|
Returns the configured movie, series, and anime library paths. |
||||||||||||||||||
serviceSettingsServiceSettingsPayload!
|
Returns service TLS configuration and related settings. |
||||||||||||||||||
qualityProfileSettingsQualityProfileSettingsPayload!
|
Returns quality profiles and the current global and facet selections. |
||||||||||||||||||
downloadClientRouting[DownloadClientRoutingEntryPayload!]!
|
Returns download-client routing entries for a content scope. Arguments
|
||||||||||||||||||
indexerRouting[IndexerRoutingEntryPayload!]!
|
Returns indexer routing entries for a content scope. Arguments
|
||||||||||||||||||
indexers[IndexerConfigPayload!]!
|
Lists indexer configurations and current query statistics, optionally filtered by provider type. Arguments
|
||||||||||||||||||
seedingProfiles[SeedingProfilePayload!]!
|
Lists configured torrent seeding profiles. |
||||||||||||||||||
defaultSeedingProfileDefaultSeedingProfilePayload!
|
Returns the seeding profile applied when nothing more specific matches. |
||||||||||||||||||
indexerDownloadClientMappingCatalogIndexerDownloadClientMappingCatalogPayload!
|
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
|
||||||||||||||||||
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
|
||||||||||||||||||
users[UserPayload!]!
|
Lists users with authorization and authentication-factor status, excluding secret values. |
||||||||||||||||||
runtimeInfoRuntimeInfoPayload!
|
Return the path style supported by the running service. |
||||||||||||||||||
systemHealthSystemHealthPayload!
|
Return system health details visible to the authenticated caller. |
||||||||||||||||||
scryerVersionString!
|
Return the running Scryer version. |
||||||||||||||||||
instanceFeaturesInstanceFeaturesPayload!
|
Instance-wide feature switches readable by any signed-in user. |
||||||||||||||||||
smgVersionCompatibilityNoticeSmgVersionCompatibilityNoticePayload
|
Return an SMG compatibility notice when the connected SMG version requires attention. |
||||||||||||||||||
smgScryerUpdateNoticeSmgScryerUpdateNoticePayload
|
Return an available Scryer update notice from SMG, if one exists. |
||||||||||||||||||
applicationUpgradeStatusApplicationUpgradeStatusPayload!
|
Return application update availability and installation eligibility; requires system-settings management permission. |
||||||||||||||||||
recycledItemsRecycledItemsPayload!
|
List recycled media items in a bounded page, optionally restricted to library IDs. Arguments
|
||||||||||||||||||
previewRestoreRecycledItemsRecycleRestorePreviewPayload!
|
Preview restoring recycled items by ID without changing their files. Arguments
|
||||||||||||||||||
backups[BackupInfoPayload!]!
|
List available backups; requires system-settings management permission. |
||||||||||||||||||
pendingReleasesPendingReleasesPayload!
|
List a bounded page of pending releases with optional title, wanted-item, and status filters. Arguments
|
||||||||||||||||||
importHistory[ImportRecordPayload!]!
|
List recent import records; the limit defaults to 50 and is capped at 500. Arguments
|
||||||||||||||||||
meUserPayload
|
Return the authenticated user payload, or null for an anonymous session; restricted enrollment and password-replacement sessions are rejected. |
||||||||||||||||||
wantedItemsWantedItemsListPayload!
|
Return Missing or Cutoff Upgrade targets with activity state and per-scope convergence progress. Arguments
|
||||||||||||||||||
cutoffUnmetTitlesPageCutoffUnmetTitlesPagePayload!
|
Return one page of cutoff-unmet targets with the full match count and per-item convergence progress. Arguments
|
||||||||||||||||||
titleAcquisitionDiagnosticsTitleAcquisitionDiagnosticsPayload!
|
Return acquisition diagnostics for one title ID. Arguments
|
||||||||||||||||||
acquisitionSearchJobAcquisitionSearchJobPayload
|
Return progress for an interactive acquisition-search job, or null when no such job exists. Arguments
|
||||||||||||||||||
ruleSets[RuleSetPayload!]!
|
List rule sets visible to the caller. |
||||||||||||||||||
ruleSetRuleSetPayload
|
Return one rule set, including its source, when it is visible to the caller. Arguments
|
||||||||||||||||||
maintenanceRuleSets[MaintenanceRuleSet!]!
|
List maintenance rule sets; requires catalog-settings management permission. |
||||||||||||||||||
maintenanceRuleSetMaintenanceRuleSetDetail
|
Return one maintenance rule set with the revision currently in force, or null when no such rule set exists. Arguments
|
||||||||||||||||||
maintenanceRuleRevisions[MaintenanceRuleRevision!]!
|
List every stored revision of one maintenance rule set, newest first. Arguments
|
||||||||||||||||||
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
Arguments
|
||||||||||||||||||
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
|
||||||||||||||||||
maintenanceInstanceGatesMaintenanceInstanceGates!
|
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
|
||||||||||||||||||
maintenanceActionRuns[MaintenanceActionRun!]!
|
List recorded maintenance action-handler attempts, newest first. Arguments
|
||||||||||||||||||
requestRuleSets[RequestRuleSet!]!
|
List request rule sets; requires catalog-settings management permission. |
||||||||||||||||||
requestRuleSetRequestRuleSetDetail
|
Return one request rule set with the revision currently in force, or null when no such rule set exists. Arguments
|
||||||||||||||||||
requestRuleRevisions[RequestRuleRevision!]!
|
List every stored revision of one request rule set, newest first. Arguments
|
||||||||||||||||||
requestRuleInstanceGatesRequestRuleInstanceGates!
|
Read the instance-wide request-rule gate; requires system-settings management permission. |
||||||||||||||||||
requestRuleDecisionRequestRuleDecision
|
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 Arguments
|
||||||||||||||||||
requestRuleDecisions[RequestRuleDecision!]!
|
List recorded request decisions, newest first; requires catalog-settings management permission. Arguments
|
||||||||||||||||||
requestRuleInputReferenceJSON!
|
The request family's Rules Context Reference: every fact a request matcher may read. |
||||||||||||||||||
previewMyRequestDecisionRequestPreflightPayload!
|
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
|
||||||||||||||||||
titleClaims[TitleClaim!]!
|
List every lifecycle claim on one title, live and historical; requires title management on the title's library. Arguments
|
||||||||||||||||||
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
|
||||||||||||||||||
plugins[RegistryPluginPayload!]!
|
List available registry plugins visible to the caller. |
||||||||||||||||||
pluginCatalogStatusPluginCatalogStatusPayload!
|
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
|
||||||||||||||||||
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. |
||||||||||||||||||
externalImportSetupSecretDraftExternalImportSetupSecretDraftPayload
|
Read the caller-visible external import setup secret draft; requires system-settings management permission. |
||||||||||||||||||
externalImportSetupSecretDraftStatusExternalImportSetupSecretDraftStatusPayload!
|
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
|
||||||||||||||||||
searchMetadataMultiMetadataSearchMultiPayload!
|
Search provider metadata across movie, series, and anime facets. Arguments
|
||||||||||||||||||
metadataMovieMetadataMoviePayload!
|
Fetch one movie metadata record by a supplied identity and language. Arguments
|
||||||||||||||||||
metadataSeriesMetadataSeriesPayload!
|
Fetch one series metadata record, optionally including its episode list. Arguments
|
||||||||||||||||||
calendarEpisodes[CalendarEpisodePayload!]!
|
List calendar episodes between two dates, optionally restricted to libraries. Arguments
|
||||||||||||||||||
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. |
||||||||||||||||||
setupStatusSetupStatusPayload!
|
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
|
||||||||||||||||||
serviceLogsServiceLogsPayload!
|
Return the most recent buffered service log lines; requires system-settings permission. Arguments
|
||||||||||||||||||
externalSubtitles[ExternalSubtitlePayload!]!
|
List external subtitles associated with a title ID. Arguments
|
||||||||||||||||||
externalSubtitleBlocklistEntries[ExternalSubtitleBlocklistEntryPayload!]!
|
List external subtitle blocklist entries for one media file ID. Arguments
|
||||||||||||||||||
linkedAccounts[LinkedAccountPayload!]!
|
List linked external accounts visible to the caller, optionally restricted to a user ID. Arguments
|
||||||||||||||||||
externalAccountInvites[LinkedAccountPayload!]!
|
List external account invitations visible to the caller. |
||||||||||||||||||
indexerErrorsIndexerErrorConnectionPayload!
|
List persisted indexer HTTP errors; requires system-settings management permission. Arguments
|
||||||||||||||||||
indexerErrorIndexerErrorDetailPayload
|
Return one complete persisted indexer HTTP response; requires system-settings management permission. Arguments
|
QueueDownloadConflictPayload
Section titled “QueueDownloadConflictPayload”Existing download work that prevented a new submission.
Fields
| Name | Description |
|---|---|
titleIdID!
|
Title identity involved in the conflict. |
titleNameString!
|
Current title name. |
downloadClientIdID
|
Download-client identity, null when the conflict is not tied to a configured client. |
downloadClientTypeString!
|
Download-client provider type. |
downloadClientItemIdString!
|
Provider-specific download item identity. |
sourceTitleString
|
Release title already associated with the conflict, when known. |
sourceKindDownloadSourceKindValue
|
Release source category, when known. |
scopeQueueDownloadScopePayload!
|
Acquisition scope occupied by the conflicting work. |
stateDownloadQueueStateValue
|
Current queue state, when available. |
replaceableBoolean!
|
Whether the conflicting work may be replaced. |
QueueDownloadPayload
Section titled “QueueDownloadPayload”Result of a release queue request.
Fields
| Name | Description |
|---|---|
statusQueueDownloadResultStatusValue!
|
Whether the request was queued or conflicted. |
jobIdID
|
Background job identity when the request was queued. |
titleIdID!
|
Title identity receiving the request. |
titleNameString!
|
Current title name. |
sourceTitleString
|
Queued release title, null when the request conflicted. |
sourceKindDownloadSourceKindValue
|
Queued release source category, null when unavailable or conflicted. |
conflictQueueDownloadConflictPayload
|
Conflict details when the request was not queued. |
QueueUnlinkedReleasePayload
Section titled “QueueUnlinkedReleasePayload”Outcome of grabbing a release with no catalog title behind it.
Fields
| Name | Description |
|---|---|
downloadIdString!
|
Download client's own item identity for the submitted download. |
clientNameString!
|
Name of the download client that accepted the release. |
sourceTitleString!
|
Release name as the indexer announced it. |
RecycleBinSettingsPayload
Section titled “RecycleBinSettingsPayload”Recycle-bin enablement setting.
Fields
| Name | Description |
|---|---|
enabledBoolean!
|
Whether deleted media is moved to the recycle bin. |
RecycledItemPayload
Section titled “RecycledItemPayload”File moved to the recycle bin with its original library context.
Fields
| Name | Description |
|---|---|
idID!
|
Recycle-bin entry ID. |
originalPathString!
|
Original absolute or library-relative file path. |
fileNameString!
|
Original file name. |
sizeBytesLong!
|
File size in bytes. |
titleIdID
|
Associated title ID, or null when no title was matched. |
titleNameString
|
Associated title name, or null when no title was matched. |
reasonString!
|
Reason the file entered the recycle bin. |
recycledAtDateTime!
|
Time the file entered the recycle bin in UTC. |
scheduledDeletionAtDateTime!
|
Time the retention policy schedules this file for permanent deletion in UTC. |
mediaRootString!
|
Media root containing the original file. |
libraryIdID!
|
Library ID containing the original file. |
libraryNameString!
|
Library name containing the original file. |
RecycledItemsPayload
Section titled “RecycledItemsPayload”A page of recycle-bin entries and its total matching count.
Fields
| Name | Description |
|---|---|
items[RecycledItemPayload!]!
|
Recycle-bin entries in the requested page. |
totalCountInt!
|
Total matching entries across all pages. |
RecycleRestorePreviewItemPayload
Section titled “RecycleRestorePreviewItemPayload”One destination collision found during restore preview.
Fields
| Name | Description |
|---|---|
idID!
|
Recycle-bin entry ID. |
originalPathString!
|
Original path that would be restored. |
destinationOccupiedBoolean!
|
Whether the destination is currently occupied. |
RecycleRestorePreviewPayload
Section titled “RecycleRestorePreviewPayload”Restore preview fingerprint and destination collision details.
Fields
| Name | Description |
|---|---|
fingerprintString!
|
Fingerprint required to confirm the current preview. |
items[RecycleRestorePreviewItemPayload!]!
|
Preview entries for the selected recycle-bin records. |
RegistryPluginPayload
Section titled “RegistryPluginPayload”Plugin registry entry with trust, installation, update, and progress state.
Fields
| Name | Description |
|---|---|
idID!
|
Registry plugin ID. |
nameString!
|
Plugin name. |
descriptionString!
|
Plugin description. |
versionString!
|
Registry version. |
latestVersionString
|
Latest known version, or null when unavailable. |
pluginTypeString!
|
Registry classification of the plugin. |
providerTypeString!
|
Provider type exposed by the plugin. |
authorString!
|
Publisher or author name. |
officialBoolean!
|
Whether the plugin is official. |
publisherString
|
Publisher identity, or null when unavailable. |
supportTierString!
|
Trust or support tier. |
statusString
|
Current registry or installation status, or null when unavailable. |
docsUrlString
|
Documentation URL, or null when unavailable. |
sourceRepoString
|
Source repository URL, or null when unavailable. |
builtinBoolean!
|
Whether the plugin is built into the service. |
sourceUrlString
|
Download source URL, or null when unavailable. |
sourceKindString
|
Source kind, or null when unavailable. |
blockedReasonString
|
Trust-block reason, or null when not blocked. |
bytesLong
|
Artifact size in bytes, or null when unavailable. |
isInstalledBoolean!
|
Whether the plugin is installed. |
isEnabledBoolean!
|
Whether the installed plugin is enabled. |
installedVersionString
|
Installed version, or null when not installed. |
updateAvailableBoolean!
|
Whether a newer version is available. |
installInProgressBoolean!
|
Whether install or update work is currently running. |
defaultBaseUrlString
|
Default provider base URL, or null when not applicable. |
RehydrateAllMetadataPayload
Section titled “RehydrateAllMetadataPayload”Result of clearing metadata before background rehydration.
Fields
| Name | Description |
|---|---|
languageString!
|
Language whose metadata was cleared. |
titlesClearedInt!
|
Number of titles cleared. |
ReleaseDecisionPayload
Section titled “ReleaseDecisionPayload”A scored release decision associated with a wanted scope.
Fields
| Name | Description |
|---|---|
idID!
|
Stable release-decision identifier. |
wantedItemIdID!
|
Identifier of the wanted scope evaluated by the decision. |
titleIdID!
|
Identifier of the title targeted by the decision. |
releaseTitleString!
|
Release title evaluated by the matcher. |
releaseUrlString
|
Release URL, or null when the provider did not supply one. |
releaseSizeBytesLong
|
Release size in bytes, or null when unavailable. |
decisionCodeString!
|
Machine-readable decision code. |
candidateScoreInt!
|
Candidate score assigned by the scoring rules. |
currentScoreInt
|
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 |
scoreDeltaInt
|
Candidate minus current score, or null when no current score exists. |
explanationJsonJSON
|
Structured scoring explanation, or null when no explanation was stored. |
createdAtDateTime!
|
Time when the decision was recorded, in UTC. |
titleTitlePayload
|
Title associated with this release decision, or null when it is no longer available to the caller. |
wantedItemWantedItemPayload
|
Wanted scope evaluated by this decision, or null when it is no longer available to the caller. |
ReleaseDecisionsPagePayload
Section titled “ReleaseDecisionsPagePayload”A page of release decisions with a total count.
Fields
| Name | Description |
|---|---|
items[ReleaseDecisionPayload!]!
|
Decisions in stable order. |
totalCountInt!
|
Number of matching decisions across all pages. |
hasMoreBoolean!
|
Whether another page exists after this page. |
RenameTitlesPayload
Section titled “RenameTitlesPayload”Accepted rename work and the job run tracking it.
Fields
| Name | Description |
|---|---|
jobRunJobRunPayload!
|
Background job run tracking the rename work. |
acceptedTitleIds[ID!]!
|
Title IDs accepted for processing. |
ReorderDownloadClientConfigsPayload
Section titled “ReorderDownloadClientConfigsPayload”Persisted download-client configuration order.
Fields
| Name | Description |
|---|---|
ids[ID!]!
|
Download-client identities in stored order. |
RequestPreflightPayload
Section titled “RequestPreflightPayload”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
| Name | Description |
|---|---|
outcomeRequestDecisionOutcomeValue!
|
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. |
metadataPartialBoolean!
|
True when the metadata could not be fully established, so the verdict rests on incomplete facts. An unevaluable policy never approves. |
evaluationModeRequestRuleEvaluationModeValue!
|
Strictest mode among the rules that were consulted. |
fallbackReasonString
|
Why the verdict fell back to needing approval, when it did. One of the
arbitration vocabulary's codes ( |
RequestPreflightReason
Section titled “RequestPreflightReason”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
| Name | Description |
|---|---|
codeString!
|
Stable reason code the rule emitted. |
ruleNameString!
|
Name of the rule that emitted it. |
RequestRuleDecision
Section titled “RequestRuleDecision”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
| Name | Description |
|---|---|
idID
|
Trace ID, or null for a preview, which persists nothing. |
requestIdID
|
The media request this decision belongs to, or null for a preview. |
evaluatedAtDateTime!
|
UTC time the evaluation ran. |
modeRequestRuleEvaluationModeValue!
|
Strictest mode among the rules that were consulted. |
effectiveOutcomeRequestDecisionOutcomeValue!
|
What actually happened to the request. |
policyOutcomeRequestDecisionOutcomeValue!
|
What the rules concluded, whether or not they were allowed to act. |
fallbackReasonString
|
Why the decision fell back rather than following a rule vote
( |
votes[RequestRuleVote!]!
|
Per-rule votes. Empty for a requester reading their own request's
decision, who sees |
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. |
inputSchemaVersionInt!
|
Schema version of the input document the rules were evaluated against. |
RequestRuleInstanceGates
Section titled “RequestRuleInstanceGates”The instance-wide request-rule gate. One switch, defaulting off: a request rule votes and executes nothing, so there is one blast radius.
Fields
| Name | Description |
|---|---|
evaluationEnabledBoolean!
|
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. |
RequestRulePreviewPayload
Section titled “RequestRulePreviewPayload”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
| Name | Description |
|---|---|
ruleSetIdString!
|
Stored rule set the preview ran, or the throwaway ID an unsaved draft compiled under. |
matcherContentHashString!
|
Hash of the exact source that produced this outcome. |
decisionRequestRuleDecision!
|
The single rule's verdict, shaped as a decision so the authoring UI and
the decision browser render the same component. |
metadataPartialBoolean!
|
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. |
inputDocumentJSON!
|
The exact document the rule saw. |
RequestRuleRevision
Section titled “RequestRuleRevision”One immutable revision of a request rule set’s matcher.
Fields
| Name | Description |
|---|---|
idID!
|
Revision ID. |
ruleSetIdID!
|
ID of the rule set this revision belongs to. |
revisionNumberInt!
|
Revision number, starting at one and incremented on every matcher edit. |
regoSourceString!
|
Rego source as the editor should show it, with the package declaration and the rego.v1 import stripped. |
matcherContentHashString!
|
Hash of the exact stored source, used to attribute a decision to the revision that produced it. |
createdByID
|
ID of the user who wrote the revision, or null when unattributed. |
createdAtDateTime!
|
UTC creation time. |
RequestRuleSet
Section titled “RequestRuleSet”A request rule set: identity, scope, and evaluation state. The matcher lives on the revision, never here.
Fields
| Name | Description |
|---|---|
idID!
|
Rule-set ID. |
nameString!
|
Rule-set name. |
descriptionString!
|
Rule-set description; empty when the author supplied none. |
enabledBoolean!
|
Whether the rule set is enabled. Derived from |
evaluationModeRequestRuleEvaluationModeValue!
|
Evaluation mode currently stored for the rule set. |
libraryIds[String!]!
|
Libraries the rule is confined to. Empty means every library. |
currentRevisionNumberInt!
|
Revision number of the matcher currently in force. |
decisionCountInt!
|
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. |
createdAtDateTime!
|
UTC creation time. |
updatedAtDateTime!
|
UTC last-update time. |
RequestRuleSetDetail
Section titled “RequestRuleSetDetail”A rule set together with the revision currently in force.
Fields
| Name | Description |
|---|---|
ruleSetRequestRuleSet!
|
The rule set itself. |
revisionRequestRuleRevision!
|
The revision currently in force. |
RequestRuleValidationPayload
Section titled “RequestRuleValidationPayload”Result of validating request rule source without saving it.
Fields
| Name | Description |
|---|---|
validBoolean!
|
Whether the source is valid. |
errors[String!]!
|
Validation errors; empty when valid. |
RequestRuleVote
Section titled “RequestRuleVote”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
| Name | Description |
|---|---|
ruleSetIdID!
|
Rule set that voted. |
ruleSetNameString!
|
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. |
revisionNumberInt!
|
Revision that voted. |
voteRequestVoteValue
|
The vote, or null when the rule failed. |
heldBoolean!
|
True when Scryer held the rule because a fact it reads was unobservable,
rather than the author writing |
reasonCodes[String!]!
|
Reason codes the rule emitted. |
tags[String!]!
|
Tags the rule emitted. |
errorString
|
Why the rule failed, or null when it did not. |
ResolvePendingImportPayload
Section titled “ResolvePendingImportPayload”Result of resolving a pending import to a title.
Fields
| Name | Description |
|---|---|
titleTitlePayload!
|
Title created or reused for the pending import. |
createdBoolean!
|
Whether the operation created a new title. |
libraryScanLibraryScanSummaryPayload
|
Library scan summary, or null when no scan was accepted or run. |
metadataHydrationStateAddTitleHydrationStateValue!
|
Metadata processing outcome for the resolved title. |
RestoreApplyPayload
Section titled “RestoreApplyPayload”Reports the backup contents staged for restoration on restart.
Fields
| Name | Description |
|---|---|
summaryRestoreSummaryPayload!
|
Backup contents and source metadata accepted for restoration. |
RestoreInspectPayload
Section titled “RestoreInspectPayload”Identifies a staged restore upload and its inspected contents.
Fields
| Name | Description |
|---|---|
uploadIdID!
|
Temporary restore upload ID used by the apply operation. |
summaryRestoreSummaryPayload!
|
Inspected backup contents and source metadata. |
RestoreRecycledItemPayload
Section titled “RestoreRecycledItemPayload”Accepted request to restore one recycle-bin entry.
Fields
| Name | Description |
|---|---|
idID!
|
Recycle-bin entry ID. |
jobRunJobRunPayload!
|
Background job accepted for the restore operation. |
RestoreRecycledItemsPayload
Section titled “RestoreRecycledItemsPayload”Accepted background restore for multiple recycle-bin entries.
Fields
| Name | Description |
|---|---|
ids[ID!]!
|
Recycle-bin entry IDs accepted for restore. |
jobRunJobRunPayload!
|
Background job accepted for the restore operation. |
RestoreSummaryPayload
Section titled “RestoreSummaryPayload”Summarizes the contents and source compatibility metadata of a backup bundle.
Fields
| Name | Description |
|---|---|
formatVersionString!
|
Backup bundle format version. |
createdAtDateTime!
|
UTC timestamp when the backup bundle was created. |
sourceScryerVersionString!
|
Scryer version that created the backup. |
sourceEngineString!
|
Datastore engine used by the source instance. |
sourceMigrationKeyString
|
Source database migration key; null when the bundle does not provide one. |
encryptedBoolean!
|
Whether the backup contents are encrypted. |
rowCounts[BackupRowCountPayload!]!
|
Row counts grouped by backed-up entity. |
totalRowsLong!
|
Total rows contained in the backup. |
ResumeLocationOperationPayload
Section titled “ResumeLocationOperationPayload”Result of asking an interrupted operation to pick up from its checkpoints.
Fields
| Name | Description |
|---|---|
idID!
|
Operation the resume or retry was requested for. |
resumedBoolean!
|
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. |
detailString
|
Why it was not picked back up, when it was not. |
ResumeWantedItemPayload
Section titled “ResumeWantedItemPayload”Identifier returned after resuming a wanted state row or convergence scope.
Fields
| Name | Description |
|---|---|
idID!
|
State-row ID or convergence scope key that was resumed. |
RevokeMyApiKeyPayload
Section titled “RevokeMyApiKeyPayload”Revocation result for a user-owned API key.
Fields
| Name | Description |
|---|---|
idID!
|
ID of the revoked key. |
revokedBoolean!
|
Whether the active key was revoked. |
RevokeMyOauthAppPayload
Section titled “RevokeMyOauthAppPayload”Result of revoking an OAuth grant.
Fields
| Name | Description |
|---|---|
grantIdID!
|
Grant ID targeted by the revoke request. |
revokedBoolean!
|
False when the grant was already revoked or was not owned by the caller. |
RootFolderPayload
Section titled “RootFolderPayload”Root-folder path and default marker.
Fields
| Name | Description |
|---|---|
pathString!
|
Filesystem path. |
isDefaultBoolean!
|
Whether this is the default root folder. |
RssSyncReportPayload
Section titled “RssSyncReportPayload”Counts produced by one RSS synchronization pass.
Fields
| Name | Description |
|---|---|
releasesFetchedInt!
|
Number of releases fetched from feeds. |
releasesMatchedInt!
|
Number of fetched releases matched to known titles. |
releasesGrabbedInt!
|
Number of matched releases accepted for grabbing. |
releasesHeldInt!
|
Number of matched releases held instead of grabbed. |
RulePackRegistryEntryPayload
Section titled “RulePackRegistryEntryPayload”Rule-pack registry entry.
Fields
| Name | Description |
|---|---|
idString!
|
Registry rule-pack ID. |
nameString!
|
Rule-pack name. |
descriptionString!
|
Rule-pack description. |
authorString!
|
Rule-pack author. |
versionString!
|
Rule-pack version. |
customizableBoolean!
|
Whether rules from the pack may be copied into user-authored rules. |
RulePackTemplatePayload
Section titled “RulePackTemplatePayload”Template supplied by a rule pack.
Fields
| Name | Description |
|---|---|
idString!
|
Template ID. |
titleString!
|
Template title. |
descriptionString!
|
Template description. |
categoryString!
|
Template category. |
regoSourceString!
|
Rego source for the template. |
appliedFacets[String!]!
|
Facets to which the template applies. |
defaultEnabledBoolean!
|
Whether the pack recommends enabling the template. |
RuleSetPayload
Section titled “RuleSetPayload”Rego rule set configuration and managed-pack metadata.
Fields
| Name | Description |
|---|---|
idID!
|
Rule-set ID. |
nameString!
|
Rule-set name. |
descriptionString!
|
Rule-set description. |
regoSourceString!
|
Rego source used for validation and evaluation. |
enabledBoolean!
|
Whether the rule set is enabled. |
priorityInt!
|
Evaluation priority. |
evaluationPhaseString!
|
Baseline rules establish the subtotal read by additional rules. |
disabledReasonString
|
Why a retained rule was disabled during a context migration. |
exclusiveGroupString
|
Other rules with this group cannot be enabled simultaneously. |
appliedFacets[String!]!
|
Media facets to which the rule set applies. |
isManagedBoolean!
|
Whether the rule set is managed by a trusted pack. |
managedKeyString
|
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. |
createdAtDateTime!
|
UTC creation time. |
updatedAtDateTime!
|
UTC last-update time. |
RuleSetTestContextPayload
Section titled “RuleSetTestContextPayload”Title and library facts resolved for a rule-set scoring preview.
Fields
| Name | Description |
|---|---|
titleNameString!
|
Resolved title name. |
libraryNameString
|
Resolved library name, or null when unavailable. |
facetString!
|
Resolved media facet. |
languageString
|
Resolved original language, or null when unavailable. |
tags[String!]!
|
Resolved title tags. |
episodeLabelString
|
Resolved episode label, or null for whole-title previews. |
RuleSetTestDraftContributionPayload
Section titled “RuleSetTestDraftContributionPayload”Current editor draft’s contribution to a scoring preview.
Fields
| Name | Description |
|---|---|
scoreInt!
|
Signed score contribution from the draft. |
matchedBoolean!
|
Whether the draft matched the candidate facts. |
blockedBoolean!
|
Compatibility field, always false: drafts emit recoverable numeric contributions. |
appliesBoolean!
|
Whether the draft applies to the selected title facet. |
enabledBoolean!
|
Whether the draft is enabled. |
messageString
|
Explanation for a disabled or non-applicable draft, or null when none. |
RuleSetTestEntryPayload
Section titled “RuleSetTestEntryPayload”One numeric contribution or explicit rejection in a scoring preview.
Fields
| Name | Description |
|---|---|
codeString!
|
Stable explanation code; the code does not determine rejection type. |
deltaInt!
|
Signed score delta associated with the entry. |
blockedBoolean!
|
Whether this is an explicit rejection, as identified by kind. |
kindString!
|
score_contribution, mandatory_rejection, or final_score_rejection. |
RuleSetTestErrorPayload
Section titled “RuleSetTestErrorPayload”A validation or evaluation error retained by a scoring preview.
Fields
| Name | Description |
|---|---|
codeString!
|
Stable error classification. |
messageString!
|
Human-readable error detail. |
ruleSetIdString
|
Rule-set identity associated with the error, or null when global. |
RuleSetTestParsedPayload
Section titled “RuleSetTestParsedPayload”Release facts parsed for a rule-set scoring preview.
Fields
| Name | Description |
|---|---|
releaseGroupString
|
Parsed release group, or null when unknown. |
qualityString
|
Parsed quality, or null when unknown. |
sourceString
|
Parsed release source, or null when unknown. |
seasonString
|
Season parsed from the release name, or null when absent. |
episodeString
|
Episode parsed from the release name, or null when absent. |
editionString
|
Parsed edition, or null when unknown. |
videoCodecString
|
Parsed video codec, or null when unknown. |
audioString
|
Parsed audio codec, or null when unknown. |
yearInt
|
Parsed release year, or null when unknown. |
audioLanguages[String!]!
|
Parsed audio-language codes. |
sizeBytesLong
|
Release size in bytes, or null when the caller omitted it. |
RuleSetTestRuleSetPayload
Section titled “RuleSetTestRuleSetPayload”One rule-set’s contribution to a title-aware scoring preview.
Fields
| Name | Description |
|---|---|
ruleSetIdString
|
Stable rule-set identity. |
ruleSetNameString!
|
Rule-set display name. |
originString!
|
Existing policy origin. |
scoreInt!
|
Signed score contribution. |
matchedBoolean!
|
Whether this rule set matched the candidate facts. |
blockedBoolean!
|
Whether this group contains an explicit rejection. Numeric penalties are recoverable. |
isDraftBoolean!
|
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. |
RuleValidationResultPayload
Section titled “RuleValidationResultPayload”Result of validating Rego source.
Fields
| Name | Description |
|---|---|
validBoolean!
|
Whether the source is valid. |
errors[String!]!
|
Validation errors; empty when valid. |
RuntimeInfoPayload
Section titled “RuntimeInfoPayload”Runtime path information used by clients interpreting filesystem values.
Fields
| Name | Description |
|---|---|
runtimePathStyleRuntimePathStyleValue!
|
Path syntax used by the running service. |
SaveExternalImportSetupSecretDraftPayload
Section titled “SaveExternalImportSetupSecretDraftPayload”Result of saving an external import secret draft.
Fields
| Name | Description |
|---|---|
overwroteAnotherUserDraftBoolean!
|
Whether another user's existing draft was replaced. |
updatedAtDateTime!
|
Save time in UTC. |
ScoringEntryPayload
Section titled “ScoringEntryPayload”One scoring rule contribution used in a quality decision.
Fields
| Name | Description |
|---|---|
codeString!
|
Stable scoring rule code. |
deltaInt!
|
Signed score delta contributed by the rule. |
kindString!
|
score_contribution, mandatory_rejection, or final_score_rejection. |
sourceString!
|
Source of the scoring rule. |
ruleSetNameString
|
Rule-set name, or null when not associated with a named set. |
ScoringOverridesPayload
Section titled “ScoringOverridesPayload”Optional boolean scoring overrides for quality evaluation.
Fields
| Name | Description |
|---|---|
allowX265Non4KBoolean
|
Whether non-4K x265 releases are allowed. |
blockDvWithoutFallbackBoolean
|
Whether Dolby Vision without a fallback is blocked. |
preferCompactEncodesBoolean
|
Whether compact encodes are preferred. |
preferLosslessAudioBoolean
|
Whether lossless audio is preferred. |
blockUpscaledBoolean
|
Whether upscaled releases are blocked. |
SecretConfigValuePayload
Section titled “SecretConfigValuePayload”Secret provider configuration value represented without plaintext.
Fields
| Name | Description |
|---|---|
storedBoolean!
|
True when a secret is stored; false means absent or cleared. |
SecuritySettingsPayload
Section titled “SecuritySettingsPayload”Security settings and effective environment overrides.
Fields
| Name | Description |
|---|---|
formLoginEnabledBoolean!
|
Whether form-based login is enabled by configuration. |
sessionDurationDaysInt!
|
Instance-wide lifetime of new sign-in sessions, in days. |
passwordMinLengthInt!
|
Minimum accepted password length. |
skipLoginForLocalIpsBoolean!
|
Whether local IPs may skip login. |
apiKeysRestrictToSystemSettingsUsersBoolean!
|
Whether API keys are restricted to users with system-settings permission. |
mfaRequireConfigStepUpBoolean!
|
Whether configuration changes require MFA step-up. |
mfaRequirePasswordLoginBoolean!
|
Whether password login is required alongside MFA. |
mfaRequireJellyfinLoginBoolean!
|
Whether Jellyfin login requires an enrolled authentication factor. |
mfaRequireEmbyLoginBoolean!
|
Whether Emby login requires an enrolled authentication factor. |
totpRequireJellyfinLoginBoolean!
|
Deprecated: Use mfaRequireJellyfinLogin. Deprecated alias for |
totpRequireEmbyLoginBoolean!
|
Deprecated: Use mfaRequireEmbyLogin. Deprecated alias for |
effectiveFormLoginEnabledBoolean!
|
Effective form-login state after environment overrides. |
envOverrideActiveBoolean!
|
Whether an environment override is active. |
envOverrideDescriptionString
|
Description of the active override, or null when none is active. |
SeedingProfilePayload
Section titled “SeedingProfilePayload”Named torrent seeding policy assignable to indexers, routing entries, or the global default.
Fields
| Name | Description |
|---|---|
idID!
|
Seeding profile ID. |
nameString!
|
Seeding profile name. |
ratioFloat
|
Share ratio goal, or null to defer to the download client's own limits. |
seedTimeMinutesInt
|
Seed time goal in minutes, or null to defer to the download client's own limits. |
seasonPackModeSeasonPackSeedModeValue!
|
Whether season packs inherit or override the profile's goals. |
seasonPackRatioFloat
|
Season-pack share ratio goal, or null when unset. |
seasonPackSeedTimeMinutesInt
|
Season-pack seed time goal in minutes, or null when unset. |
honorTrackerMinimumsBoolean!
|
Whether resolved goals are raised to tracker-declared minimums. |
goalMetActionSeedGoalMetActionValue!
|
Action taken once the seeding goal is met. |
neverRemoveBoolean!
|
Whether torrents grabbed under this profile are never auto-removed. |
minimumSeedersInt
|
Fewest seeders a candidate may report and still be grabbed. Null inherits the system floor; 0 disables the check. |
postImportTrackingPostImportTrackingValue!
|
Whether Scryer keeps managing torrents grabbed under this profile after import. |
createdAtDateTime!
|
UTC creation time. |
updatedAtDateTime!
|
UTC last-update time. |
SeriesMovieLinkPayload
Section titled “SeriesMovieLinkPayload”A movie’s placement and continuity metadata within a series.
Fields
| Name | Description |
|---|---|
idID!
|
Stable series-movie link identifier. |
movieMovieEntityPayload!
|
Movie metadata referenced by this link. |
narrativeOrderString
|
Narrative position within the series, or null when unknown. |
afterSeasonInt
|
Season after which the movie is placed, or null when not applicable. |
beforeSeasonInt
|
Season before which the movie is placed, or null when not applicable. |
linkedEpisodeIdID
|
Linked episode identifier, or null when this link has no episode anchor. |
continuityStatusString
|
Continuity classification, or null when not determined. |
movieFormString
|
Form of the movie in the series chronology, or null when not determined. |
signalSummaryString
|
Short explanation of the placement signals, or null when unavailable. |
monitoringOverrideBoolean
|
Explicit operator monitoring choice, or null when title policy manages this link. |
metadataActiveBoolean!
|
Whether current metadata still reports this series-movie relationship. |
monitoredBoolean!
|
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. |
SeriesMovieScopePayload
Section titled “SeriesMovieScopePayload”Union member identifying a series-movie relationship by ID.
Fields
| Name | Description |
|---|---|
seriesMovieLinkIdID!
|
Target series-movie link ID. |
ServiceLogsPayload
Section titled “ServiceLogsPayload”Snapshot of the in-memory service log buffer.
Fields
| Name | Description |
|---|---|
generatedAtDateTime!
|
UTC time when the snapshot was generated. |
lines[String!]!
|
Log lines returned, newest or oldest order as defined by the service buffer. |
countInt!
|
Number of returned lines. |
ServiceSettingsPayload
Section titled “ServiceSettingsPayload”TLS certificate and private-key paths used by the service.
Fields
| Name | Description |
|---|---|
tlsCertPathString!
|
Filesystem path to the TLS certificate. |
tlsKeyPathString!
|
Filesystem path to the TLS private key. |
SetCollectionMonitoredPayload
Section titled “SetCollectionMonitoredPayload”Result of changing a collection’s monitored state.
Fields
| Name | Description |
|---|---|
idID!
|
Identifier of the collection that was updated. |
monitoredBoolean!
|
The resulting monitored state. |
episodes[EpisodePayload!]!
|
Episodes in the collection after the monitoring change. |
SetTitleRequiredAudioPayload
Section titled “SetTitleRequiredAudioPayload”Result of setting a title’s required-audio-language override.
Fields
| Name | Description |
|---|---|
titleIdID!
|
Target title ID. |
facetMediaFacetValue!
|
Title media facet. |
languages[String!]
|
Effective override languages; null means inherited behavior. |
updatedBoolean!
|
Whether the stored value changed. |
SetupStatusPayload
Section titled “SetupStatusPayload”Current setup prerequisites and completion state.
Fields
| Name | Description |
|---|---|
setupCompleteBoolean!
|
Whether initial setup has been completed. |
hasDownloadClientsBoolean!
|
Whether at least one download client is configured. |
hasIndexersBoolean!
|
Whether at least one indexer is configured. |
SmgScryerUpdateNoticePayload
Section titled “SmgScryerUpdateNoticePayload”Available Scryer update information.
Fields
| Name | Description |
|---|---|
availableBoolean!
|
Whether a newer version is available. |
currentVersionString!
|
Currently running version. |
latestVersionString!
|
Latest available version. |
latestTagString!
|
Latest release tag. |
releaseUrlString
|
Release URL, or null when unavailable. |
publishedAtDateTime
|
UTC publication time, or null when unavailable. |
checkedAtDateTime!
|
UTC time when the check completed. |
SmgVersionCompatibilityNoticePayload
Section titled “SmgVersionCompatibilityNoticePayload”Compatibility result comparing the connected SMG version with requirements.
Fields
| Name | Description |
|---|---|
statusString!
|
Compatibility status string. |
minimumVersionString!
|
Minimum supported SMG version. |
yourVersionString!
|
Connected SMG version. |
messageString!
|
Human-readable compatibility message. |
upgradeDeadlineString
|
Optional UTC deadline for upgrading. |
StartLocationOperationPayload
Section titled “StartLocationOperationPayload”Acceptance of a confirmed location operation; the work runs in the background.
Fields
| Name | Description |
|---|---|
operationLocationOperationPayload!
|
The accepted operation, as persisted. |
planFingerprintString!
|
Fingerprint of the plan the server rebuilt and accepted. |
StorageRootUsagePayload
Section titled “StorageRootUsagePayload”Filesystem usage of the volume backing one library root folder.
Fields
| Name | Description |
|---|---|
pathString!
|
Configured root-folder path as stored on the library. |
libraryIdID!
|
ID of the library that owns this root folder. |
libraryNameString!
|
Name of the library that owns this root folder. |
facetMediaFacetValue!
|
Media facet of the library that owns this root folder. |
usedBytesLong
|
Bytes in use on the backing filesystem; null when it cannot be inspected. |
totalBytesLong
|
Total bytes on the backing filesystem; null when it cannot be inspected. |
StringConfigValuePayload
Section titled “StringConfigValuePayload”Stored string provider configuration value.
Fields
| Name | Description |
|---|---|
valueString!
|
String value. |
SubmitMediaRequestPayload
Section titled “SubmitMediaRequestPayload”Result containing the ID of the submitted or deduplicated request.
Fields
| Name | Description |
|---|---|
requestIdID!
|
ID of the submitted or deduplicated media request. |
SubscriptionRoot
Section titled “SubscriptionRoot”Fields
| Name | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
locationTransferSummaryLocationTransferSnapshotPayload!
|
Arguments
|
||||||||||||
locationTransferPageLocationTransferSnapshotPayload!
|
Arguments
|
||||||||||||
locationTransferFilesLocationTransferSnapshotPayload!
|
Arguments
|
||||||||||||
activityEventsActivityEventPayload!
|
|||||||||||||
domainEventFeedDomainEventEnvelopePayload!
|
Arguments
|
||||||||||||
downloadQueueSyncDownloadQueueSyncPayload!
|
|||||||||||||
activeImportStreamsSyncActiveImportStreamSyncPayload!
|
Notify clients when queued or active import streams change. |
||||||||||||
downloadQueue[DownloadQueueItemPayload!]!
|
Deprecated: use downloadQueueSync Arguments
|
||||||||||||
libraryScanStateLibraryScanProgressPayload!
|
|||||||||||||
jobRunEventsJobRunPayload!
|
|||||||||||||
serviceLogLinesString!
|
|||||||||||||
importHistoryChangedBoolean!
|
|||||||||||||
mediaRequestsChangedMediaRequestChangedPayload!
|
|||||||||||||
indexersChangedBoolean!
|
|||||||||||||
providerCatalogChanged[ProviderCatalogFamilyValue!]!
|
|||||||||||||
pluginInstallProgressPluginInstallProgressPayload!
|
Arguments
|
||||||||||||
externalImportMonitorWarmupProgressExternalImportMonitorWarmupProgressPayload!
|
Arguments
|
||||||||||||
settingsChanged[String!]!
|
SubtitleLanguagePreferencePayload
Section titled “SubtitleLanguagePreferencePayload”Subtitle language preference with hearing-impaired and forced flags.
Fields
| Name | Description |
|---|---|
codeString!
|
Language code. |
hearingImpairedBoolean!
|
Whether hearing-impaired subtitles are preferred. |
forcedBoolean!
|
Whether forced subtitles are preferred. |
SubtitleProviderConfigPayload
Section titled “SubtitleProviderConfigPayload”Subtitle-provider configuration and health state without exposing secret values.
Fields
| Name | Description |
|---|---|
idID!
|
Subtitle-provider configuration ID. |
nameString!
|
Provider configuration name. |
providerTypeString!
|
Subtitle-provider type identifier. |
hasConfigBoolean!
|
Whether provider configuration exists. |
storedSecretKeys[String!]!
|
Names of stored secret fields, never their values. |
enabledFacets[MediaFacetValue!]!
|
Media facets enabled for this provider. |
isEnabledBoolean!
|
Whether the provider is enabled. |
lastHealthStatusString
|
Most recent health status, or null before the first check. |
lastErrorString
|
Most recent error, or null when none is recorded. |
lastErrorAtDateTime
|
UTC time of the most recent error, or null when none is recorded. |
disabledUntilDateTime
|
UTC time until which the provider is disabled, or null when not disabled. |
createdAtDateTime!
|
UTC creation time. |
updatedAtDateTime!
|
UTC last-update time. |
SubtitleSearchPayload
Section titled “SubtitleSearchPayload”Reports one subtitle search: what was searched, what the caller may search next, and the provider matches found.
Fields
| Name | Description |
|---|---|
statusSubtitleSearchStatus!
|
Why the search returned these results. |
languageString!
|
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. |
SubtitleSearchResult
Section titled “SubtitleSearchResult”Describes a subtitle provider result and its match characteristics.
Fields
| Name | Description |
|---|---|
providerString!
|
Provider that returned the subtitle. |
providerFileIdString!
|
Provider-specific subtitle file ID used for download. |
languageString!
|
Subtitle language code. |
releaseInfoString
|
Provider release information; null when unavailable. |
scoreInt!
|
Raw subtitle match score. |
scorePercentInt!
|
Match score normalized to a percentage. |
hearingImpairedBoolean!
|
Whether the subtitle includes hearing-impaired cues. |
forcedBoolean!
|
Whether the subtitle is intended only for forced dialogue. |
aiTranslatedBoolean!
|
Whether the subtitle was translated with generative AI. |
machineTranslatedBoolean!
|
Whether the subtitle was machine translated. |
uploaderString
|
Provider uploader name; null when unavailable. |
downloadCountInt
|
Provider-reported download count; null when unavailable. |
hashMatchedBoolean!
|
Whether the subtitle matched the media file hash. |
SubtitleSettingsPayload
Section titled “SubtitleSettingsPayload”Effective subtitle search, download, and synchronization settings.
Fields
| Name | Description |
|---|---|
enabledBoolean!
|
Whether subtitle processing is enabled. |
languages[SubtitleLanguagePreferencePayload!]!
|
Ordered subtitle language preferences. |
autoDownloadOnImportBoolean!
|
Whether subtitles are downloaded automatically after import. |
minimumScoreSeriesInt!
|
Minimum subtitle score for series, on the provider score scale. |
minimumScoreMovieInt!
|
Minimum subtitle score for movies, on the provider score scale. |
searchIntervalHoursInt!
|
Search interval in hours. |
includeAiTranslatedBoolean!
|
Whether AI-translated subtitles are eligible. |
includeMachineTranslatedBoolean!
|
Whether machine-translated subtitles are eligible. |
syncEnabledBoolean!
|
Whether subtitle synchronization is enabled. |
syncThresholdSeriesInt!
|
Synchronization threshold for series, on the provider score scale. |
syncThresholdMovieInt!
|
Synchronization threshold for movies, on the provider score scale. |
syncMaxOffsetSecondsInt!
|
Maximum subtitle offset correction in seconds. |
SubtitleStreamDetailPayload
Section titled “SubtitleStreamDetailPayload”Subtitle stream metadata for a media file.
Fields
| Name | Description |
|---|---|
codecString
|
Codec name, or null when unavailable. |
languageString
|
Language code, or null when unavailable. |
nameString
|
Stream name, or null when unavailable. |
forcedBoolean!
|
Whether the subtitle is forced. |
defaultBoolean!
|
Whether the subtitle is the default stream. |
SystemHealthPayload
Section titled “SystemHealthPayload”Current service health and catalog counters.
Fields
| Name | Description |
|---|---|
serviceReadyBoolean!
|
Whether the service is ready to accept work. |
dbPathString!
|
Configured database path. |
datastoreEngineString!
|
Datastore engine name. |
datastoreMigrationKeyString
|
Datastore migration key, or null when unavailable. |
runtimePathStyleRuntimePathStyleValue!
|
Runtime path syntax. |
totalTitlesInt!
|
Total title count across facets. |
monitoredTitlesInt!
|
Number of monitored titles. |
totalUsersInt!
|
Total user count. |
titlesMovieInt!
|
Movie title count. |
titlesSeriesInt!
|
Series title count. |
titlesAnimeInt!
|
Anime title count. |
titlesOtherInt!
|
Titles outside the named facets. |
recentEventsInt!
|
Number of recent events included in the preview window. |
recentEventPreview[String!]!
|
Recent event preview messages in source order. |
dbMigrationVersionString
|
Datastore migration version, or null when unavailable. |
indexerStats[IndexerQueryStatsPayload!]!
|
Query statistics for configured indexers. |
TestRuleSetPayload
Section titled “TestRuleSetPayload”Explicit, read-only scoring preview for the current rule-editor draft.
Fields
| Name | Description |
|---|---|
scoreInt!
|
Aggregate score after normal policy aggregation. |
allowedBoolean!
|
Whether mandatory requirements and both final score gates pass. |
blockedBoolean!
|
Whether the completed decision is rejected by a requirement or score gate. |
minimumScoreMetBoolean!
|
Whether the configured minimum-score gate passed. |
profileNameString!
|
Resolved quality-profile name. |
contextRuleSetTestContextPayload!
|
Resolved title, library, and episode context. |
parsedRuleSetTestParsedPayload!
|
Parsed release facts preserved from the supplied release name. |
ruleSets[RuleSetTestRuleSetPayload!]!
|
Contributions grouped by policy rule set. |
draftContributionRuleSetTestDraftContributionPayload!
|
Dedicated explanation of the current draft's contribution. |
errors[RuleSetTestErrorPayload!]!
|
Validation and evaluation errors retained by the preview. |
TitleAcquisitionDiagnosticsPayload
Section titled “TitleAcquisitionDiagnosticsPayload”Acquisition diagnostics for a title, including decisions and state counts.
Fields
| Name | Description |
|---|---|
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. |
mismatchRecoveryEligibleCountInt!
|
Number of scopes eligible for mismatch-recovery search. |
latestDecisionAtDateTime
|
Time of the latest release decision in UTC, or null when none exists. |
latestWantedSearchAtDateTime
|
Time of the latest wanted search in UTC, or null when none exists. |
TitleCatalogFilterCountsPayload
Section titled “TitleCatalogFilterCountsPayload”Counts for common title catalog filter facets.
Fields
| Name | Description |
|---|---|
allInt!
|
Number of matching titles before the facet is applied. |
monitoredInt!
|
Number of matching monitored titles. |
unmonitoredInt!
|
Number of matching unmonitored titles. |
continuingInt!
|
Number of matching continuing titles. |
endedInt!
|
Number of matching ended titles. |
TitleCatalogFilterOptionsPayload
Section titled “TitleCatalogFilterOptionsPayload”Available canonical tag filters and the observed release-year range.
Fields
| Name | Description |
|---|---|
genres[CanonicalTagFilterOptionPayload!]!
|
Genre tag options available to the current catalog scope. |
themes[CanonicalTagFilterOptionPayload!]!
|
Theme tag options available to the current catalog scope. |
minimumYearInt
|
Lowest observed release year, or null when no title has a year. |
maximumYearInt
|
Highest observed release year, or null when no title has a year. |
TitleCatalogPayload
Section titled “TitleCatalogPayload”A page of catalog titles with counts and managed storage usage.
Fields
| Name | Description |
|---|---|
items[TitlePayload!]!
|
Titles in the requested page, in the requested stable sort order. |
hasMoreBoolean!
|
Whether another page exists after the current page. |
totalCountInt!
|
Number of titles matching the filters across all pages. |
filterCountsTitleCatalogFilterCountsPayload!
|
Counts for the standard monitored and content-status facets. |
managedBytesLong!
|
Total managed media bytes represented by the matching catalog scope. |
TitleClaim
Section titled “TitleClaim”One hold on one title.
Fields
| Name | Description |
|---|---|
idID!
|
Claim ID. |
titleIdID!
|
Title the claim holds. |
libraryIdID!
|
Library that title belongs to. |
producerLifecycleClaimProducerValue!
|
What produced the claim. |
producerRefString
|
The producing media request's ID, or null for an operator pin. |
kindLifecycleClaimKindValue!
|
What the claim holds. |
stateLifecycleClaimStateValue!
|
Current lifecycle state. |
durationDaysInt
|
Requested window in days for a retention claim; null for a keep. |
startsAtDateTime
|
When the claim started running, which is the title's first import. Null while dormant. |
expiresAtDateTime
|
When the window closes. Null while dormant and for a keep. |
createdByID
|
ID of the user the claim is attributed to, or null when unattributed. |
createdAtDateTime!
|
UTC creation time. |
updatedAtDateTime!
|
UTC last-update time. |
releasedReasonString
|
Why the claim was released or converted; kept as history, never cleared. |
TitleCreditPayload
Section titled “TitleCreditPayload”One cast or crew credit cached from the title’s last metadata hydration.
Fields
| Name | Description |
|---|---|
kindString!
|
Credit kind exactly as the metadata provider spelled it, e.g. |
personNameString!
|
Person's display name in the hydration language. |
personOriginalNameString!
|
Person's name in their original language, or empty when the provider has none. |
personImageUrlString
|
Proxied portrait for this person, or null when the provider has no image. |
characterString!
|
Character played, or empty for crew credits. |
languageString!
|
Language tag this credit was hydrated in, or empty when the provider has none. |
billingOrderInt!
|
Provider billing rank; lower sorts closer to top billing. |
episodeCountInt
|
Episodes this person appears in, or null for titles the provider does not count. |
TitleExternalRatingPayload
Section titled “TitleExternalRatingPayload”One external rating source and its normalized score.
Fields
| Name | Description |
|---|---|
sourceString!
|
Rating provider name. |
valueFloat
|
Provider rating value before normalization, or null when absent. |
scoreFloat
|
Provider score on its native scale, or null when absent. |
normalizedFloat!
|
Score normalized to the shared comparison scale. |
votesInt
|
Number of votes reported by the provider, or null when absent. |
urlString!
|
Provider page for this rating. |
TitleHistoryEventPayload
Section titled “TitleHistoryEventPayload”One event in a title’s acquisition and file history.
Fields
| Name | Description |
|---|---|
idID!
|
History event ID. |
titleIdID
|
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). |
titleNameString
|
Title name, or null when no name was available. |
posterUrlString
|
Poster URL of the title, or null when the title is gone or has no poster. |
libraryIdID
|
Library owning the title, or null when the event cannot be attributed. |
facetMediaFacetValue
|
Media facet, or null when the event is not facet-specific. |
sizeBytesLong
|
Bytes imported or upgraded; null for other event types and for events recorded before sizes were captured. |
episodeIdID
|
Episode ID, or null when not episode-specific. |
episodeIds[ID!]!
|
Episode IDs affected by the event. |
collectionIdID
|
Collection ID, or null when not collection-specific. |
eventTypeString!
|
Stable domain event code represented by this history row. |
actorKindActorKindValue
|
Kind of actor that caused the event, or null when unknown. |
actorUserIdID
|
Acting user ID, or null for non-user actors. |
actorDisplayNameString
|
Acting user display name, or null when unavailable. |
sourceTitleString
|
Title as supplied by the source, or null when unavailable. |
displayTitleString
|
Display title recorded for the event, or null when unavailable. |
sourceSystemString
|
Source system name, or null when unavailable. |
sourceRefString
|
Source reference, or null when unavailable. |
sourceProviderString
|
Source provider, or null when unavailable. |
sourceHintString
|
Download source locator associated with the event, or null when unavailable. |
qualityString
|
Quality label, or null when unavailable. |
downloadIdString
|
Download identity, or null when unavailable. |
clientIdID
|
Download client ID, or null when unavailable. |
clientNameString
|
Download client name, or null when unavailable. |
importIdID
|
Import job ID, or null when unavailable. |
skipReasonString
|
Skip reason, or null when the event was not skipped. |
retryRequiresPasswordBoolean!
|
Whether retrying requires a password. |
failureReasonString
|
Failure reason, or null when the event did not fail. |
blocklistReasonString
|
Blocklist reason, or null when the event was not blocklisted. |
sourcePathString
|
Source file path, or null when unavailable. |
destPathString
|
Destination file path, or null when unavailable. |
dataJsonJSON
|
Additional event data as JSON, or null when absent. |
occurredAtDateTime!
|
Time the event occurred in UTC. |
createdAtDateTime!
|
Time the event record was created in UTC. |
TitleHistoryPagePayload
Section titled “TitleHistoryPagePayload”A page of title history events and pagination state.
Fields
| Name | Description |
|---|---|
items[TitleHistoryEventPayload!]!
|
Events in the requested page. |
totalCountInt!
|
Total matching events across all pages. |
hasMoreBoolean!
|
Whether more matching events exist after this page. |
TitleMediaFilePayload
Section titled “TitleMediaFilePayload”A title media file with raw scan data and parsed acquisition metadata.
Fields
| Name | Description |
|---|---|
analysisMediaAnalysisDetailsPayload!
|
Versioned analysis retained from the last successful inspection. |
analysisAttemptMediaAnalysisAttemptPayload
|
Latest probe attempt, including failures that did not replace successful metadata. |
idID!
|
Stable media file identifier. |
titleIdID!
|
Identifier of the title owning this file. |
episodeIdID
|
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. |
filePathString!
|
Absolute path to the media file. |
sizeBytesLong!
|
File size in bytes. |
roleString!
|
File role, such as primary or additional media. |
qualityLabelString
|
Human-readable quality label, or null before quality is known. |
scanStatusString!
|
Raw media scan state; analysis fields remain null until scanning completes. |
createdAtDateTime!
|
Time when the file record was created, in UTC. |
videoCodecString
|
Codec discovered by media analysis, or null until a scan supplies it. |
videoWidthInt
|
Video width in pixels, or null until a scan supplies it. |
videoHeightInt
|
Video height in pixels, or null until a scan supplies it. |
videoBitrateKbpsInt
|
Video bitrate in kilobits per second, or null until a scan supplies it. |
videoBitDepthInt
|
Video bit depth in bits per channel, or null until a scan supplies it. |
videoHdrFormatString
|
HDR format reported by the scan, or null when absent or not scanned. |
videoFrameRateString
|
Video frame rate as a source-formatted string, or null until known. |
videoProfileString
|
Codec profile reported by the scan, or null until known. |
audioCodecString
|
Audio codec reported by the scan, or null until known. |
audioChannelsInt
|
Number of audio channels, or null until known. |
audioBitrateKbpsInt
|
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. |
hasMultiaudioBoolean!
|
Whether the file contains multiple audio streams. |
durationSecondsInt
|
Media duration in seconds, or null until known. |
numChaptersInt
|
Number of chapters, or null until known. |
containerFormatString
|
Container format, or null until known. |
sceneNameString
|
Parsed scene or release name, or null when import metadata is unavailable. |
releaseGroupString
|
Parsed release group, or null when unavailable. |
sourceTypeString
|
Parsed source type, or null when unavailable. |
resolutionString
|
Parsed resolution label, or null when unavailable. |
videoCodecParsedString
|
Parsed video codec label, or null when unavailable. |
audioCodecParsedString
|
Parsed audio codec label, or null when unavailable. |
acquisitionScoreInt
|
Acquisition score assigned during release matching, or null when not scored. |
scoringLogString
|
Structured scoring explanation, or null when no scoring record exists. |
indexerSourceString
|
Indexer or provider that supplied the release, or null when unknown. |
grabbedReleaseTitleString
|
Release title that was grabbed, or null when the file was not acquired from a release. |
grabbedAtDateTime
|
Time when the release was grabbed, in UTC, or null when not recorded. |
editionString
|
Parsed edition label, or null when unavailable. |
originalFilePathString
|
File path before import moved or renamed the file, or null when not recorded. |
releaseHashString
|
Release identity hash, or null when unavailable. |
titleTitlePayload
|
Parent title for this media file, or null if it is no longer available to the caller. |
episodeEpisodePayload
|
Episode represented by this file, or null for title-level media. |
TitlePayload
Section titled “TitlePayload”Catalog metadata, monitoring settings, and media identity for a title.
Fields
| Name | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
idID!
|
Stable title identifier. |
||||||||||
libraryIdID!
|
Identifier of the library containing this title. |
||||||||||
nameString!
|
Display title from the catalog metadata. |
||||||||||
facetMediaFacetValue!
|
Media facet that determines the title's domain, such as movie or series. |
||||||||||
monitoredBoolean!
|
Whether acquisition and monitoring are enabled for the title. |
||||||||||
tags[String!]!
|
User-defined tags plus reserved |
||||||||||
externalIds[ExternalIdPayload!]!
|
External catalog identifiers attached to the title. |
||||||||||
createdAtDateTime!
|
Time when the title record was created, in UTC. |
||||||||||
yearInt
|
Release year, when catalog metadata supplies one. |
||||||||||
overviewString
|
Plot or synopsis text, or null before metadata provides it. |
||||||||||
posterUrlString
|
Proxied poster URL, or null when no poster source is available. |
||||||||||
posterSourceUrlString
|
Poster source URL exposed alongside |
||||||||||
backgroundUrlString
|
Proxied background URL, or null when no background source is available. |
||||||||||
backgroundSourceUrlString
|
Background source URL exposed alongside |
||||||||||
sortTitleString
|
Normalized title used for ordering, or null when not computed. |
||||||||||
slugString
|
Stable URL-friendly title key, or null when not assigned. |
||||||||||
imdbIdString
|
IMDb identifier, or null when the title has no IMDb match. |
||||||||||
runtimeMinutesInt
|
Runtime in minutes, or null when unknown. |
||||||||||
popularityFloat
|
Catalog popularity score, or null when unavailable. |
||||||||||
canonicalTags[CanonicalMediaTagPayload!]!
|
Canonical genre and theme tags resolved from source metadata. |
||||||||||
contentStatusString
|
Catalog content status, or null before metadata provides it. |
||||||||||
languageString
|
Original content language code, or null when unknown. |
||||||||||
firstAiredDate
|
First air date as a calendar date, or null when unavailable. |
||||||||||
networkString
|
Broadcasting network, or null when unknown. |
||||||||||
studioString
|
Production studio, or null when unknown. |
||||||||||
countryString
|
Production country, or null when unknown. |
||||||||||
aliases[String!]!
|
Alternate title strings from catalog metadata. |
||||||||||
metadataLanguageString
|
Language used for the latest metadata fetch, or null when not recorded. |
||||||||||
metadataFetchedAtDateTime
|
Time of the latest metadata fetch in UTC, or null before a fetch completes. |
||||||||||
qualityProfileIdID
|
Identifier of the selected quality profile, or null when the title uses no profile. |
||||||||||
rootFolderIdID!
|
Identifier of the root folder that stores this title's files. |
||||||||||
monitorTypeMonitorTypeValue
|
Monitoring mode, or null when no explicit mode is configured. |
||||||||||
useSeasonFoldersBoolean
|
Whether episodic files use season directories, or null when unset. |
||||||||||
monitorSpecialsBoolean
|
Whether specials are monitored, or null when unset. |
||||||||||
interSeasonMoviesBoolean
|
Whether movies between seasons are included, or null when unset. |
||||||||||
fillerPolicyFillerPolicyValue
|
Policy for filler episodes, or null when unset. |
||||||||||
recapPolicyRecapPolicyValue
|
Policy for recap episodes, or null when unset. |
||||||||||
releaseNumberingReleaseNumberingValue
|
Which episode numbering this title's releases are read in, or null when
the title follows the default ( |
||||||||||
playbackLinks[MediaServerPlaybackLinkPayload!]!
|
Provider-native playback links for this title, when an exact catalog mapping exists. |
||||||||||
qualityTierString
|
Effective target quality-profile label for the title. |
||||||||||
currentQualityTierString
|
Lowest live media-file quality tier for the title. |
||||||||||
sizeBytesLong
|
Aggregated media-file size in bytes for the title. |
||||||||||
episodesOwnedInt
|
Owned-vs-total episode progress, excluding specials. |
||||||||||
episodesMonitoredInt
|
Monitored episode count, excluding specials. |
||||||||||
episodesTotalInt
|
Total episode count, excluding specials. |
||||||||||
mediaResolutionString
|
Primary movie media resolution. |
||||||||||
mediaHdrString
|
Primary movie media HDR format. |
||||||||||
mediaAudioCodecString
|
Primary movie media audio codec. |
||||||||||
libraryNameString
|
Name of the title's library when it is visible to the caller, otherwise null. |
||||||||||
librarySlugString
|
Stable slug of the title's caller-visible library, otherwise null. |
||||||||||
ratingsTitleRatingPayload!
|
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
|
||||||||||
moreLikeThis[DiscoveryItemPayload!]!
|
Discovery items related to this title, limited to the requested count. Arguments
|
||||||||||
rootFolderPathString!
|
Absolute root-folder path for this title; requires view permission on its library. |
||||||||||
renameEnabledBoolean!
|
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. |
||||||||||
metadataLanguageOverrideString
|
Explicit metadata-language override, or null when the global default is inherited. |
||||||||||
effectiveMetadataLanguageString!
|
Metadata language after applying title and library overrides. |
||||||||||
inheritsMetadataLanguageBoolean!
|
Whether this title inherits metadata language from its library or the global default. |
||||||||||
useSeasonFoldersOverrideBoolean
|
Explicit season-folder override, or null when library/facet settings are inherited. |
||||||||||
effectiveUseSeasonFoldersBoolean!
|
Whether this title uses season folders after applying inheritance. |
||||||||||
inheritsUseSeasonFoldersBoolean!
|
Whether this title inherits the season-folder setting from its library or facet. |
||||||||||
effectiveFillerPolicyFillerPolicyValue
|
Filler policy after applying the title override or library/facet default. |
||||||||||
effectiveRecapPolicyRecapPolicyValue
|
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 |
||||||||||
inheritsRequiredAudioLanguagesBoolean!
|
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. |
||||||||||
wantedItemsWantedItemsPagePayload!
|
Wanted scopes for this title, optionally filtered by status and returned as a page without a total count. Arguments
|
||||||||||
releaseDecisionsReleaseDecisionsPagePayload!
|
Release decisions for this title with a total count and continuation flag. Arguments
|
||||||||||
downloadQueueItems[DownloadQueueItemPayload!]!
|
Queue items associated with this title after the supplied activity filters are applied. Arguments
|
TitleRatingPayload
Section titled “TitleRatingPayload”Combined title rating and the sources that contributed it.
Fields
| Name | Description |
|---|---|
ratingFloat
|
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. |
TitleReleaseBlocklistEntryPayload
Section titled “TitleReleaseBlocklistEntryPayload”One blocked release for a title.
Fields
| Name | Description |
|---|---|
idID!
|
Blocklist entry ID. |
releaseNameString!
|
The blocked release's name, as the indexer presented it. |
errorMessageString
|
Failure or blocklist reason, or null when unavailable. |
attemptedAtDateTime!
|
UTC time when the release was attempted. |
TitleScopePayload
Section titled “TitleScopePayload”Union member indicating the entire title is the acquisition scope.
Fields
| Name | Description |
|---|---|
wholeTitleBoolean!
|
Always true when this marker is emitted. |
TitleTagDefinitionDeletionPayload
Section titled “TitleTagDefinitionDeletionPayload”Identity of a deleted title tag and what the deletion cleaned up.
Fields
| Name | Description |
|---|---|
idID!
|
Deleted title-tag definition ID. |
labelString!
|
Label the deleted tag carried. |
countsTitleTagRewriteCountsPayload!
|
Rewrite and reference counts for the deletion. |
TitleTagDefinitionMutationPayload
Section titled “TitleTagDefinitionMutationPayload”A saved title-tag definition together with what the save rewrote.
Fields
| Name | Description |
|---|---|
definitionTitleTagDefinitionPayload!
|
The definition as it now stands. |
countsTitleTagRewriteCountsPayload!
|
Rewrite and reference counts; all zero when a tag is created or only its description changed. |
TitleTagDefinitionPayload
Section titled “TitleTagDefinitionPayload”Administrator-defined title tag and how many titles currently carry it.
Fields
| Name | Description |
|---|---|
idID!
|
Title-tag definition ID. |
labelString!
|
Normalized label stored on every title carrying this tag; lowercase, with internal whitespace collapsed. |
descriptionString
|
Operator-facing note about what the tag is for, or null when none was written. |
titleCountInt!
|
Number of titles currently carrying the label. |
seriesMovieCountInt!
|
Number of series movies currently carrying the label. Counted separately from |
createdAtDateTime!
|
Time the tag was defined, in UTC. |
updatedAtDateTime!
|
Time the tag was last renamed or re-described, in UTC. |
TitleTagRewriteCountsPayload
Section titled “TitleTagRewriteCountsPayload”What a title-tag rename or deletion rewrote, and what it only found.
Fields
| Name | Description |
|---|---|
titlesInt!
|
Titles whose tag list was rewritten. |
seriesMoviesInt!
|
Series movies whose tag list was rewritten. |
delayProfilesInt!
|
Delay profiles whose tag list was rewritten. |
maintenanceRuleSetsInt!
|
Maintenance rule sets whose current rule source names the old label; rule sources are never rewritten, so these rules stop matching. |
releaseRuleSetsInt!
|
Release rule sets whose rule source names the old label; rule sources are never rewritten, so these rules stop matching. |
managedTagFiltersInt!
|
Managed rule sets whose tag filter lists the old label; managed filters belong to their pack and are never rewritten. |
requestRuleSetsInt!
|
Request rule sets whose current rule source emits the old label; rule sources are never rewritten, so those rules stop applying the tag. |
TotpEnrollmentCompletePayload
Section titled “TotpEnrollmentCompletePayload”Result of completing TOTP enrollment or regenerating recovery codes.
Fields
| Name | Description |
|---|---|
statusTotpStatusPayload!
|
Updated TOTP status without the shared secret. |
recoveryCodes[String!]!
|
Newly generated one-time recovery codes; they are not returned again. |
TotpEnrollmentStartPayload
Section titled “TotpEnrollmentStartPayload”One-time values returned when TOTP enrollment starts.
Fields
| Name | Description |
|---|---|
challengeIdID!
|
ID of the short-lived enrollment challenge. |
otpauthUrlString!
|
|
secretBase32String!
|
Base32 TOTP secret; returned only for enrollment and must be protected as a secret. |
expiresAtDateTime!
|
UTC time when the enrollment challenge expires. |
TotpStatusPayload
Section titled “TotpStatusPayload”TOTP enrollment and usage status without exposing the shared secret.
Fields
| Name | Description |
|---|---|
enabledBoolean!
|
Whether TOTP is enabled. |
createdAtDateTime
|
UTC time when TOTP was enrolled, or null when never enrolled. |
lastUsedAtDateTime
|
UTC time when TOTP was last used, or null when unused. |
recoveryCodesRemainingInt!
|
Number of unused recovery codes remaining. |
TrackedRulePackMemberPayload
Section titled “TrackedRulePackMemberPayload”Local state of one source-template binding in a tracked rule pack.
Fields
| Name | Description |
|---|---|
templateIdString!
|
Stable template ID from the source pack. |
ruleSetIdID!
|
Local rule-set ID retained across source updates. |
removedBoolean!
|
Whether the template is absent from the current upstream version. |
enabledBoolean
|
Local enabled state, or null when the retained rule no longer exists. |
priorityInt
|
Local evaluation priority, or null when the retained rule no longer exists. |
nameString
|
Local rule name, or null when the retained rule no longer exists. |
descriptionString
|
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. |
TrackedRulePackPayload
Section titled “TrackedRulePackPayload”One installed rule pack and its locally editable member settings.
Fields
| Name | Description |
|---|---|
packIdString!
|
Immutable registry rule-pack ID. |
nameString!
|
Display name recorded from the verified manifest. |
versionString!
|
Installed immutable source version. |
digestString!
|
Verified source digest for the installed version. |
customizableBoolean!
|
Whether this installed pack permits copying its rules into user-authored rules. |
revisionLong!
|
Optimistic-concurrency token for pack changes. |
autoUpdateBoolean!
|
Whether scheduled updates are enabled for this pack. |
availableVersionString
|
Newer compatible registry version, or null when the installed version is current. |
autoUpdateAvailableBoolean!
|
Whether an automatic update is currently eligible for this pack. |
lastErrorString
|
Most recent automatic-update failure, or null when none is recorded. |
lastUpdatedDateTime!
|
UTC timestamp of the last successful installation or update. |
members[TrackedRulePackMemberPayload!]!
|
Source templates and their local rule-set bindings. |
TrackedRulePackPreviewPayload
Section titled “TrackedRulePackPreviewPayload”Preview of the exact source version that a tracked-pack update would apply.
Fields
| Name | Description |
|---|---|
versionString!
|
Candidate immutable source version. |
digestString!
|
Candidate verified source digest. |
revisionLong!
|
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. |
TriggerTitleMismatchRecoverySearchPayload
Section titled “TriggerTitleMismatchRecoverySearchPayload”Result of queuing title-mismatch recovery searches.
Fields
| Name | Description |
|---|---|
titleIdID!
|
Title ID searched. |
queuedCountInt!
|
Number of recovery searches accepted for background processing. |
UiSettingsPayload
Section titled “UiSettingsPayload”Persisted caller presentation preferences and table-column settings.
Fields
| Name | Description |
|---|---|
themeUiThemeValue!
|
Selected theme. |
dateTimeFormatUiDateTimeFormatValue!
|
Selected date and time format. |
highlightColorString
|
Primary highlight color, or null when using the default. |
secondaryColorString
|
Secondary color, or null when using the default. |
highContrastModeBoolean!
|
Whether high-contrast presentation is enabled. |
reduceMotionBoolean!
|
Whether motion-reduction behavior is enabled. |
hideSponsorButtonBoolean!
|
Whether the sponsor button is hidden. |
densityUiDensityValue!
|
Selected density. |
sidebarModeUiSidebarModeValue!
|
Selected sidebar mode. |
defaultLandingViewUiDefaultLandingViewValue!
|
Content area opened by default. |
tableColumns[UiTableColumnSettingPayload!]!
|
Persisted table-column settings. |
UiTableColumnSettingPayload
Section titled “UiTableColumnSettingPayload”One persisted table-column preference for a facet and table mode.
Fields
| Name | Description |
|---|---|
facetUiSettingsFacetValue!
|
Media facet to which the column setting applies. |
tableViewModeUiTableViewModeValue!
|
Table mode to which the column setting applies. |
columnIdString!
|
Stable column identifier. |
columnOrderInt!
|
Zero-based display order. |
visibleBoolean!
|
Whether the column is visible. |
UninstallPluginPayload
Section titled “UninstallPluginPayload”Identifier returned after uninstalling a plugin.
Fields
| Name | Description |
|---|---|
pluginIdID!
|
Uninstalled plugin ID. |
UnlinkExternalAccountPayload
Section titled “UnlinkExternalAccountPayload”Identifier returned after unlinking an external account.
Fields
| Name | Description |
|---|---|
linkedAccountIdID!
|
Linked-account identity that was removed. |
UserLibraryPermissionGrantPayload
Section titled “UserLibraryPermissionGrantPayload”Permissions granted to one library for one user.
Fields
| Name | Description |
|---|---|
libraryIdID!
|
ID of the library receiving the grant. |
permissions[LibraryPermissionValue!]!
|
Permissions granted within that library. |
UserPayload
Section titled “UserPayload”User summary with authorization and credential-presence flags, never credential values.
Fields
| Name | Description |
|---|---|
idID!
|
ID of the user. |
usernameString!
|
Login username. |
loginEnabledBoolean!
|
Whether password or external login is enabled. |
isDefaultAdminBoolean!
|
Whether this is the default administrator account. |
hasPasswordBoolean!
|
Whether a password is configured, without revealing it. |
passwordChangeRequiredBoolean!
|
Whether a local password must be replaced before the next local-password session is full. |
hasMfaBoolean!
|
Whether MFA is configured, without revealing its secret. |
hasPasskeyBoolean!
|
Whether a passkey is configured. |
accountKindUserAccountKindValue!
|
Local or externally provisioned account origin. |
appPermissions[AppPermissionValue!]!
|
Application-wide permissions granted to the user. |
libraryPermissions[UserLibraryPermissionGrantPayload!]!
|
Library-specific permission grants. |
VerificationSettingsPayload
Section titled “VerificationSettingsPayload”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
| Name | Description |
|---|---|
depthVerificationDepthValue!
|
Depth applied when proving a copied file before its source is touched. |
WantedItemPayload
Section titled “WantedItemPayload”Acquisition target for a title scope, including missing and upgrade states.
Fields
| Name | Description | ||||||
|---|---|---|---|---|---|---|---|
idID!
|
Stable identifier for this scope, or an addressable key such as |
||||||
titleIdID!
|
Identifier of the title targeted for acquisition. |
||||||
titleNameString
|
Title name, or null when title metadata is unavailable. |
||||||
titleSlugString
|
Stable title slug, or null when unavailable. |
||||||
titleFacetString
|
Title facet, or null when title context is unavailable. |
||||||
libraryIdID
|
Identifier of the containing library, or null when the scope has no library context. |
||||||
libraryNameString
|
Library name, or null when library metadata is unavailable. |
||||||
librarySlugString
|
Stable library slug, or null when library metadata is unavailable. |
||||||
episodeIdID
|
Identifier of the targeted episode, or null for title and series-movie scopes. |
||||||
collectionIdID
|
Identifier of the targeted collection, or null when not applicable. |
||||||
seasonNumberString
|
Season number for an episodic scope, or null when not applicable or unknown. |
||||||
episodeNumberString
|
Episode number for an episodic scope, or null when not applicable or unknown. |
||||||
mediaTypeWantedMediaTypeValue!
|
Acquisition media type represented by this scope. |
||||||
lastSearchAtDateTime
|
Time of the latest search in UTC, or null before a search runs. |
||||||
statusWantedStatusValue!
|
Acquisition status; missing targets report wanted until a stored status exists. |
||||||
grabbedReleaseString
|
Serialized grabbed-release metadata, or null when no release has been grabbed. |
||||||
sourceProviderString
|
Safe provider label extracted from grabbed-release metadata, with sensitive release details omitted. |
||||||
currentScoreInt
|
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
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. |
||||||
latestReleaseDecisionReleaseDecisionPayload
|
Latest release decision, or null before a candidate decision exists. |
||||||
standbyCountInt!
|
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. |
||||||
mismatchRecoveryEligibleBoolean!
|
Whether a changed title match permits a recovery search. |
||||||
convergenceStateConvergenceStateValue!
|
Convergence state showing whether indexer coverage is queued, searching, complete, or deferred. |
||||||
indexersCoveredInt!
|
Number of routed indexers already searched under the current fingerprint. |
||||||
indexersRoutedInt!
|
Number of routed indexers enabled for this scope. |
||||||
recencyLaneRecencyLaneValue!
|
Scheduling lane used to prioritize convergence work. |
||||||
createdAtDateTime!
|
Creation time in UTC, using a fallback timestamp for synthesized scopes. |
||||||
updatedAtDateTime!
|
Update time in UTC, using a fallback timestamp for synthesized scopes. |
||||||
titleTitlePayload
|
Title targeted by this wanted scope, or null when it is no longer available to the caller. |
||||||
collectionCollectionPayload
|
Collection targeted by this scope, or null when the scope is not collection-based. |
||||||
episodeEpisodePayload
|
Episode targeted by this scope, or null for title, collection, and series-movie scopes. |
||||||
releaseDecisionsReleaseDecisionsPagePayload!
|
Release decisions for this wanted scope with a total count and continuation flag. Arguments
|
||||||
pendingReleasesPendingReleasesPayload!
|
Pending releases for this wanted scope with a total count and continuation flag. Arguments
|
WantedItemsListPayload
Section titled “WantedItemsListPayload”A complete or partial page of wanted acquisition scopes.
Fields
| Name | Description |
|---|---|
items[WantedItemPayload!]!
|
Wanted items in stable order. |
totalCountInt!
|
Number of matching scopes across all pages. |
hasMoreBoolean!
|
Whether another page exists after this page. |
WantedItemsPagePayload
Section titled “WantedItemsPagePayload”Wanted items returned without a total-count query.
Fields
| Name | Description |
|---|---|
items[WantedItemPayload!]!
|
Wanted items in stable order. |
WantedSearchPayload
Section titled “WantedSearchPayload”Counts reported for a wanted search attempt.
Fields
| Name | Description |
|---|---|
queuedCountInt!
|
Number of scopes queued for search. |
skippedInProgressCountInt!
|
Number of scopes skipped because work was already in progress. |
WantedStatusCountPayload
Section titled “WantedStatusCountPayload”Count of wanted items grouped by lifecycle status.
Fields
| Name | Description |
|---|---|
statusWantedStatusValue!
|
Wanted-item status. |
countInt!
|
Number of items with this status. |
WebauthnChallengePayload
Section titled “WebauthnChallengePayload”WebAuthn registration or authentication challenge options.
Fields
| Name | Description |
|---|---|
challengeIdID!
|
ID of the short-lived WebAuthn challenge. |
optionsJsonJSON!
|
Browser options JSON; it contains challenge data and should not be persisted as a credential. |
expiresAtDateTime!
|
UTC time when the challenge expires. |