Zum Inhalt springen
Nexview
Bereich

Betrieb

23 Adressen. Ohne Zusage — sie gehören zum Innenteil der Anwendung und können sich mit jeder Fassung ändern. Wer sich auf etwas verlassen muss, nimmt die zugesagten dreizehn.

23 Adressen

GET /api/about may change

Version and build

Which version of Nexview this is, and whether a newer one is known. Useful for telling deployments apart and for deciding whether a feature you rely on exists yet.

Felder und Aufbau

Antwort

FeldArt
versionText Pflicht
repo_urlText Pflicht
release_urlText Pflicht
licenseText
update_checkedja/nein
latest_versionText oder null
update_availableja/nein
checked_atZeitpunkt (ISO 8601) oder null

Aufbau der Antwort

{
  "version": "string",
  "repo_url": "string",
  "release_url": "string",
  "license": "string",
  "update_checked": "boolean",
  "latest_version": "string | null",
  "update_available": "boolean",
  "checked_at": "ISO 8601 | null"
}

POST /api/about/check may change

Check for updates now

Looks for a newer release immediately instead of waiting for the daily check.

Felder und Aufbau

Antwort

FeldArt
versionText Pflicht
repo_urlText Pflicht
release_urlText Pflicht
licenseText
update_checkedja/nein
latest_versionText oder null
update_availableja/nein
checked_atZeitpunkt (ISO 8601) oder null

Aufbau der Antwort

{
  "version": "string",
  "repo_url": "string",
  "release_url": "string",
  "license": "string",
  "update_checked": "boolean",
  "latest_version": "string | null",
  "update_available": "boolean",
  "checked_at": "ISO 8601 | null"
}

GET /api/about/neuigkeiten may change

Is there something new to read

Whether this installation has been updated since the administrator last acknowledged the release notes, and to which version.

Felder und Aufbau

Antwort

FeldArt
versionText Pflicht
offenja/nein Pflicht
zuletzt_gesehenText oder null

Aufbau der Antwort

{
  "version": "string",
  "offen": "boolean",
  "zuletzt_gesehen": "string | null"
}

POST /api/about/neuigkeiten/gesehen may change

Acknowledge the release notes

"Understood, stop showing this" - until the next update. What is stored is the version, not a tick, so the banner comes back by itself after the next release that has something to say.

Felder und Aufbau

Antwort

FeldArt
versionText Pflicht
offenja/nein Pflicht
zuletzt_gesehenText oder null

Aufbau der Antwort

{
  "version": "string",
  "offen": "boolean",
  "zuletzt_gesehen": "string | null"
}

GET /api/config may change

Public configuration

What the interface needs to know before anybody signs in: which media-server providers exist, whether watchlists are enabled, the minimum password length, the default region.

Felder und Aufbau

Antwort

FeldArt
default_regionText Pflicht
default_languageText Pflicht
tmdb_configuredja/nein Pflicht
radarr_configuredja/nein Pflicht
sonarr_configuredja/nein Pflicht
using_demo_dataja/nein Pflicht
min_password_lengthZahl Pflicht
mail_configuredja/nein Pflicht
public_url_setja/nein Pflicht
approver_picks_target_movieja/nein Pflicht
approver_picks_target_tvja/nein Pflicht
radarr_uhd_configuredja/nein Pflicht
sonarr_uhd_configuredja/nein Pflicht
mediaserver_configuredja/nein Pflicht
mediaserver_providersListe von Text Pflicht
mediaserver_availableListe von Text Pflicht
mediaserver_password_loginListe von Text Pflicht
mediaserver_watchlist_availableListe von Text Pflicht
mediaserver_watchlist_connectedListe von Text Pflicht
watchlist_enabledja/nein Pflicht

Aufbau der Antwort

{
  "default_region": "string",
  "default_language": "string",
  "tmdb_configured": "boolean",
  "radarr_configured": "boolean",
  "sonarr_configured": "boolean",
  "using_demo_data": "boolean",
  "min_password_length": "number",
  "mail_configured": "boolean",
  "public_url_set": "boolean",
  "approver_picks_target_movie": "boolean",
  "approver_picks_target_tv": "boolean",
  "radarr_uhd_configured": "boolean",
  "sonarr_uhd_configured": "boolean",
  "mediaserver_configured": "boolean"
}

GET /api/config/regions may change

Selectable regions

The countries somebody can pick as their region. Deliberately fetched from TMDB rather than kept in the source: a fixed list goes stale and silently limits who can use this.

Felder und Aufbau

Antwort

FeldArt
codeText Pflicht
nameText Pflicht

Aufbau der Antwort

[
  {
    "code": "string",
    "name": "string"
  }
]

GET /api/health may change

Is Nexview running

Answers without a token - a monitor that has to sign in first is not a monitor. Returns nothing but a status, on purpose: no version, no database state, nothing that would tell an unauthenticated caller about the installation.

DELETE /api/logs may change

Clear the log

Empties the log file. What is gone is gone; there is no second copy.

GET /api/logs may change

The most recent log lines

level means "this level and above". Administrators only - log lines name accounts and addresses.

Felder und Aufbau

Parameter

levelDEBUG | INFO | WARNING | ERROR | CRITICAL oder null query
searchText oder null query
limitZahl query

Antwort

FeldArt
timeText Pflicht
levelText Pflicht
loggerText Pflicht
messageText Pflicht
request_idText oder null
userText oder null

Aufbau der Antwort

[
  {
    "time": "string",
    "level": "string",
    "logger": "string",
    "message": "string",
    "request_id": "string | null",
    "user": "string | null"
  }
]

GET /api/logs/level may change

Current log level

Which level is being written, and until when - the more talkative levels switch themselves off again.

Felder und Aufbau

Antwort

FeldArt
modeText Pflicht
untilText oder null
fixed_by_envja/nein
modesListe von Text
durationsListe von Zahl

Aufbau der Antwort

{
  "mode": "string",
  "until": "string | null",
  "fixed_by_env": "boolean",
  "modes": [
    "string"
  ],
  "durations": [
    "number"
  ]
}

PUT /api/logs/level may change

Change the log level

Takes effect immediately, without a restart. The talkative levels carry an expiry so a debugging session cannot quietly fill the disk for weeks.

Felder und Aufbau

Anfragekörper

FeldArt
modequiet | normal | detailed | trace Pflicht
minutesZahl

Antwort

FeldArt
modeText Pflicht
untilText oder null
fixed_by_envja/nein
modesListe von Text
durationsListe von Zahl

Aufbau der Antwort

{
  "mode": "string",
  "until": "string | null",
  "fixed_by_env": "boolean",
  "modes": [
    "string"
  ],
  "durations": [
    "number"
  ]
}

GET /api/settings may change

All settings

The whole configuration of this installation. Secrets come back masked, never in the clear. Administrators only.

PUT /api/settings may change

Change settings

⚠️ An empty secret field means "unchanged", not "delete". Otherwise the masked value from the interface would be written back over the real one. Use the delete endpoint to actually remove a key.

Felder und Aufbau

Anfragekörper

FeldArt
tmdb_api_keyText oder null
radarr_urlText oder null
radarr_api_keyText oder null
sonarr_urlText oder null
sonarr_api_keyText oder null
default_regionText oder null
default_languageText oder null
poll_interval_secondsZahl oder null
demo_modeText oder null
default_movie_profile_idText oder null
default_series_profile_idText oder null
movie_root_folder_modeText oder null
series_root_folder_modeText oder null
movie_profile_modeText oder null
series_profile_modeText oder null
default_movie_rootText oder null
default_series_rootText oder null
radarr_uhd_urlText oder null
radarr_uhd_api_keyText oder null
sonarr_uhd_urlText oder null
sonarr_uhd_api_keyText oder null
default_movie_uhd_profile_idText oder null
default_series_uhd_profile_idText oder null
default_movie_uhd_rootText oder null
default_series_uhd_rootText oder null
smtp_hostText oder null
smtp_portZahl oder null
smtp_securityText oder null
smtp_usernameText oder null
smtp_passwordText oder null
smtp_from_addressText oder null
smtp_from_nameText oder null
public_urlText oder null
update_checkja/nein oder null
backup_scheduleoff | daily | weekly | monthly oder null
backup_keepZahl oder null
mediaserver_auto_importja/nein oder null
mediaserver_default_roleText oder null
watchlist_enabledja/nein oder null
quota_default_moviesZahl oder null
quota_default_seriesZahl oder null
storage_default_limit_gbZahl oder null
quota_periodday | week | month oder null

GET /api/settings/recyclebin may change

Where deleted files go

The recycle-bin path configured in every Radarr and Sonarr instance. Fetched fresh on every call and stored nowhere - it lives over there, and a copy here would go stale without anybody noticing.

Felder und Aufbau

Antwort

FeldArt
enabledja/nein Pflicht
completeja/nein Pflicht
instancesListe von PapierkorbInstanz Pflicht

Aufbau der Antwort

{
  "enabled": "boolean",
  "complete": "boolean",
  "instances": [
    {
      "media_type": "string",
      "tier": "string",
      "name": "string",
      "reachable": "boolean",
      "path": "string",
      "cleanup_days": "number | null",
      "protected": "boolean"
    }
  ]
}

PUT /api/settings/recyclebin may change

Set the recycle-bin path

⚠️ This writes into Radarr and Sonarr, not into Nexview. The setting applies over there to everything, including deletions that had nothing to do with Nexview.

Felder und Aufbau

Anfragekörper

FeldArt
instancesListe von PapierkorbWunsch Pflicht
cleanup_daysZahl

Antwort

FeldArt
enabledja/nein Pflicht
completeja/nein Pflicht
instancesListe von PapierkorbInstanz Pflicht

Aufbau der Antwort

{
  "enabled": "boolean",
  "complete": "boolean",
  "instances": [
    {
      "media_type": "string",
      "tier": "string",
      "name": "string",
      "reachable": "boolean",
      "path": "string",
      "cleanup_days": "number | null",
      "protected": "boolean"
    }
  ]
}

GET /api/settings/recyclebin/contents may change

What is in the recycle bins

Folder names only - no posters, no tidied-up titles. Resolving the names back to titles would mean a TMDB lookup per folder for something that is, in the end, a list of directories.

Felder und Aufbau

Parameter

media_typemovie | tv oder null query
tierstandard | uhd oder null query
pathText query

Antwort

FeldArt
instancesListe von PapierkorbInhaltInstanz Pflicht

Aufbau der Antwort

{
  "instances": [
    {
      "name": "string",
      "path": "string",
      "entries": [
        "string"
      ],
      "truncated": "boolean"
    }
  ]
}

GET /api/settings/recyclebin/folders may change

Which folders one instance sees

Asked per instance rather than once for all: Sonarr can be mounted entirely differently from Radarr, and a path that exists for one may not exist for the other.

Felder und Aufbau

Parameter

media_typemovie | tv query Pflicht
tierstandard | uhd query
pathText query

Antwort

FeldArt
pathText Pflicht
directoriesListe von Text Pflicht

Aufbau der Antwort

{
  "path": "string",
  "directories": [
    "string"
  ]
}

DELETE /api/settings/secret/{name} may change

Remove a stored secret

The explicit way to delete an API key, because an empty field on save means "unchanged".

Felder und Aufbau

Parameter

nametmdb_api_key | radarr_api_key | radarr_uhd_api_key | sonarr_api_key | sonarr_uhd_api_key | smtp_password | mediaserver_token path Pflicht

POST /api/settings/test-mail may change

Send a test mail

Sends a fully formatted test message to the given address, so the result shows what a real notification will look like.

Felder und Aufbau

Anfragekörper

FeldArt
recipientText Pflicht

Antwort

FeldArt
okja/nein Pflicht
messageText Pflicht

Aufbau der Antwort

{
  "ok": "boolean",
  "message": "string"
}

POST /api/settings/test/public-url may change

Is Nexview reachable at this address

The server calls itself from the outside to find out. Deliberately with its own short-lived client, so nothing from the normal connection pool can make an unreachable address look reachable.

Felder und Aufbau

Anfragekörper

FeldArt
urlText Pflicht

Antwort

FeldArt
okja/nein Pflicht
messageText Pflicht

Aufbau der Antwort

{
  "ok": "boolean",
  "message": "string"
}

POST /api/settings/test/smtp may change

Test the mail server

Checks connection and authentication without sending anything.

Felder und Aufbau

Anfragekörper

FeldArt
hostText oder null
portZahl oder null
securityText oder null
usernameText oder null
passwordText oder null

Antwort

FeldArt
okja/nein Pflicht
messageText Pflicht

Aufbau der Antwort

{
  "ok": "boolean",
  "message": "string"
}

POST /api/settings/test/tmdb may change

Test the TMDB key

Checks whether the given TMDB API key works.

Felder und Aufbau

Anfragekörper

FeldArt
api_keyText oder null
urlText oder null

Antwort

FeldArt
okja/nein Pflicht
messageText Pflicht

Aufbau der Antwort

{
  "ok": "boolean",
  "message": "string"
}

POST /api/settings/test/{service} may change

Test Radarr or Sonarr

Checks the connection to the standard or 4K instance. Uses the values passed in if they have not been saved yet, so a connection can be tested before it is stored.

Felder und Aufbau

Parameter

serviceradarr | sonarr | radarr_uhd | sonarr_uhd path Pflicht

Anfragekörper

FeldArt
api_keyText oder null
urlText oder null

Antwort

FeldArt
okja/nein Pflicht
messageText Pflicht

Aufbau der Antwort

{
  "ok": "boolean",
  "message": "string"
}

Nexview nutzt TMDB als Datenquelle, stammt aber nicht von TMDB und wird von TMDB nicht unterstützt. Die Bildschirmfotos stammen aus einer Testinstallation; die darin gezeigten Konten und Anfragen sind erfunden.

Nexview steht unter der AGPL-3.0-Lizenz. Radarr, Sonarr, Plex, Docker, Synology, IMDb, Rotten Tomatoes, Metacritic und JustWatch sind Marken der jeweiligen Rechteinhaber und werden hier ausschließlich beschreibend genannt. Ein Teil der Symbole auf dieser Seite beruht auf Lucide (ISC-Lizenz) — Rechte teils bei Cole Bemis 2013–2022 als Bestandteil von Feather (MIT-Lizenz), im Übrigen bei den Lucide-Mitwirkenden ab 2022.