API: Konten und Anmeldung

POST /api/auth/login may change

Sign in

Exchanges username or e-mail and password for an access token. The refresh token comes back as an HttpOnly cookie rather than in the body, so no script in the page can read it. Repeated failures slow the endpoint down deliberately.

Felder und Aufbau

Anfragekörper

FeldArt

usernameText Pflicht

passwordText Pflicht

Antwort

FeldArt

access_tokenText Pflicht

token_typeText

expires_inZahl Pflicht

Aufbau der Antwort

{
  "access_token": "string",
  "token_type": "string",
  "expires_in": "number"
}

POST /api/auth/logout may change

Sign out of this browser

Clears the cookie. Without an authentication check, on purpose: anyone who wants to sign out should be able to, even if their access token expired long ago. Note this ends the session in this browser only - to end them everywhere, see the sign-out-everywhere endpoint.

GET /api/auth/me may change

Your own account

Everything the calling account knows about itself: name, role, language, theme, quota settings and linked media-server accounts.

Felder und Aufbau

Antwort

FeldArt

idZahl Pflicht

usernameText Pflicht

roleadmin | approver | user | child Pflicht

display_nameText oder null Pflicht

emailText oder null Pflicht

email_verifiedja/nein Pflicht

languageText Pflicht

themeText Pflicht

is_activeja/nein Pflicht

auto_approveja/nein Pflicht

auto_approve_moviesja/nein oder null Pflicht

auto_approve_seriesja/nein oder null Pflicht

effective_auto_approveja/nein Pflicht

effective_auto_approve_moviesja/nein Pflicht

effective_auto_approve_seriesja/nein Pflicht

can_approveja/nein Pflicht

quota_movies_limitZahl Pflicht

quota_series_limitZahl Pflicht

storage_limit_gbZahl

quota_reset_atZeitpunkt (ISO 8601) oder null Pflicht

blocked_movie_profilesListe von Zahl Pflicht

blocked_series_profilesListe von Zahl Pflicht

can_request_uhd_moviesja/nein Pflicht

can_request_uhd_seriesja/nein Pflicht

auto_approve_uhdja/nein Pflicht

effective_auto_approve_uhdja/nein Pflicht

blocked_movie_uhd_profilesListe von Zahl Pflicht

blocked_series_uhd_profilesListe von Zahl Pflicht

avatar_urlText oder null Pflicht

created_atZeitpunkt (ISO 8601) Pflicht

last_login_atZeitpunkt (ISO 8601) oder null Pflicht

mail_download_completeja/nein Pflicht

mail_request_pendingja/nein Pflicht

mail_request_decidedja/nein Pflicht

mail_feedbackja/nein Pflicht

mail_ticketja/nein Pflicht

mail_watchja/nein Pflicht

mail_user_importedja/nein Pflicht

mail_mediaserver_reconnectja/nein Pflicht

mail_storageja/nein Pflicht

mail_child_wishja/nein Pflicht

mail_cleanupja/nein Pflicht

watchlist_connectedja/nein Pflicht

watchlist_token_invalidja/nein

mediaserver_providerText oder null Pflicht

mediaserver_usernameText oder null Pflicht

mediaserver_linkedja/nein Pflicht

mediaserver_accountsListe von VerknuepftesKonto

has_passwordja/nein Pflicht

discover_regionText oder null Pflicht

ageZahl oder null Pflicht

rating_regionText oder null Pflicht

hide_unratedja/nein Pflicht

can_manage_childrenja/nein

parent_idZahl oder null

Aufbau der Antwort

{
  "id": "number",
  "username": "string",
  "role": "admin | approver | user | child",
  "display_name": "string | null",
  "email": "string | null",
  "email_verified": "boolean",
  "language": "string",
  "theme": "string",
  "is_active": "boolean",
  "auto_approve": "boolean",
  "auto_approve_movies": "boolean | null",
  "auto_approve_series": "boolean | null",
  "effective_auto_approve": "boolean",
  "effective_auto_approve_movies": "boolean"
}

PATCH /api/auth/me may change

Change your own account

Display name, language, region, theme and notification preferences. The username is not among them: it appears in requests, approvals and the Radarr/Sonarr labels, and changing it afterwards would tear those traces apart.

Felder und Aufbau

Anfragekörper

FeldArt

display_nameText oder null

languageText oder null

themeText oder null

mail_download_completeja/nein oder null

mail_request_pendingja/nein oder null

mail_request_decidedja/nein oder null

mail_feedbackja/nein oder null

mail_ticketja/nein oder null

mail_watchja/nein oder null

mail_user_importedja/nein oder null

mail_mediaserver_reconnectja/nein oder null

mail_storageja/nein oder null

mail_child_wishja/nein oder null

mail_cleanupja/nein oder null

discover_regionText oder null

Antwort

FeldArt

idZahl Pflicht

usernameText Pflicht

roleadmin | approver | user | child Pflicht

display_nameText oder null Pflicht

emailText oder null Pflicht

email_verifiedja/nein Pflicht

languageText Pflicht

themeText Pflicht

is_activeja/nein Pflicht

auto_approveja/nein Pflicht

auto_approve_moviesja/nein oder null Pflicht

auto_approve_seriesja/nein oder null Pflicht

effective_auto_approveja/nein Pflicht

effective_auto_approve_moviesja/nein Pflicht

effective_auto_approve_seriesja/nein Pflicht

can_approveja/nein Pflicht

quota_movies_limitZahl Pflicht

quota_series_limitZahl Pflicht

storage_limit_gbZahl

quota_reset_atZeitpunkt (ISO 8601) oder null Pflicht

blocked_movie_profilesListe von Zahl Pflicht

blocked_series_profilesListe von Zahl Pflicht

can_request_uhd_moviesja/nein Pflicht

can_request_uhd_seriesja/nein Pflicht

auto_approve_uhdja/nein Pflicht

effective_auto_approve_uhdja/nein Pflicht

blocked_movie_uhd_profilesListe von Zahl Pflicht

blocked_series_uhd_profilesListe von Zahl Pflicht

avatar_urlText oder null Pflicht

created_atZeitpunkt (ISO 8601) Pflicht

last_login_atZeitpunkt (ISO 8601) oder null Pflicht

mail_download_completeja/nein Pflicht

mail_request_pendingja/nein Pflicht

mail_request_decidedja/nein Pflicht

mail_feedbackja/nein Pflicht

mail_ticketja/nein Pflicht

mail_watchja/nein Pflicht

mail_user_importedja/nein Pflicht

mail_mediaserver_reconnectja/nein Pflicht

mail_storageja/nein Pflicht

mail_child_wishja/nein Pflicht

mail_cleanupja/nein Pflicht

watchlist_connectedja/nein Pflicht

watchlist_token_invalidja/nein

mediaserver_providerText oder null Pflicht

mediaserver_usernameText oder null Pflicht

mediaserver_linkedja/nein Pflicht

mediaserver_accountsListe von VerknuepftesKonto

has_passwordja/nein Pflicht

discover_regionText oder null Pflicht

ageZahl oder null Pflicht

rating_regionText oder null Pflicht

hide_unratedja/nein Pflicht

can_manage_childrenja/nein

parent_idZahl oder null

Aufbau der Antwort

{
  "id": "number",
  "username": "string",
  "role": "admin | approver | user | child",
  "display_name": "string | null",
  "email": "string | null",
  "email_verified": "boolean",
  "language": "string",
  "theme": "string",
  "is_active": "boolean",
  "auto_approve": "boolean",
  "auto_approve_movies": "boolean | null",
  "auto_approve_series": "boolean | null",
  "effective_auto_approve": "boolean",
  "effective_auto_approve_movies": "boolean"
}

DELETE /api/auth/me/avatar may change

Remove your profile picture

Deletes the picture file and falls back to the generated initials.

Felder und Aufbau

Antwort

FeldArt

idZahl Pflicht

usernameText Pflicht

roleadmin | approver | user | child Pflicht

display_nameText oder null Pflicht

emailText oder null Pflicht

email_verifiedja/nein Pflicht

languageText Pflicht

themeText Pflicht

is_activeja/nein Pflicht

auto_approveja/nein Pflicht

auto_approve_moviesja/nein oder null Pflicht

auto_approve_seriesja/nein oder null Pflicht

effective_auto_approveja/nein Pflicht

effective_auto_approve_moviesja/nein Pflicht

effective_auto_approve_seriesja/nein Pflicht

can_approveja/nein Pflicht

quota_movies_limitZahl Pflicht

quota_series_limitZahl Pflicht

storage_limit_gbZahl

quota_reset_atZeitpunkt (ISO 8601) oder null Pflicht

blocked_movie_profilesListe von Zahl Pflicht

blocked_series_profilesListe von Zahl Pflicht

can_request_uhd_moviesja/nein Pflicht

can_request_uhd_seriesja/nein Pflicht

auto_approve_uhdja/nein Pflicht

effective_auto_approve_uhdja/nein Pflicht

blocked_movie_uhd_profilesListe von Zahl Pflicht

blocked_series_uhd_profilesListe von Zahl Pflicht

avatar_urlText oder null Pflicht

created_atZeitpunkt (ISO 8601) Pflicht

last_login_atZeitpunkt (ISO 8601) oder null Pflicht

mail_download_completeja/nein Pflicht

mail_request_pendingja/nein Pflicht

mail_request_decidedja/nein Pflicht

mail_feedbackja/nein Pflicht

mail_ticketja/nein Pflicht

mail_watchja/nein Pflicht

mail_user_importedja/nein Pflicht

mail_mediaserver_reconnectja/nein Pflicht

mail_storageja/nein Pflicht

mail_child_wishja/nein Pflicht

mail_cleanupja/nein Pflicht

watchlist_connectedja/nein Pflicht

watchlist_token_invalidja/nein

mediaserver_providerText oder null Pflicht

mediaserver_usernameText oder null Pflicht

mediaserver_linkedja/nein Pflicht

mediaserver_accountsListe von VerknuepftesKonto

has_passwordja/nein Pflicht

discover_regionText oder null Pflicht

ageZahl oder null Pflicht

rating_regionText oder null Pflicht

hide_unratedja/nein Pflicht

can_manage_childrenja/nein

parent_idZahl oder null

Aufbau der Antwort

{
  "id": "number",
  "username": "string",
  "role": "admin | approver | user | child",
  "display_name": "string | null",
  "email": "string | null",
  "email_verified": "boolean",
  "language": "string",
  "theme": "string",
  "is_active": "boolean",
  "auto_approve": "boolean",
  "auto_approve_movies": "boolean | null",
  "auto_approve_series": "boolean | null",
  "effective_auto_approve": "boolean",
  "effective_auto_approve_movies": "boolean"
}

POST /api/auth/me/avatar may change

Upload a profile picture

Accepts PNG, JPEG, GIF and WebP. The image is scaled down and re-encoded on the server, so what ends up stored is not the file that was sent.

Felder und Aufbau

Antwort

FeldArt

idZahl Pflicht

usernameText Pflicht

roleadmin | approver | user | child Pflicht

display_nameText oder null Pflicht

emailText oder null Pflicht

email_verifiedja/nein Pflicht

languageText Pflicht

themeText Pflicht

is_activeja/nein Pflicht

auto_approveja/nein Pflicht

auto_approve_moviesja/nein oder null Pflicht

auto_approve_seriesja/nein oder null Pflicht

effective_auto_approveja/nein Pflicht

effective_auto_approve_moviesja/nein Pflicht

effective_auto_approve_seriesja/nein Pflicht

can_approveja/nein Pflicht

quota_movies_limitZahl Pflicht

quota_series_limitZahl Pflicht

storage_limit_gbZahl

quota_reset_atZeitpunkt (ISO 8601) oder null Pflicht

blocked_movie_profilesListe von Zahl Pflicht

blocked_series_profilesListe von Zahl Pflicht

can_request_uhd_moviesja/nein Pflicht

can_request_uhd_seriesja/nein Pflicht

auto_approve_uhdja/nein Pflicht

effective_auto_approve_uhdja/nein Pflicht

blocked_movie_uhd_profilesListe von Zahl Pflicht

blocked_series_uhd_profilesListe von Zahl Pflicht

avatar_urlText oder null Pflicht

created_atZeitpunkt (ISO 8601) Pflicht

last_login_atZeitpunkt (ISO 8601) oder null Pflicht

mail_download_completeja/nein Pflicht

mail_request_pendingja/nein Pflicht

mail_request_decidedja/nein Pflicht

mail_feedbackja/nein Pflicht

mail_ticketja/nein Pflicht

mail_watchja/nein Pflicht

mail_user_importedja/nein Pflicht

mail_mediaserver_reconnectja/nein Pflicht

mail_storageja/nein Pflicht

mail_child_wishja/nein Pflicht

mail_cleanupja/nein Pflicht

watchlist_connectedja/nein Pflicht

watchlist_token_invalidja/nein

mediaserver_providerText oder null Pflicht

mediaserver_usernameText oder null Pflicht

mediaserver_linkedja/nein Pflicht

mediaserver_accountsListe von VerknuepftesKonto

has_passwordja/nein Pflicht

discover_regionText oder null Pflicht

ageZahl oder null Pflicht

rating_regionText oder null Pflicht

hide_unratedja/nein Pflicht

can_manage_childrenja/nein

parent_idZahl oder null

Aufbau der Antwort

{
  "id": "number",
  "username": "string",
  "role": "admin | approver | user | child",
  "display_name": "string | null",
  "email": "string | null",
  "email_verified": "boolean",
  "language": "string",
  "theme": "string",
  "is_active": "boolean",
  "auto_approve": "boolean",
  "auto_approve_movies": "boolean | null",
  "auto_approve_series": "boolean | null",
  "effective_auto_approve": "boolean",
  "effective_auto_approve_movies": "boolean"
}

PUT /api/auth/me/email may change

Change your own e-mail address

The new address only counts as confirmed once the link in the mail has been clicked - otherwise anyone could enter somebody else's address. Until then the old one stays in force for password resets.

Felder und Aufbau

Anfragekörper

FeldArt

emailText Pflicht

Antwort

FeldArt

idZahl Pflicht

usernameText Pflicht

roleadmin | approver | user | child Pflicht

display_nameText oder null Pflicht

emailText oder null Pflicht

email_verifiedja/nein Pflicht

languageText Pflicht

themeText Pflicht

is_activeja/nein Pflicht

auto_approveja/nein Pflicht

auto_approve_moviesja/nein oder null Pflicht

auto_approve_seriesja/nein oder null Pflicht

effective_auto_approveja/nein Pflicht

effective_auto_approve_moviesja/nein Pflicht

effective_auto_approve_seriesja/nein Pflicht

can_approveja/nein Pflicht

quota_movies_limitZahl Pflicht

quota_series_limitZahl Pflicht

storage_limit_gbZahl

quota_reset_atZeitpunkt (ISO 8601) oder null Pflicht

blocked_movie_profilesListe von Zahl Pflicht

blocked_series_profilesListe von Zahl Pflicht

can_request_uhd_moviesja/nein Pflicht

can_request_uhd_seriesja/nein Pflicht

auto_approve_uhdja/nein Pflicht

effective_auto_approve_uhdja/nein Pflicht

blocked_movie_uhd_profilesListe von Zahl Pflicht

blocked_series_uhd_profilesListe von Zahl Pflicht

avatar_urlText oder null Pflicht

created_atZeitpunkt (ISO 8601) Pflicht

last_login_atZeitpunkt (ISO 8601) oder null Pflicht

mail_download_completeja/nein Pflicht

mail_request_pendingja/nein Pflicht

mail_request_decidedja/nein Pflicht

mail_feedbackja/nein Pflicht

mail_ticketja/nein Pflicht

mail_watchja/nein Pflicht

mail_user_importedja/nein Pflicht

mail_mediaserver_reconnectja/nein Pflicht

mail_storageja/nein Pflicht

mail_child_wishja/nein Pflicht

mail_cleanupja/nein Pflicht

watchlist_connectedja/nein Pflicht

watchlist_token_invalidja/nein

mediaserver_providerText oder null Pflicht

mediaserver_usernameText oder null Pflicht

mediaserver_linkedja/nein Pflicht

mediaserver_accountsListe von VerknuepftesKonto

has_passwordja/nein Pflicht

discover_regionText oder null Pflicht

ageZahl oder null Pflicht

rating_regionText oder null Pflicht

hide_unratedja/nein Pflicht

can_manage_childrenja/nein

parent_idZahl oder null

Aufbau der Antwort

{
  "id": "number",
  "username": "string",
  "role": "admin | approver | user | child",
  "display_name": "string | null",
  "email": "string | null",
  "email_verified": "boolean",
  "language": "string",
  "theme": "string",
  "is_active": "boolean",
  "auto_approve": "boolean",
  "auto_approve_movies": "boolean | null",
  "auto_approve_series": "boolean | null",
  "effective_auto_approve": "boolean",
  "effective_auto_approve_movies": "boolean"
}

POST /api/auth/me/password may change

Change your own password

Changes the password and signs out every other device. Since 0.21 any token older than password_changed_at is refused, so a copy somebody made of your session stops working the moment you change it.

Felder und Aufbau

Anfragekörper

FeldArt

current_passwordText Pflicht

new_passwordText Pflicht

Antwort

FeldArt

access_tokenText Pflicht

token_typeText

expires_inZahl Pflicht

Aufbau der Antwort

{
  "access_token": "string",
  "token_type": "string",
  "expires_in": "number"
}

POST /api/auth/me/resend-verification may change

Send the confirmation mail again

Requests a fresh confirmation mail for an address that has not been confirmed yet.

Felder und Aufbau

Antwort

FeldArt

sentja/nein Pflicht

errorText oder null

Aufbau der Antwort

{
  "sent": "boolean",
  "error": "string | null"
}

GET /api/auth/me/schluessel may change

Your own API tokens

Lists the tokens belonging to the calling account - name, preview, whether it may only read, when it expires and when it was last used. Never the token itself; that exists once, at creation.

Felder und Aufbau

Antwort

FeldArt

idZahl Pflicht

nameText Pflicht

vorschauText Pflicht

nur_lesenja/nein Pflicht

created_atZeitpunkt (ISO 8601) Pflicht

expires_atZeitpunkt (ISO 8601) oder null Pflicht

last_used_atZeitpunkt (ISO 8601) oder null Pflicht

Aufbau der Antwort

[
  {
    "id": "number",
    "name": "string",
    "vorschau": "string",
    "nur_lesen": "boolean",
    "created_at": "ISO 8601",
    "expires_at": "ISO 8601 | null",
    "last_used_at": "ISO 8601 | null"
  }
]

POST /api/auth/me/schluessel may change

Create an API token

⚠️ The plain text appears in this one response and nowhere else. Afterwards only a checksum remains, and not even an administrator can look it up. A token inherits the rights of the account it belongs to; nur_lesen restricts it to GET requests. Child accounts cannot create tokens.

Felder und Aufbau

Anfragekörper

FeldArt

nameText Pflicht

nur_lesenja/nein

tageZahl oder null

Antwort

FeldArt

idZahl Pflicht

nameText Pflicht

vorschauText Pflicht

nur_lesenja/nein Pflicht

created_atZeitpunkt (ISO 8601) Pflicht

expires_atZeitpunkt (ISO 8601) oder null Pflicht

last_used_atZeitpunkt (ISO 8601) oder null Pflicht

schluesselText Pflicht

Aufbau der Antwort

{
  "id": "number",
  "name": "string",
  "vorschau": "string",
  "nur_lesen": "boolean",
  "created_at": "ISO 8601",
  "expires_at": "ISO 8601 | null",
  "last_used_at": "ISO 8601 | null",
  "schluessel": "string"
}

DELETE /api/auth/me/schluessel/{schluessel_id} may change

Revoke one of your tokens

Takes effect immediately - anything using that token is locked out from the next request onwards. You can only revoke your own; an administrator can see foreign tokens but not switch them off.

Felder und Aufbau

Parameter

schluessel_idZahl path Pflicht

POST /api/auth/me/ueberall-abmelden may change

Sign out everywhere

Ends every session of this account on every device, including the one making the call, without changing the password. ⚠️ The way out that did not exist before 0.22. Ordinary sign-out only removes the cookie from this browser; a copy taken elsewhere kept working until it expired, up to 30 days.

Felder und Aufbau

Antwort

FeldArt

access_tokenText Pflicht

token_typeText

expires_inZahl Pflicht

Aufbau der Antwort

{
  "access_token": "string",
  "token_type": "string",
  "expires_in": "number"
}

POST /api/auth/refresh may change

Renew the access token

The refresh token is read from the HttpOnly cookie, not from the request body. Clients still holding a token in localStorage from an older version have to sign in once.

Felder und Aufbau

Antwort

FeldArt

access_tokenText Pflicht

token_typeText

expires_inZahl Pflicht

Aufbau der Antwort

{
  "access_token": "string",
  "token_type": "string",
  "expires_in": "number"
}

GET /api/children may change

Your own child accounts

The child profiles belonging to the calling account. Anyone without children gets an empty list. Child accounts are not accounts of their own: they are sub-profiles of a parent, and everything they cause runs against the parent's quota.

Felder und Aufbau

Antwort

FeldArt

idZahl Pflicht

usernameText Pflicht

display_nameText oder null Pflicht

ageZahl oder null Pflicht

is_activeja/nein Pflicht

languageText Pflicht

child_trailersja/nein

genresListe von Text Pflicht

created_atZeitpunkt (ISO 8601) Pflicht

last_login_atZeitpunkt (ISO 8601) oder null Pflicht

Aufbau der Antwort

[
  {
    "id": "number",
    "username": "string",
    "display_name": "string | null",
    "age": "number | null",
    "is_active": "boolean",
    "language": "string",
    "child_trailers": "boolean",
    "genres": [
      "string"
    ],
    "created_at": "ISO 8601",
    "last_login_at": "ISO 8601 | null"
  }
]

POST /api/children may change

Create a child profile

Needs permission from an administrator first. The child gets its own sign-in and its own set of enabled categories, but no media-server link and no quota of its own.

Felder und Aufbau

Anfragekörper

FeldArt

usernameText Pflicht

passwordText Pflicht

ageZahl Pflicht

display_nameText oder null

genresListe von Text oder null

child_trailersja/nein

languageText oder null

Antwort

FeldArt

idZahl Pflicht

usernameText Pflicht

display_nameText oder null Pflicht

ageZahl oder null Pflicht

is_activeja/nein Pflicht

languageText Pflicht

child_trailersja/nein

genresListe von Text Pflicht

created_atZeitpunkt (ISO 8601) Pflicht

last_login_atZeitpunkt (ISO 8601) oder null Pflicht

Aufbau der Antwort

{
  "id": "number",
  "username": "string",
  "display_name": "string | null",
  "age": "number | null",
  "is_active": "boolean",
  "language": "string",
  "child_trailers": "boolean",
  "genres": [
    "string"
  ],
  "created_at": "ISO 8601",
  "last_login_at": "ISO 8601 | null"
}

GET /api/children/genres may change

The categories a child can be given

The selectable categories in their fixed order. The interface fetches them here rather than listing them itself - otherwise there would be two lists that drift apart.

POST /api/children/request-permission may change

Ask to be allowed child profiles

A button, not a form: the text is fixed, so nobody has to invent one. Lands as a ticket with the administrators.

GET /api/children/wishes may change

Wishes waiting for your decision

What the children of the calling account have wished for and nobody has decided yet.

Felder und Aufbau

Antwort

FeldArt

idZahl Pflicht

child_idZahl Pflicht

child_nameText Pflicht

media_typeText Pflicht

tmdb_idZahl Pflicht

titleText Pflicht

poster_pathText oder null Pflicht

in_my_subscriptionsListe von Text

release_dateText oder null Pflicht

created_atText Pflicht

Aufbau der Antwort

[
  {
    "id": "number",
    "child_id": "number",
    "child_name": "string",
    "media_type": "string",
    "tmdb_id": "number",
    "title": "string",
    "poster_path": "string | null",
    "in_my_subscriptions": [
      "string"
    ],
    "release_date": "string | null",
    "created_at": "string"
  }
]

POST /api/children/wishes/{wish_id}/decline may change

Turn down a wish

The child is told, and the wish is closed. Nothing is requested.

Felder und Aufbau

Parameter

wish_idZahl path Pflicht

Anfragekörper

FeldArt

noteText oder null

POST /api/children/wishes/{wish_id}/release may change

Turn a wish into a request

The wish becomes a request in the parent's name. The title is fetched from their point of view: it is their request, against their quota and their age settings.

Felder und Aufbau

Parameter

wish_idZahl path Pflicht

Anfragekörper

FeldArt

quality_profile_idZahl oder null

root_folder_pathText oder null

seasonZahl oder null

monitor_futureja/nein

tierstandard | uhd

Antwort

FeldArt

idZahl Pflicht

media_typemovie | tv Pflicht

tierstandard | uhd Pflicht

tmdb_idZahl Pflicht

titleText Pflicht

poster_pathText oder null Pflicht

release_dateText oder null Pflicht

quality_profile_idZahl oder null Pflicht

root_folder_pathText oder null Pflicht

seasonZahl oder null Pflicht

from_watchlistja/nein Pflicht

requested_atZeitpunkt (ISO 8601) Pflicht

approved_atZeitpunkt (ISO 8601) oder null Pflicht

completed_atZeitpunkt (ISO 8601) oder null Pflicht

approved_by_nameText oder null

last_checked_atZeitpunkt (ISO 8601) oder null

rejection_reasonText oder null Pflicht

error_messageText oder null Pflicht

ratingZahl oder null Pflicht

feedbackText oder null Pflicht

rated_atZeitpunkt (ISO 8601) oder null Pflicht

rating_outdatedja/nein

feedback_replyText oder null Pflicht

replied_atZeitpunkt (ISO 8601) oder null Pflicht

Aufbau der Antwort

{
  "id": "number",
  "media_type": "movie | tv",
  "tier": "standard | uhd",
  "tmdb_id": "number",
  "title": "string",
  "poster_path": "string | null",
  "release_date": "string | null",
  "status": "pending_approval | approved | searching | downloaded | rejected | failed | cancelled | deleted | deferred",
  "quality_profile_id": "number | null",
  "root_folder_path": "string | null",
  "season": "number | null",
  "from_watchlist": "boolean",
  "requested_at": "ISO 8601",
  "approved_at": "ISO 8601 | null"
}

DELETE /api/children/{child_id} may change

Delete a child profile

Removes the profile and its sign-in. Requests already made in the parent's name are unaffected - they were never the child's.

Felder und Aufbau

Parameter

child_idZahl path Pflicht

PATCH /api/children/{child_id} may change

Change a child profile

Display name, enabled categories and age limit.

Felder und Aufbau

Parameter

child_idZahl path Pflicht

Anfragekörper

FeldArt

display_nameText oder null

ageZahl oder null

is_activeja/nein oder null

genresListe von Text oder null

child_trailersja/nein oder null

languageText oder null

Antwort

FeldArt

idZahl Pflicht

usernameText Pflicht

display_nameText oder null Pflicht

ageZahl oder null Pflicht

is_activeja/nein Pflicht

languageText Pflicht

child_trailersja/nein

genresListe von Text Pflicht

created_atZeitpunkt (ISO 8601) Pflicht

last_login_atZeitpunkt (ISO 8601) oder null Pflicht

Aufbau der Antwort

{
  "id": "number",
  "username": "string",
  "display_name": "string | null",
  "age": "number | null",
  "is_active": "boolean",
  "language": "string",
  "child_trailers": "boolean",
  "genres": [
    "string"
  ],
  "created_at": "ISO 8601",
  "last_login_at": "ISO 8601 | null"
}

POST /api/children/{child_id}/password may change

Set a child's password

The parent sets it directly. A child has no e-mail address, so there is no reset link to send.

Felder und Aufbau

Parameter

child_idZahl path Pflicht

Anfragekörper

FeldArt

passwordText Pflicht

Antwort

FeldArt

idZahl Pflicht

usernameText Pflicht

display_nameText oder null Pflicht

ageZahl oder null Pflicht

is_activeja/nein Pflicht

languageText Pflicht

child_trailersja/nein

genresListe von Text Pflicht

created_atZeitpunkt (ISO 8601) Pflicht

last_login_atZeitpunkt (ISO 8601) oder null Pflicht

Aufbau der Antwort

{
  "id": "number",
  "username": "string",
  "display_name": "string | null",
  "age": "number | null",
  "is_active": "boolean",
  "language": "string",
  "child_trailers": "boolean",
  "genres": [
    "string"
  ],
  "created_at": "ISO 8601",
  "last_login_at": "ISO 8601 | null"
}

GET /api/children/{child_id}/preview/backdrops may change

Preview: the child's backdrops

What the child sees behind its start page. Part of the preview, so a parent can check what they have enabled without signing in as the child.

Felder und Aufbau

Parameter

child_idZahl path Pflicht

GET /api/children/{child_id}/preview/categories may change

Preview: the child's start page

The start page exactly as this child would see it - one tile per enabled category.

Felder und Aufbau

Parameter

child_idZahl path Pflicht

media_typeText query

Antwort

FeldArt

rubrikText Pflicht

bilderListe von Text Pflicht

Aufbau der Antwort

[
  {
    "rubrik": "string",
    "bilder": [
      "string"
    ]
  }
]

GET /api/children/{child_id}/preview/rubrik/{rubrik} may change

Preview: one category

Everything in one category, as the child would see it. The category is checked against what this child is allowed.

Felder und Aufbau

Parameter

child_idZahl path Pflicht

rubrikText path Pflicht

media_typeText query

pageZahl query

Antwort

FeldArt

verfuegbarListe von MediaItem Pflicht

wuenschbarListe von MediaItem Pflicht

gewuenschtListe von Zahl

Aufbau der Antwort

{
  "verfuegbar": [
    {
      "media_type": "movie | tv",
      "tmdb_id": "number",
      "tvdb_id": "number | null",
      "title": "string",
      "original_title": "string | null",
      "overview": "string",
      "poster_url": "string | null",
      "backdrop_url": "string | null",
      "release_date": "string | null",
      "vote_average": "number",
      "vote_count": "number",
      "genres": [
        "string"
      ],
      "runtime_minutes": "number | null",
      "certification": "string | null"
    }
  ],
  "wuenschbar": [
    {
      "media_type": "movie | tv",
      "tmdb_id": "number",
      "tvdb_id": "number | null",
      "title": "string",
      "original_title": "string | null",
      "overview": "string",
      "poster_url": "string | null",
      "backdrop_url": "string | null",
      "release_date": "string | null",
      "vote_average": "number",
      "vote_count": "number",
      "genres": [
        "string"
      ],
      "runtime_minutes": "number | null",
      "certification": "string | null"
    }
  ],
  "gewuenscht": [
    "number"
  ]
}

GET /api/children/{child_id}/preview/search may change

Preview: the child's search

Searches within the child's enabled categories only, so a parent can see what a search would turn up.

Felder und Aufbau

Parameter

child_idZahl path Pflicht

qText query

media_typeText query

pageZahl query

Antwort

FeldArt

verfuegbarListe von MediaItem Pflicht

wuenschbarListe von MediaItem Pflicht

gewuenschtListe von Zahl

Aufbau der Antwort

{
  "verfuegbar": [
    {
      "media_type": "movie | tv",
      "tmdb_id": "number",
      "tvdb_id": "number | null",
      "title": "string",
      "original_title": "string | null",
      "overview": "string",
      "poster_url": "string | null",
      "backdrop_url": "string | null",
      "release_date": "string | null",
      "vote_average": "number",
      "vote_count": "number",
      "genres": [
        "string"
      ],
      "runtime_minutes": "number | null",
      "certification": "string | null"
    }
  ],
  "wuenschbar": [
    {
      "media_type": "movie | tv",
      "tmdb_id": "number",
      "tvdb_id": "number | null",
      "title": "string",
      "original_title": "string | null",
      "overview": "string",
      "poster_url": "string | null",
      "backdrop_url": "string | null",
      "release_date": "string | null",
      "vote_average": "number",
      "vote_count": "number",
      "genres": [
        "string"
      ],
      "runtime_minutes": "number | null",
      "certification": "string | null"
    }
  ],
  "gewuenscht": [
    "number"
  ]
}

GET /api/children/{child_id}/preview/title/{media_type}/{tmdb_id} may change

Preview: one title

A single title exactly as the child would see it, including the category check.

Felder und Aufbau

Parameter

child_idZahl path Pflicht

media_typeText path Pflicht

tmdb_idZahl path Pflicht

Antwort

FeldArt

media_typemovie | tv Pflicht

tmdb_idZahl Pflicht

tvdb_idZahl oder null

titleText Pflicht

original_titleText oder null

overviewText

poster_urlText oder null

backdrop_urlText oder null

release_dateText oder null

vote_averageZahl

vote_countZahl

genresListe von Text

runtime_minutesZahl oder null

certificationText oder null

original_languageText oder null

origin_countryListe von Text

seasonsListe von SeasonInfo

statusText

status_uhdText oder null

watchedja/nein

watched_onListe von Text

watched_not_onListe von Text

pathText oder null

path_uhdText oder null

uhd_in_standardja/nein

taglineText

homepageText oder null

status_textText

original_countryListe von Text

spoken_languagesListe von Text

budgetZahl oder null

revenueZahl oder null

studiosListe von NamedRef

keywordsListe von NamedRef

trailerTrailer oder null

watchWatchProviders oder null

in_my_subscriptionsListe von Text

watchingja/nein

requested_by_meja/nein

my_feedbackMeineRueckmeldung oder null

open_ticketja/nein

castListe von CastMember

crewListe von CrewMember

recommendationsListe von MediaItem

seasons_totalZahl oder null

episodes_totalZahl oder null

series_statusText

networksListe von NamedRef

Aufbau der Antwort

{
  "media_type": "movie | tv",
  "tmdb_id": "number",
  "tvdb_id": "number | null",
  "title": "string",
  "original_title": "string | null",
  "overview": "string",
  "poster_url": "string | null",
  "backdrop_url": "string | null",
  "release_date": "string | null",
  "vote_average": "number",
  "vote_count": "number",
  "genres": [
    "string"
  ],
  "runtime_minutes": "number | null",
  "certification": "string | null"
}

GET /api/kids/backdrops may change

Backdrops for the start page

Images for the background of the children's view.

GET /api/kids/categories may change

The children's start page

One tile per enabled category. Categories first, titles second - so a child sees what things are about instead of walking into a wall of posters.

Felder und Aufbau

Parameter

media_typemovie | tv query

Antwort

FeldArt

rubrikText Pflicht

bilderListe von Text Pflicht

Aufbau der Antwort

[
  {
    "rubrik": "string",
    "bilder": [
      "string"
    ]
  }
]

GET /api/kids/rubrik/{rubrik} may change

Everything in one category

The whole category at once rather than a sideways-scrolling row. ⚠️ The category is checked: otherwise one that was never enabled could be requested through the address bar.

Felder und Aufbau

Parameter

rubrikText path Pflicht

media_typemovie | tv query

pageZahl query

Antwort

FeldArt

verfuegbarListe von MediaItem Pflicht

wuenschbarListe von MediaItem Pflicht

gewuenschtListe von Zahl Pflicht

Aufbau der Antwort

{
  "verfuegbar": [
    {
      "media_type": "movie | tv",
      "tmdb_id": "number",
      "tvdb_id": "number | null",
      "title": "string",
      "original_title": "string | null",
      "overview": "string",
      "poster_url": "string | null",
      "backdrop_url": "string | null",
      "release_date": "string | null",
      "vote_average": "number",
      "vote_count": "number",
      "genres": [
        "string"
      ],
      "runtime_minutes": "number | null",
      "certification": "string | null"
    }
  ],
  "wuenschbar": [
    {
      "media_type": "movie | tv",
      "tmdb_id": "number",
      "tvdb_id": "number | null",
      "title": "string",
      "original_title": "string | null",
      "overview": "string",
      "poster_url": "string | null",
      "backdrop_url": "string | null",
      "release_date": "string | null",
      "vote_average": "number",
      "vote_count": "number",
      "genres": [
        "string"
      ],
      "runtime_minutes": "number | null",
      "certification": "string | null"
    }
  ],
  "gewuenscht": [
    "number"
  ]
}

GET /api/kids/search may change

Search, within the enabled categories only

The restriction sits in the service, not in the interface. If nothing is found, the child is told so plainly rather than being shown an empty page.

Felder und Aufbau

Parameter

qText query Pflicht

media_typemovie | tv query

pageZahl query

Antwort

FeldArt

verfuegbarListe von MediaItem Pflicht

wuenschbarListe von MediaItem Pflicht

gewuenschtListe von Zahl Pflicht

Aufbau der Antwort

{
  "verfuegbar": [
    {
      "media_type": "movie | tv",
      "tmdb_id": "number",
      "tvdb_id": "number | null",
      "title": "string",
      "original_title": "string | null",
      "overview": "string",
      "poster_url": "string | null",
      "backdrop_url": "string | null",
      "release_date": "string | null",
      "vote_average": "number",
      "vote_count": "number",
      "genres": [
        "string"
      ],
      "runtime_minutes": "number | null",
      "certification": "string | null"
    }
  ],
  "wuenschbar": [
    {
      "media_type": "movie | tv",
      "tmdb_id": "number",
      "tvdb_id": "number | null",
      "title": "string",
      "original_title": "string | null",
      "overview": "string",
      "poster_url": "string | null",
      "backdrop_url": "string | null",
      "release_date": "string | null",
      "vote_average": "number",
      "vote_count": "number",
      "genres": [
        "string"
      ],
      "runtime_minutes": "number | null",
      "certification": "string | null"
    }
  ],
  "gewuenscht": [
    "number"
  ]
}

GET /api/kids/title/{media_type}/{tmdb_id} may change

One title for a child

A single title with its trailer and nothing else. ⚠️ The category is checked here too, not only when listing: otherwise a blocked title could be reached straight through the address bar.

Felder und Aufbau

Parameter

media_typemovie | tv path Pflicht

tmdb_idZahl path Pflicht

Antwort

FeldArt

media_typemovie | tv Pflicht

tmdb_idZahl Pflicht

tvdb_idZahl oder null

titleText Pflicht

original_titleText oder null

overviewText

poster_urlText oder null

backdrop_urlText oder null

release_dateText oder null

vote_averageZahl

vote_countZahl

genresListe von Text

runtime_minutesZahl oder null

certificationText oder null

original_languageText oder null

origin_countryListe von Text

seasonsListe von SeasonInfo

statusText

status_uhdText oder null

watchedja/nein

watched_onListe von Text

watched_not_onListe von Text

pathText oder null

path_uhdText oder null

uhd_in_standardja/nein

taglineText

homepageText oder null

status_textText

original_countryListe von Text

spoken_languagesListe von Text

budgetZahl oder null

revenueZahl oder null

studiosListe von NamedRef

keywordsListe von NamedRef

trailerTrailer oder null

watchWatchProviders oder null

in_my_subscriptionsListe von Text

watchingja/nein

requested_by_meja/nein

my_feedbackMeineRueckmeldung oder null

open_ticketja/nein

castListe von CastMember

crewListe von CrewMember

recommendationsListe von MediaItem

seasons_totalZahl oder null

episodes_totalZahl oder null

series_statusText

networksListe von NamedRef

Aufbau der Antwort

{
  "media_type": "movie | tv",
  "tmdb_id": "number",
  "tvdb_id": "number | null",
  "title": "string",
  "original_title": "string | null",
  "overview": "string",
  "poster_url": "string | null",
  "backdrop_url": "string | null",
  "release_date": "string | null",
  "vote_average": "number",
  "vote_count": "number",
  "genres": [
    "string"
  ],
  "runtime_minutes": "number | null",
  "certification": "string | null"
}

GET /api/kids/wishes may change

The child's own wishes

What this child has wished for and what became of each wish.

Felder und Aufbau

Antwort

FeldArt

idZahl Pflicht

media_typeText Pflicht

tmdb_idZahl Pflicht

titleText Pflicht

poster_pathText oder null Pflicht

release_dateText oder null Pflicht

stateText Pflicht

decline_noteText oder null Pflicht

created_atText Pflicht

Aufbau der Antwort

[
  {
    "id": "number",
    "media_type": "string",
    "tmdb_id": "number",
    "title": "string",
    "poster_path": "string | null",
    "release_date": "string | null",
    "state": "string",
    "decline_note": "string | null",
    "created_at": "string"
  }
]

POST /api/kids/wishes may change

Wish for something

The title is fetched from TMDB again here, with this child's settings: a blocked title fails the age check at that point rather than after the parent has already seen it.

Felder und Aufbau

Anfragekörper

FeldArt

media_typemovie | tv Pflicht

tmdb_idZahl Pflicht

Antwort

FeldArt

idZahl Pflicht

media_typeText Pflicht

tmdb_idZahl Pflicht

titleText Pflicht

poster_pathText oder null Pflicht

release_dateText oder null Pflicht

stateText Pflicht

decline_noteText oder null Pflicht

created_atText Pflicht

Aufbau der Antwort

{
  "id": "number",
  "media_type": "string",
  "tmdb_id": "number",
  "title": "string",
  "poster_path": "string | null",
  "release_date": "string | null",
  "state": "string",
  "decline_note": "string | null",
  "created_at": "string"
}

POST /api/onboarding/forgot-password may change

Request a password reset link

The response is always the same, whether the address exists or not. Otherwise anyone could probe here for who has an account - and on a private installation, that is exactly the list nobody should be able to build.

Felder und Aufbau

Anfragekörper

FeldArt

emailText Pflicht

Antwort

FeldArt

messageText Pflicht

Aufbau der Antwort

{
  "message": "string"
}

GET /api/onboarding/invitation/{raw} may change

Check an invitation link

Says whether the link is still valid and what it offers, without signing anybody in. Used by the page behind the link to decide between a form and an explanation.

Felder und Aufbau

Parameter

rawText path Pflicht

Antwort

FeldArt

emailText Pflicht

roleadmin | approver | user | child Pflicht

Aufbau der Antwort

{
  "email": "string",
  "role": "admin | approver | user | child"
}

POST /api/onboarding/invitation/{raw} may change

Redeem an invitation

Creates the account the way the invited person wants it - username, password, display name. The account does not exist until this call succeeds.

Felder und Aufbau

Parameter

rawText path Pflicht

Anfragekörper

FeldArt

usernameText Pflicht

display_nameText oder null

passwordText Pflicht

GET /api/onboarding/password/{raw} may change

Check a password link

Says whether a reset or first-password link is still valid, so the page can show a form or an explanation instead of failing on submit.

Felder und Aufbau

Parameter

rawText path Pflicht

Antwort

FeldArt

usernameText Pflicht

Aufbau der Antwort

{
  "username": "string"
}

POST /api/onboarding/password/{raw} may change

Set a password

First password or a new one. The address counts as confirmed afterwards - the mail evidently arrived. Every existing session becomes invalid: anyone resetting a password has a reason to assume somebody else was in.

Felder und Aufbau

Parameter

rawText path Pflicht

Anfragekörper

FeldArt

passwordText Pflicht

PUT /api/onboarding/pending/email may change

Correct an unconfirmed address

The most common reason for a mail that never arrives is a typo. Without this route the installation would be stuck: no confirmed address, no sign-in, and no way to fix the address.

Felder und Aufbau

Anfragekörper

FeldArt

usernameText Pflicht

passwordText Pflicht

emailText Pflicht

Antwort

FeldArt

sentja/nein Pflicht

errorText oder null

Aufbau der Antwort

{
  "sent": "boolean",
  "error": "string | null"
}

POST /api/onboarding/pending/resend may change

Send the confirmation mail again, without signing in

The counterpart to the signed-in version, for an account that cannot sign in yet because its address is unconfirmed.

Felder und Aufbau

Anfragekörper

FeldArt

usernameText Pflicht

passwordText Pflicht

Antwort

FeldArt

sentja/nein Pflicht

errorText oder null

Aufbau der Antwort

{
  "sent": "boolean",
  "error": "string | null"
}

GET /api/onboarding/username-available may change

Is this username still free

Answers while somebody is still typing. Deliberately open without authentication: whoever is redeeming an invitation is nobody yet. It reveals only whether a name is taken - the same thing the form would reveal on submit.

Felder und Aufbau

Parameter

usernameText query Pflicht

Antwort

FeldArt

availableja/nein Pflicht

Aufbau der Antwort

{
  "available": "boolean"
}

POST /api/onboarding/verify/{raw} may change

Confirm an e-mail address

Marks the address behind the link as confirmed.

Felder und Aufbau

Parameter

rawText path Pflicht

POST /api/setup/admin may change

Create the first administrator

Only works while the installation is still empty. Afterwards accounts come into being through invitations.

Felder und Aufbau

Anfragekörper

FeldArt

usernameText Pflicht

passwordText Pflicht

emailText Pflicht

display_nameText oder null

languageText

Antwort

FeldArt

access_tokenText Pflicht

token_typeText

expires_inZahl Pflicht

Aufbau der Antwort

{
  "access_token": "string",
  "token_type": "string",
  "expires_in": "number"
}

POST /api/setup/sicherung/einspielen may change

Set up from a backup

Builds the fresh installation from a backup file. Setup is finished afterwards: the accounts come from the backup, and the wizard does not appear again.

POST /api/setup/sicherung/pruefen may change

Inspect a backup file

Reports what a backup contains and whether this version can restore it - without replacing anything. A backup from a newer version is refused, because the database can only be migrated forward.

GET /api/setup/status may change

Is setup still needed

Says whether this installation has been set up yet, and which step it stopped at. Answers without authentication - there is nobody to authenticate as.

Felder und Aufbau

Antwort

FeldArt

needs_setupja/nein Pflicht

min_password_lengthZahl

mediaserver_loginja/nein

mediaserver_providerText oder null

mediaserver_login_waysListe von AnmeldeWeg

Aufbau der Antwort

{
  "needs_setup": "boolean",
  "min_password_length": "number",
  "mediaserver_login": "boolean",
  "mediaserver_provider": "string | null",
  "mediaserver_login_ways": [
    {
      "provider": "string",
      "label": "string",
      "kind": "string"
    }
  ]
}

GET /api/users may change

All accounts

Every account with its role, quota and current usage. Administrators only.

Felder und Aufbau

Antwort

FeldArt

idZahl Pflicht

usernameText Pflicht

roleadmin | approver | user | child Pflicht

display_nameText oder null Pflicht

emailText oder null Pflicht

email_verifiedja/nein Pflicht

languageText Pflicht

themeText Pflicht

is_activeja/nein Pflicht

auto_approveja/nein Pflicht

auto_approve_moviesja/nein oder null Pflicht

auto_approve_seriesja/nein oder null Pflicht

effective_auto_approveja/nein Pflicht

effective_auto_approve_moviesja/nein Pflicht

effective_auto_approve_seriesja/nein Pflicht

can_approveja/nein Pflicht

quota_movies_limitZahl Pflicht

quota_series_limitZahl Pflicht

storage_limit_gbZahl

quota_reset_atZeitpunkt (ISO 8601) oder null Pflicht

blocked_movie_profilesListe von Zahl Pflicht

blocked_series_profilesListe von Zahl Pflicht

can_request_uhd_moviesja/nein Pflicht

can_request_uhd_seriesja/nein Pflicht

auto_approve_uhdja/nein Pflicht

effective_auto_approve_uhdja/nein Pflicht

blocked_movie_uhd_profilesListe von Zahl Pflicht

blocked_series_uhd_profilesListe von Zahl Pflicht

avatar_urlText oder null Pflicht

created_atZeitpunkt (ISO 8601) Pflicht

last_login_atZeitpunkt (ISO 8601) oder null Pflicht

mail_download_completeja/nein Pflicht

mail_request_pendingja/nein Pflicht

mail_request_decidedja/nein Pflicht

mail_feedbackja/nein Pflicht

mail_ticketja/nein Pflicht

mail_watchja/nein Pflicht

mail_user_importedja/nein Pflicht

mail_mediaserver_reconnectja/nein Pflicht

mail_storageja/nein Pflicht

mail_child_wishja/nein Pflicht

mail_cleanupja/nein Pflicht

watchlist_connectedja/nein Pflicht

watchlist_token_invalidja/nein

mediaserver_providerText oder null Pflicht

mediaserver_usernameText oder null Pflicht

mediaserver_linkedja/nein Pflicht

mediaserver_accountsListe von VerknuepftesKonto

has_passwordja/nein Pflicht

discover_regionText oder null Pflicht

ageZahl oder null Pflicht

rating_regionText oder null Pflicht

hide_unratedja/nein Pflicht

can_manage_childrenja/nein

parent_idZahl oder null

quota_movies_usedZahl Pflicht

quota_series_usedZahl Pflicht

Aufbau der Antwort

[
  {
    "id": "number",
    "username": "string",
    "role": "admin | approver | user | child",
    "display_name": "string | null",
    "email": "string | null",
    "email_verified": "boolean",
    "language": "string",
    "theme": "string",
    "is_active": "boolean",
    "auto_approve": "boolean",
    "auto_approve_movies": "boolean | null",
    "auto_approve_series": "boolean | null",
    "effective_auto_approve": "boolean",
    "effective_auto_approve_movies": "boolean"
  }
]

GET /api/users/api-schluessel may change

All API tokens in this installation

Who holds which token, when it was made and when it was last used. Never the token itself - an administrator can supervise, not read. Revoking is not offered here: only the owner can switch off their own token.

Felder und Aufbau

Antwort

FeldArt

idZahl Pflicht

user_idZahl Pflicht

usernameText Pflicht

nameText Pflicht

vorschauText Pflicht

nur_lesenja/nein Pflicht

created_atZeitpunkt (ISO 8601) Pflicht

expires_atZeitpunkt (ISO 8601) oder null Pflicht

last_used_atZeitpunkt (ISO 8601) oder null Pflicht

Aufbau der Antwort

[
  {
    "id": "number",
    "user_id": "number",
    "username": "string",
    "name": "string",
    "vorschau": "string",
    "nur_lesen": "boolean",
    "created_at": "ISO 8601",
    "expires_at": "ISO 8601 | null",
    "last_used_at": "ISO 8601 | null"
  }
]

GET /api/users/invitations may change

Open invitations

Invitations that have neither been redeemed nor expired. Used-up ones are of no further interest.

Felder und Aufbau

Antwort

FeldArt

idZahl Pflicht

emailText Pflicht

roleadmin | approver | user | child Pflicht

created_atZeitpunkt (ISO 8601) Pflicht

expires_atZeitpunkt (ISO 8601) Pflicht

Aufbau der Antwort

[
  {
    "id": "number",
    "email": "string",
    "role": "admin | approver | user | child",
    "created_at": "ISO 8601",
    "expires_at": "ISO 8601"
  }
]

POST /api/users/invitations may change

Invite somebody

The account comes into being when the link is redeemed, not now. Needs both pieces in place: without a public address the mail contains a dead link, without a mail server it never goes out.

Felder und Aufbau

Anfragekörper

FeldArt

emailText Pflicht

roleadmin | approver | user | child

quota_movies_limitZahl

quota_series_limitZahl

Antwort

FeldArt

idZahl Pflicht

emailText Pflicht

roleadmin | approver | user | child Pflicht

created_atZeitpunkt (ISO 8601) Pflicht

expires_atZeitpunkt (ISO 8601) Pflicht

mail_sentja/nein Pflicht

mail_errorText oder null

manual_linkText oder null

Aufbau der Antwort

{
  "id": "number",
  "email": "string",
  "role": "admin | approver | user | child",
  "created_at": "ISO 8601",
  "expires_at": "ISO 8601",
  "mail_sent": "boolean",
  "mail_error": "string | null",
  "manual_link": "string | null"
}

DELETE /api/users/invitations/{invitation_id} may change

Withdraw an invitation

The link stops working immediately.

Felder und Aufbau

Parameter

invitation_idZahl path Pflicht

DELETE /api/users/{user_id} may change

Delete an account

Approved requests move into the house collection - they stay, just without an owner. Only what is still open gets cancelled. Use the preview first to see exactly what will happen.

Felder und Aufbau

Parameter

user_idZahl path Pflicht

Anfragekörper

FeldArt

hausListe von Zahl

loeschenListe von Zahl

staffelnListe von Staffelwahl

offen_behaltenListe von Zahl

PATCH /api/users/{user_id} may change

Change an account

Role, quota, auto-approval, active state and display name. Administrators only.

Felder und Aufbau

Parameter

user_idZahl path Pflicht

Anfragekörper

FeldArt

roleadmin | approver | user | child oder null

display_nameText oder null

languageText oder null

is_activeja/nein oder null

auto_approveja/nein oder null

auto_approve_moviesja/nein oder null

auto_approve_seriesja/nein oder null

quota_movies_limitZahl oder null

quota_series_limitZahl oder null

storage_limit_gbZahl oder null

blocked_movie_profilesListe von Zahl oder null

blocked_series_profilesListe von Zahl oder null

can_request_uhd_moviesja/nein oder null

can_request_uhd_seriesja/nein oder null

auto_approve_uhdja/nein oder null

blocked_movie_uhd_profilesListe von Zahl oder null

blocked_series_uhd_profilesListe von Zahl oder null

can_manage_childrenja/nein oder null

Antwort

FeldArt

idZahl Pflicht

usernameText Pflicht

roleadmin | approver | user | child Pflicht

display_nameText oder null Pflicht

emailText oder null Pflicht

email_verifiedja/nein Pflicht

languageText Pflicht

themeText Pflicht

is_activeja/nein Pflicht

auto_approveja/nein Pflicht

auto_approve_moviesja/nein oder null Pflicht

auto_approve_seriesja/nein oder null Pflicht

effective_auto_approveja/nein Pflicht

effective_auto_approve_moviesja/nein Pflicht

effective_auto_approve_seriesja/nein Pflicht

can_approveja/nein Pflicht

quota_movies_limitZahl Pflicht

quota_series_limitZahl Pflicht

storage_limit_gbZahl

quota_reset_atZeitpunkt (ISO 8601) oder null Pflicht

blocked_movie_profilesListe von Zahl Pflicht

blocked_series_profilesListe von Zahl Pflicht

can_request_uhd_moviesja/nein Pflicht

can_request_uhd_seriesja/nein Pflicht

auto_approve_uhdja/nein Pflicht

effective_auto_approve_uhdja/nein Pflicht

blocked_movie_uhd_profilesListe von Zahl Pflicht

blocked_series_uhd_profilesListe von Zahl Pflicht

avatar_urlText oder null Pflicht

created_atZeitpunkt (ISO 8601) Pflicht

last_login_atZeitpunkt (ISO 8601) oder null Pflicht

mail_download_completeja/nein Pflicht

mail_request_pendingja/nein Pflicht

mail_request_decidedja/nein Pflicht

mail_feedbackja/nein Pflicht

mail_ticketja/nein Pflicht

mail_watchja/nein Pflicht

mail_user_importedja/nein Pflicht

mail_mediaserver_reconnectja/nein Pflicht

mail_storageja/nein Pflicht

mail_child_wishja/nein Pflicht

mail_cleanupja/nein Pflicht

watchlist_connectedja/nein Pflicht

watchlist_token_invalidja/nein

mediaserver_providerText oder null Pflicht

mediaserver_usernameText oder null Pflicht

mediaserver_linkedja/nein Pflicht

mediaserver_accountsListe von VerknuepftesKonto

has_passwordja/nein Pflicht

discover_regionText oder null Pflicht

ageZahl oder null Pflicht

rating_regionText oder null Pflicht

hide_unratedja/nein Pflicht

can_manage_childrenja/nein

parent_idZahl oder null

Aufbau der Antwort

{
  "id": "number",
  "username": "string",
  "role": "admin | approver | user | child",
  "display_name": "string | null",
  "email": "string | null",
  "email_verified": "boolean",
  "language": "string",
  "theme": "string",
  "is_active": "boolean",
  "auto_approve": "boolean",
  "auto_approve_movies": "boolean | null",
  "auto_approve_series": "boolean | null",
  "effective_auto_approve": "boolean",
  "effective_auto_approve_movies": "boolean"
}

GET /api/users/{user_id}/aufloesung may change

Preview: what deleting would leave behind

What this account would leave behind - without anything happening. The administrator decides with this list in front of them: per item house or delete, per open request keep or cancel.

Felder und Aufbau

Parameter

user_idZahl path Pflicht

Antwort

FeldArt

postenListe von AufloesungsPosten Pflicht

laufendeListe von LaufendeZeile Pflicht

offenListe von OffeneZeile Pflicht

Aufbau der Antwort

{
  "posten": [
    {
      "id": "number",
      "title": "string",
      "tier": "string",
      "season": "number | null",
      "media_type": "string",
      "size_bytes": "number"
    }
  ],
  "laufende": [
    {
      "request_id": "number",
      "title": "string",
      "tier": "string",
      "season": "number | null",
      "dateien": "number",
      "folgen": "number"
    }
  ],
  "offen": [
    {
      "request_id": "number",
      "title": "string",
      "tier": "string",
      "season": "number | null"
    }
  ]
}

POST /api/users/{user_id}/password may change

Set an account's password

An administrator sets a new password directly, for the case where mail is not working and the reset link cannot arrive.

Felder und Aufbau

Parameter

user_idZahl path Pflicht

Anfragekörper

FeldArt

passwordText Pflicht

POST /api/users/{user_id}/quota/reset may change

Reset the request count

Sets usage in the current period back to zero. The requests themselves stay - counting simply starts again from now. At the next period change the calendar takes over as usual.

Felder und Aufbau

Parameter

user_idZahl path Pflicht

Antwort

FeldArt

idZahl Pflicht

usernameText Pflicht

roleadmin | approver | user | child Pflicht

display_nameText oder null Pflicht

emailText oder null Pflicht

email_verifiedja/nein Pflicht

languageText Pflicht

themeText Pflicht

is_activeja/nein Pflicht

auto_approveja/nein Pflicht

auto_approve_moviesja/nein oder null Pflicht

auto_approve_seriesja/nein oder null Pflicht

effective_auto_approveja/nein Pflicht

effective_auto_approve_moviesja/nein Pflicht

effective_auto_approve_seriesja/nein Pflicht

can_approveja/nein Pflicht

quota_movies_limitZahl Pflicht

quota_series_limitZahl Pflicht

storage_limit_gbZahl

quota_reset_atZeitpunkt (ISO 8601) oder null Pflicht

blocked_movie_profilesListe von Zahl Pflicht

blocked_series_profilesListe von Zahl Pflicht

can_request_uhd_moviesja/nein Pflicht

can_request_uhd_seriesja/nein Pflicht

auto_approve_uhdja/nein Pflicht

effective_auto_approve_uhdja/nein Pflicht

blocked_movie_uhd_profilesListe von Zahl Pflicht

blocked_series_uhd_profilesListe von Zahl Pflicht

avatar_urlText oder null Pflicht

created_atZeitpunkt (ISO 8601) Pflicht

last_login_atZeitpunkt (ISO 8601) oder null Pflicht

mail_download_completeja/nein Pflicht

mail_request_pendingja/nein Pflicht

mail_request_decidedja/nein Pflicht

mail_feedbackja/nein Pflicht

mail_ticketja/nein Pflicht

mail_watchja/nein Pflicht

mail_user_importedja/nein Pflicht

mail_mediaserver_reconnectja/nein Pflicht

mail_storageja/nein Pflicht

mail_child_wishja/nein Pflicht

mail_cleanupja/nein Pflicht

watchlist_connectedja/nein Pflicht

watchlist_token_invalidja/nein

mediaserver_providerText oder null Pflicht

mediaserver_usernameText oder null Pflicht

mediaserver_linkedja/nein Pflicht

mediaserver_accountsListe von VerknuepftesKonto

has_passwordja/nein Pflicht

discover_regionText oder null Pflicht

ageZahl oder null Pflicht

rating_regionText oder null Pflicht

hide_unratedja/nein Pflicht

can_manage_childrenja/nein

parent_idZahl oder null

quota_movies_usedZahl Pflicht

quota_series_usedZahl Pflicht

Aufbau der Antwort

{
  "id": "number",
  "username": "string",
  "role": "admin | approver | user | child",
  "display_name": "string | null",
  "email": "string | null",
  "email_verified": "boolean",
  "language": "string",
  "theme": "string",
  "is_active": "boolean",
  "auto_approve": "boolean",
  "auto_approve_movies": "boolean | null",
  "auto_approve_series": "boolean | null",
  "effective_auto_approve": "boolean",
  "effective_auto_approve_movies": "boolean"
}

POST /api/users/{user_id}/storage/reset may change

Move an account's storage to the house

The counterpart to resetting the request count, and the way out of a ghost item: something requested through Nexview that no longer exists in Radarr or Sonarr keeps counting against its owner forever otherwise.

Felder und Aufbau

Parameter

user_idZahl path Pflicht

Antwort

FeldArt

idZahl Pflicht

usernameText Pflicht

roleadmin | approver | user | child Pflicht

display_nameText oder null Pflicht

emailText oder null Pflicht

email_verifiedja/nein Pflicht

languageText Pflicht

themeText Pflicht

is_activeja/nein Pflicht

auto_approveja/nein Pflicht

auto_approve_moviesja/nein oder null Pflicht

auto_approve_seriesja/nein oder null Pflicht

effective_auto_approveja/nein Pflicht

effective_auto_approve_moviesja/nein Pflicht

effective_auto_approve_seriesja/nein Pflicht

can_approveja/nein Pflicht

quota_movies_limitZahl Pflicht

quota_series_limitZahl Pflicht

storage_limit_gbZahl

quota_reset_atZeitpunkt (ISO 8601) oder null Pflicht

blocked_movie_profilesListe von Zahl Pflicht

blocked_series_profilesListe von Zahl Pflicht

can_request_uhd_moviesja/nein Pflicht

can_request_uhd_seriesja/nein Pflicht

auto_approve_uhdja/nein Pflicht

effective_auto_approve_uhdja/nein Pflicht

blocked_movie_uhd_profilesListe von Zahl Pflicht

blocked_series_uhd_profilesListe von Zahl Pflicht

avatar_urlText oder null Pflicht

created_atZeitpunkt (ISO 8601) Pflicht

last_login_atZeitpunkt (ISO 8601) oder null Pflicht

mail_download_completeja/nein Pflicht

mail_request_pendingja/nein Pflicht

mail_request_decidedja/nein Pflicht

mail_feedbackja/nein Pflicht

mail_ticketja/nein Pflicht

mail_watchja/nein Pflicht

mail_user_importedja/nein Pflicht

mail_mediaserver_reconnectja/nein Pflicht

mail_storageja/nein Pflicht

mail_child_wishja/nein Pflicht

mail_cleanupja/nein Pflicht

watchlist_connectedja/nein Pflicht

watchlist_token_invalidja/nein

mediaserver_providerText oder null Pflicht

mediaserver_usernameText oder null Pflicht

mediaserver_linkedja/nein Pflicht

mediaserver_accountsListe von VerknuepftesKonto

has_passwordja/nein Pflicht

discover_regionText oder null Pflicht

ageZahl oder null Pflicht

rating_regionText oder null Pflicht

hide_unratedja/nein Pflicht

can_manage_childrenja/nein

parent_idZahl oder null

quota_movies_usedZahl Pflicht

quota_series_usedZahl Pflicht

Aufbau der Antwort

{
  "id": "number",
  "username": "string",
  "role": "admin | approver | user | child",
  "display_name": "string | null",
  "email": "string | null",
  "email_verified": "boolean",
  "language": "string",
  "theme": "string",
  "is_active": "boolean",
  "auto_approve": "boolean",
  "auto_approve_movies": "boolean | null",
  "auto_approve_series": "boolean | null",
  "effective_auto_approve": "boolean",
  "effective_auto_approve_movies": "boolean"
}