Admin Console

{
  "data": [
    {
      "id": "id_8h2k4q",
      "label": "string"
    }
  ],
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

• dataarray of objectrequired

  • idstringrequired
  • labelstringrequired
• scopeobjectrequired

  • serverIdstringrequired
  • viewerFencestringrequired

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired

{
  "data": [
    {
      "code": "string",
      "firstAt": "2026-10-18T19:30:00Z",
      "id": "id_8h2k4q",
      "lastAt": "2026-10-18T19:30:00Z",
      "occurrences": 0,
      "params": {
        "key": "string"
      },
      "revision": 0,
      "severity": "string",
      "status": "string"
    }
  ],
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

• dataarray of objectrequired

  • codestringrequired
  • firstAtstringrequired

    RFC 3339 UTC instant; empty when absent.

  • idstringrequired
  • lastAtstringrequired

    RFC 3339 UTC instant; empty when absent.

  • occurrencesintegerrequired
  • paramsobjectrequired
  • revisionintegerrequired
  • severitystringrequired
  • statusstringrequired
• scopeobjectrequired

  • serverIdstringrequired
  • viewerFencestringrequired

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired

{
  "data": {
    "items": [
      {
        "at": "2026-10-18T19:30:00Z",
        "code": "string",
        "component": "string",
        "fields": {
          "key": 0
        },
        "lane": "string",
        "sequence": 0,
        "severity": "string"
      }
    ],
    "nextCursor": "eyJvIjoyMH0"
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

• dataobjectrequired

  • itemsarray of objectrequired

    • atstringrequired

      RFC 3339 UTC instant; empty when absent.

    • codestringrequired
    • componentstringrequired
    • fieldsobjectrequired
    • lanestringrequired
    • sequenceintegerrequired
    • severitystringrequired
  • nextCursorstringrequired
• scopeobjectrequired

  • serverIdstringrequired
  • viewerFencestringrequired

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired

{
  "data": {
    "audit": {
      "items": [
        {
          "action": "string",
          "actor": "string",
          "at": "2026-10-18T19:30:00Z",
          "hash": "string",
          "id": "id_8h2k4q",
          "previousHash": "string",
          "revision": 0,
          "sequence": 0,
          "target": "string"
        }
      ],
      "nextCursor": "eyJvIjoyMH0"
    },
    "auditAnchor": {
      "hash": "string",
      "sequence": 0
    },
    "client": {
      "items": [
        {
          "at": "2026-10-18T19:30:00Z",
          "code": "string",
          "component": "string",
          "fields": {},
          "lane": "string",
          "sequence": 0,
          "severity": "string"
        }
      ],
      "nextCursor": "eyJvIjoyMH0"
    },
    "expiresAt": "2026-10-18T19:30:00Z",
    "id": "id_8h2k4q",
    "manifest": {
      "excluded": [
        "string"
      ],
      "from": "string",
      "includePaths": true,
      "included": [
        "string"
      ],
      "maxBytes": 0,
      "pathCategories": [
        "library-configured-root"
      ],
      "pathsInvalidAmongExamined": 0,
      "pathsScanTruncated": true,
      "pathsTruncated": true,
      "redaction": "string",
      "to": "string",
      "version": "string"
    },
    "runtime": {
      "items": [
        {
          "at": "2026-10-18T19:30:00Z",
          "code": "string",
          "component": "string",
          "fields": {},
          "lane": "string",
          "sequence": 0,
          "severity": "string"
        }
      ],
      "nextCursor": "eyJvIjoyMH0"
    },
    "snapshot": {
      "build": {
        "buildId": "id_8h2k4q",
        "builtAt": "2026-10-18T19:30:00Z",
        "goVersion": "string",
        "sourceDigest": "string",
        "targetArch": "string",
        "targetOS": "string",
        "version": "string"
      },
      "database": "string",
      "hostedConfigured": true,
      "libraries": {
        "byState": {
          "key": 0
        },
        "total": 0
      },
      "mounts": {
        "available": true,
        "counts": {
          "byState": {},
          "total": 0
        }
      },
      "observedAt": "2026-10-18T19:30:00Z",
      "recentScanFailures": {
        "hasMore": true,
        "items": [
          {}
        ],
        "limit": 0
      },
      "scans": {
        "byState": {
          "key": 0
        },
        "total": 0
      },
      "schemaVersion": 0
    },
    "snapshotPaths": {
      "examined": 0,
      "hasMore": true,
      "invalidAmongExamined": 0,
      "items": [
        {
          "category": "library-configured-root",
          "reference": "string",
          "value": "string"
        }
      ],
      "limit": 0,
      "scanBudget": 0,
      "scanTruncated": true
    }
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

• dataobjectrequired

  • auditobject

    • itemsarray of objectrequired

      • actionstringrequired
      • actorstringrequired
      • atstringrequired

        RFC 3339 UTC instant; empty when absent.

      • hashstringrequired
      • idstringrequired
      • previousHashstringrequired
      • revisionintegerrequired
      • sequenceintegerrequired
      • targetstringrequired
    • nextCursorstringrequired
  • auditAnchorobject

    • hashstringrequired
    • sequenceintegerrequired
  • clientobject

    • itemsarray of objectrequired

      • atstringrequired

        RFC 3339 UTC instant; empty when absent.

      • codestringrequired
      • componentstringrequired
      • fieldsobjectrequired
      • lanestringrequired
      • sequenceintegerrequired
      • severitystringrequired
    • nextCursorstringrequired
  • expiresAtstringrequired

    RFC 3339 UTC instant; empty when absent.

  • idstringrequired
  • manifestobjectrequired

    • excludedarray of stringrequired
    • fromstringrequired

      RFC 3339 UTC instant; empty when absent.

    • includePathsboolean
    • includedarray of stringrequired
    • maxBytesintegerrequired
    • pathCategoriesarray of string
    • pathsInvalidAmongExaminedinteger
    • pathsScanTruncatedboolean
    • pathsTruncatedboolean
    • redactionstringrequired
    • tostringrequired

      RFC 3339 UTC instant; empty when absent.

    • versionstringrequired
  • runtimeobject

    • itemsarray of objectrequired

      • atstringrequired

        RFC 3339 UTC instant; empty when absent.

      • codestringrequired
      • componentstringrequired
      • fieldsobjectrequired
      • lanestringrequired
      • sequenceintegerrequired
      • severitystringrequired
    • nextCursorstringrequired
  • snapshotobject

    • buildobjectrequired

      • buildIdstring | any | nullrequired
      • builtAtstring | any | nullrequired
      • goVersionstring | any | nullrequired
      • sourceDigeststring | any | nullrequired
      • targetArchstringrequired
      • targetOSstringrequired
      • versionstring | any | nullrequired
    • databasestringrequired
    • hostedConfiguredbooleanrequired
    • librariesobjectrequired

      • byStateobjectrequired
      • totalintegerrequired
    • mountsobjectrequired

      • availablebooleanrequired
      • countsobject | any | nullrequired

        • byStateobjectrequired
        • totalintegerrequired
    • observedAtstringrequired
    • recentScanFailuresobjectrequired

      • hasMorebooleanrequired
      • itemsarray of objectrequired

        • codestringrequired
        • createdAtstring | any | nullrequired
        • finishedAtstring | any | nullrequired
        • processedinteger | any | nullrequired
        • updatedAtstring | any | nullrequired
      • limitintegerrequired
    • scansobjectrequired

      • byStateobjectrequired
      • totalintegerrequired
    • schemaVersionintegerrequired
  • snapshotPathsobject

    • examinedintegerrequired
    • hasMorebooleanrequired
    • invalidAmongExaminedintegerrequired
    • itemsarray of objectrequired

      • categorystringrequiredone of "library-configured-root", "library-resolved-root", "managed-mount-point"
      • referencestringrequired
      • valuestringrequired
    • limitintegerrequired
    • scanBudgetintegerrequired
    • scanTruncatedbooleanrequired
• scopeobjectrequired

  • serverIdstringrequired
  • viewerFencestringrequired

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired

{
  "data": [
    {
      "kind": "string",
      "lane": "string",
      "resourceRequired": true
    }
  ],
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

• dataarray of objectrequired

  • kindstringrequired
  • lanestringrequired
  • resourceRequiredbooleanrequired
• scopeobjectrequired

  • serverIdstringrequired
  • viewerFencestringrequired

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired

{
  "data": {
    "items": [
      {
        "actions": [
          "string"
        ],
        "attempt": 0,
        "createdAt": "2026-10-18T19:30:00Z",
        "domainId": "id_8h2k4q",
        "errorCode": "string",
        "id": "id_8h2k4q",
        "kind": "string",
        "lane": "string",
        "nextAt": "2026-10-18T19:30:00Z",
        "phase": "string",
        "predecessor": "string",
        "processed": 0,
        "resource": "string",
        "revision": 0,
        "settingsRevision": 0,
        "state": "string",
        "total": 0,
        "trigger": "string",
        "updatedAt": "2026-10-18T19:30:00Z"
      }
    ],
    "nextCursor": "eyJvIjoyMH0"
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

• dataobjectrequired

  • itemsarray of objectrequired

    • actionsarray of stringrequired
    • attemptintegerrequired
    • createdAtstringrequired

      RFC 3339 UTC instant; empty when absent.

    • domainIdstring
    • errorCodestring
    • idstringrequired
    • kindstringrequired
    • lanestringrequired
    • nextAtstringrequired

      RFC 3339 UTC instant; empty when absent.

    • phasestringrequired
    • predecessorstring
    • processedinteger
    • resourcestringrequired
    • revisionintegerrequired
    • settingsRevisionintegerrequired
    • statestringrequired
    • totalinteger
    • triggerstringrequired
    • updatedAtstringrequired

      RFC 3339 UTC instant; empty when absent.

  • nextCursorstringrequired
• scopeobjectrequired

  • serverIdstringrequired
  • viewerFencestringrequired

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired

{
  "data": {
    "facts": {
      "key": {
        "reason": "string",
        "state": "string",
        "unit": "string",
        "value": null
      }
    },
    "freshUntil": "string",
    "name": "Fargo",
    "observedAt": "2026-10-18T19:30:00Z"
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

• dataobjectrequired

  • factsobjectrequired

    • reasonstring
    • statestringrequired
    • unitstring
    • valueanyrequired
  • freshUntilstringrequired

    RFC 3339 UTC instant; empty when absent.

  • namestringrequired
  • observedAtstringrequired

    RFC 3339 UTC instant; empty when absent.

• scopeobjectrequired

  • serverIdstringrequired
  • viewerFencestringrequired

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired

{
  "data": [
    {
      "catchUp": true,
      "createdAt": "2026-10-18T19:30:00Z",
      "enabled": true,
      "id": "id_8h2k4q",
      "kind": "string",
      "lastSlot": "string",
      "resource": "string",
      "revision": 0,
      "startMinute": 0,
      "timezone": "2026-10-18T19:30:00Z",
      "windowMinutes": 0
    }
  ],
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

• dataarray of objectrequired

  • catchUpbooleanrequired
  • createdAtstringrequired

    RFC 3339 UTC instant; empty when absent.

  • enabledbooleanrequired
  • idstringrequired
  • kindstringrequired
  • lastSlotstringrequired
  • resourcestringrequired
  • revisionintegerrequired
  • startMinuteintegerrequired
  • timezonestringrequired
  • windowMinutesintegerrequired
• scopeobjectrequired

  • serverIdstringrequired
  • viewerFencestringrequired

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired

{
  "data": {
    "activeRevision": 0,
    "digest": "string",
    "effective": {
      "accessUrls": [
        "https://example.com/…"
      ],
      "advertiseUrl": "https://example.com/…",
      "advertisedInterface": "string",
      "analysisStageStorageMiB": 0,
      "analysisStorageGiB": 0,
      "apiRequestsPerMinute": 0,
      "connectionLimit": 0,
      "conversionMode": "string",
      "customCertificateDomain": "string",
      "customCertificateKeyPath": "string",
      "customCertificatePath": "string",
      "diagnosticDays": 0,
      "directStreamRemux": true,
      "dlnaEnabled": true,
      "downloadMaxQuality": "string",
      "ffmpegPath": "string",
      "hardwareBackend": "string",
      "hardwareDecode": true,
      "hardwareDevice": "string",
      "hardwareSelection": "string",
      "hdrToneMapping": true,
      "hdrToneMappingAlgorithm": "string",
      "home.communityActivityEnabled": true,
      "integrations.compatibilityEnabled": true,
      "jobDays": 0,
      "lanDiscoveryEnabled": true,
      "lanNetworks": [
        "string"
      ],
      "library.missingTitles": "Fargo",
      "library.missingTitlesDays": 0,
      "library.segmentDetection": "string",
      "logDetailMinutes": 15,
      "logLevel": "string",
      "logRetention": [
        {
          "category": "string",
          "days": 0
        }
      ],
      "maxBackgroundSessions": 0,
      "maxConcurrentSessions": 0,
      "maxHardwareSessions": 0,
      "maxSoftwareSessions": 0,
      "memoryCap": "string",
      "musicAwayQuality": "string",
      "name": "Fargo",
      "notificationDays": 0,
      "outputFormat": "2026-10-18T19:30:00Z",
      "ownAddressEnabled": true,
      "pausedSessionTimeoutMinutes": 0,
      "people.invitation_days": 1,
      "people.invitation_role": "member",
      "perAccountCap": 0,
      "planningPolicy": "string",
      "playHistoryDays": 0,
      "playedRetentionMs": 1800000,
      "recommendations.titleDataset": true,
      "remoteAccess": "string",
      "remoteBitrateLimitKbps": 0,
      "remoteSecurity": "string",
      "remoteSignInPolicy": "string",
      "secureConnections": "string",
      "segments.animeMode": "server",
      "segments.automaticConfidencePercent": 70,
      "segments.creditsWindow": "usual",
      "segments.filmCreditsWindow": "usual",
      "segments.introWindow": "usual",
      "segments.movieMode": "server",
      "segments.shortestEpisode": 1,
      "segments.shortestFilm": 5,
      "segments.tvMode": "server",
      "segments.useChapterNames": true,
      "segments.viewerConfidencePercent": 30,
      "serverCap": 0,
      "sessionStorageMiB": 0,
      "subtitleFileLimitMiB": 0,
      "subtitleTrackLimit": 0,
      "temporaryDirectory": "string",
      "throttleBufferMs": 1800000,
      "transcodeLocation": "string",
      "trustedProxies": [
        "string"
      ],
      "updates.feedUrl": "https://example.com/…",
      "updates.releaseChannel": "string",
      "uploadCapacityKbps": 0,
      "x264Preset": "string"
    },
    "ffmpegValidation": {
      "checkedAt": "2026-10-18T19:30:00Z",
      "inUse": true,
      "missingFeatures": [
        "string"
      ],
      "path": "string",
      "reasonCode": "string",
      "state": "string"
    },
    "registryRevision": "r12",
    "requested": {
      "accessUrls": [
        "https://example.com/…"
      ],
      "advertiseUrl": "https://example.com/…",
      "advertisedInterface": "string",
      "analysisStageStorageMiB": 0,
      "analysisStorageGiB": 0,
      "apiRequestsPerMinute": 0,
      "connectionLimit": 0,
      "conversionMode": "string",
      "customCertificateDomain": "string",
      "customCertificateKeyPath": "string",
      "customCertificatePath": "string",
      "diagnosticDays": 0,
      "directStreamRemux": true,
      "dlnaEnabled": true,
      "downloadMaxQuality": "string",
      "ffmpegPath": "string",
      "hardwareBackend": "string",
      "hardwareDecode": true,
      "hardwareDevice": "string",
      "hardwareSelection": "string",
      "hdrToneMapping": true,
      "hdrToneMappingAlgorithm": "string",
      "home.communityActivityEnabled": true,
      "integrations.compatibilityEnabled": true,
      "jobDays": 0,
      "lanDiscoveryEnabled": true,
      "lanNetworks": [
        "string"
      ],
      "library.missingTitles": "Fargo",
      "library.missingTitlesDays": 0,
      "library.segmentDetection": "string",
      "logDetailMinutes": 15,
      "logLevel": "string",
      "logRetention": [
        {
          "category": "string",
          "days": 0
        }
      ],
      "maxBackgroundSessions": 0,
      "maxConcurrentSessions": 0,
      "maxHardwareSessions": 0,
      "maxSoftwareSessions": 0,
      "memoryCap": "string",
      "musicAwayQuality": "string",
      "name": "Fargo",
      "notificationDays": 0,
      "outputFormat": "2026-10-18T19:30:00Z",
      "ownAddressEnabled": true,
      "pausedSessionTimeoutMinutes": 0,
      "people.invitation_days": 1,
      "people.invitation_role": "member",
      "perAccountCap": 0,
      "planningPolicy": "string",
      "playHistoryDays": 0,
      "playedRetentionMs": 1800000,
      "recommendations.titleDataset": true,
      "remoteAccess": "string",
      "remoteBitrateLimitKbps": 0,
      "remoteSecurity": "string",
      "remoteSignInPolicy": "string",
      "secureConnections": "string",
      "segments.animeMode": "server",
      "segments.automaticConfidencePercent": 70,
      "segments.creditsWindow": "usual",
      "segments.filmCreditsWindow": "usual",
      "segments.introWindow": "usual",
      "segments.movieMode": "server",
      "segments.shortestEpisode": 1,
      "segments.shortestFilm": 5,
      "segments.tvMode": "server",
      "segments.useChapterNames": true,
      "segments.viewerConfidencePercent": 30,
      "serverCap": 0,
      "sessionStorageMiB": 0,
      "subtitleFileLimitMiB": 0,
      "subtitleTrackLimit": 0,
      "temporaryDirectory": "string",
      "throttleBufferMs": 1800000,
      "transcodeLocation": "string",
      "trustedProxies": [
        "string"
      ],
      "updates.feedUrl": "https://example.com/…",
      "updates.releaseChannel": "string",
      "uploadCapacityKbps": 0,
      "x264Preset": "string"
    },
    "restartFields": [
      "string"
    ],
    "revision": 0
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

• dataobjectrequired

  • activeRevisionintegerrequired
  • digeststringrequired
  • effectiveobjectrequired

    • accessUrlsarray of stringrequired
    • advertiseUrlstringrequired
    • advertisedInterfacestringrequired
    • analysisStageStorageMiBintegerrequired
    • analysisStorageGiBintegerrequired
    • apiRequestsPerMinuteintegerrequired
    • connectionLimitintegerrequired
    • conversionModestringrequired
    • customCertificateDomainstringrequired
    • customCertificateKeyPathstringrequired
    • customCertificatePathstringrequired
    • diagnosticDaysintegerrequired
    • directStreamRemuxbooleanrequired
    • dlnaEnabledbooleanrequired
    • downloadMaxQualitystringrequired
    • ffmpegPathstringrequired
    • hardwareBackendstringrequired
    • hardwareDecodebooleanrequired
    • hardwareDevicestringrequired
    • hardwareSelectionstringrequired
    • hdrToneMappingbooleanrequired
    • hdrToneMappingAlgorithmstringrequired
    • home.communityActivityEnabledbooleanrequired
    • integrations.compatibilityEnabledbooleanrequired
    • jobDaysintegerrequired
    • lanDiscoveryEnabledbooleanrequired
    • lanNetworksarray of stringrequired
    • library.missingTitlesstringrequired
    • library.missingTitlesDaysintegerrequired
    • library.segmentDetectionstringrequired
    • logDetailMinutesintegerone of 15, 30, 60, 120, 240
    • logLevelstringrequired
    • logRetentionarray of objectrequired

      • categorystringrequired
      • daysintegerrequired
    • maxBackgroundSessionsintegerrequired
    • maxConcurrentSessionsintegerrequired
    • maxHardwareSessionsintegerrequired
    • maxSoftwareSessionsintegerrequired
    • memoryCapstringrequired
    • musicAwayQualitystringrequired
    • namestringrequired
    • notificationDaysintegerrequired
    • outputFormatstringrequired
    • ownAddressEnabledbooleanrequired
    • pausedSessionTimeoutMinutesintegerrequired
    • people.invitation_daysintegerone of 1, 3, 7, 301–30
    • people.invitation_rolestringone of "member", "administrator"
    • perAccountCapinteger | any | nullrequired
    • planningPolicystringrequired
    • playHistoryDaysintegerrequired
    • playedRetentionMsintegerrequired
    • recommendations.titleDatasetbooleanrequired
    • remoteAccessstringrequired
    • remoteBitrateLimitKbpsintegerrequired
    • remoteSecuritystringrequired
    • remoteSignInPolicystringrequired
    • secureConnectionsstringrequired
    • segments.animeModestringone of "server", "standard", "thorough", "off"
    • segments.automaticConfidencePercentintegerone of 70, 85, 95
    • segments.creditsWindowstringone of "usual", "long"
    • segments.filmCreditsWindowstringone of "usual", "long"
    • segments.introWindowstringone of "usual", "long"
    • segments.movieModestringone of "server", "standard", "thorough", "off"
    • segments.shortestEpisodeintegerone of 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30
    • segments.shortestFilmintegerone of 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60
    • segments.tvModestringone of "server", "standard", "thorough", "off"
    • segments.useChapterNamesboolean
    • segments.viewerConfidencePercentintegerone of 30, 50, 70
    • serverCapinteger | any | nullrequired
    • sessionStorageMiBintegerrequired
    • subtitleFileLimitMiBintegerrequired
    • subtitleTrackLimitintegerrequired
    • temporaryDirectorystringrequired
    • throttleBufferMsintegerrequired
    • transcodeLocationstringrequired
    • trustedProxiesarray of stringrequired
    • updates.feedUrlstringrequired
    • updates.releaseChannelstringrequired
    • uploadCapacityKbpsintegerrequired
    • x264Presetstringrequired
  • ffmpegValidationobject

    • checkedAtstringrequired
    • inUsebooleanrequired
    • missingFeaturesarray of stringrequired
    • pathstringrequired
    • reasonCodestring
    • statestringrequired
  • registryRevisionstringrequired
  • requestedobjectrequired

    • accessUrlsarray of stringrequired
    • advertiseUrlstringrequired
    • advertisedInterfacestringrequired
    • analysisStageStorageMiBintegerrequired
    • analysisStorageGiBintegerrequired
    • apiRequestsPerMinuteintegerrequired
    • connectionLimitintegerrequired
    • conversionModestringrequired
    • customCertificateDomainstringrequired
    • customCertificateKeyPathstringrequired
    • customCertificatePathstringrequired
    • diagnosticDaysintegerrequired
    • directStreamRemuxbooleanrequired
    • dlnaEnabledbooleanrequired
    • downloadMaxQualitystringrequired
    • ffmpegPathstringrequired
    • hardwareBackendstringrequired
    • hardwareDecodebooleanrequired
    • hardwareDevicestringrequired
    • hardwareSelectionstringrequired
    • hdrToneMappingbooleanrequired
    • hdrToneMappingAlgorithmstringrequired
    • home.communityActivityEnabledbooleanrequired
    • integrations.compatibilityEnabledbooleanrequired
    • jobDaysintegerrequired
    • lanDiscoveryEnabledbooleanrequired
    • lanNetworksarray of stringrequired
    • library.missingTitlesstringrequired
    • library.missingTitlesDaysintegerrequired
    • library.segmentDetectionstringrequired
    • logDetailMinutesintegerone of 15, 30, 60, 120, 240
    • logLevelstringrequired
    • logRetentionarray of objectrequired

      • categorystringrequired
      • daysintegerrequired
    • maxBackgroundSessionsintegerrequired
    • maxConcurrentSessionsintegerrequired
    • maxHardwareSessionsintegerrequired
    • maxSoftwareSessionsintegerrequired
    • memoryCapstringrequired
    • musicAwayQualitystringrequired
    • namestringrequired
    • notificationDaysintegerrequired
    • outputFormatstringrequired
    • ownAddressEnabledbooleanrequired
    • pausedSessionTimeoutMinutesintegerrequired
    • people.invitation_daysintegerone of 1, 3, 7, 301–30
    • people.invitation_rolestringone of "member", "administrator"
    • perAccountCapinteger | any | nullrequired
    • planningPolicystringrequired
    • playHistoryDaysintegerrequired
    • playedRetentionMsintegerrequired
    • recommendations.titleDatasetbooleanrequired
    • remoteAccessstringrequired
    • remoteBitrateLimitKbpsintegerrequired
    • remoteSecuritystringrequired
    • remoteSignInPolicystringrequired
    • secureConnectionsstringrequired
    • segments.animeModestringone of "server", "standard", "thorough", "off"
    • segments.automaticConfidencePercentintegerone of 70, 85, 95
    • segments.creditsWindowstringone of "usual", "long"
    • segments.filmCreditsWindowstringone of "usual", "long"
    • segments.introWindowstringone of "usual", "long"
    • segments.movieModestringone of "server", "standard", "thorough", "off"
    • segments.shortestEpisodeintegerone of 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30
    • segments.shortestFilmintegerone of 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60
    • segments.tvModestringone of "server", "standard", "thorough", "off"
    • segments.useChapterNamesboolean
    • segments.viewerConfidencePercentintegerone of 30, 50, 70
    • serverCapinteger | any | nullrequired
    • sessionStorageMiBintegerrequired
    • subtitleFileLimitMiBintegerrequired
    • subtitleTrackLimitintegerrequired
    • temporaryDirectorystringrequired
    • throttleBufferMsintegerrequired
    • transcodeLocationstringrequired
    • trustedProxiesarray of stringrequired
    • updates.feedUrlstringrequired
    • updates.releaseChannelstringrequired
    • uploadCapacityKbpsintegerrequired
    • x264Presetstringrequired
  • restartFieldsarray of stringrequired
  • revisionintegerrequired
• scopeobjectrequired

  • serverIdstringrequired
  • viewerFencestringrequired

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired

{
  "data": {
    "libraries": [
      {
        "id": "id_8h2k4q",
        "label": "string"
      }
    ],
    "viewers": [
      {
        "id": "id_8h2k4q",
        "label": "string"
      }
    ]
  },
  "scope": {
    "serverId": "id_8h2k4q",
    "viewerFence": "string"
  }
}

• dataobjectrequired

  • librariesarray of objectrequired

    • idstringrequired
    • labelstringrequired
  • viewersarray of objectrequired

    • idstringrequired
    • labelstringrequired
• scopeobjectrequired

  • serverIdstringrequired
  • viewerFencestringrequired

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

• errorobjectrequired

  • codestringrequired
  • messagestringrequired