All URIs are relative to http://localhost:5055/api/v1
| Method | HTTP request | Description |
|---|---|---|
| create_cache_dns_flush | POST /settings/cache/dns/{dnsEntry}/flush | Flush a specific DNS cache entry |
| create_cache_flush | POST /settings/cache/{cacheId}/flush | Flush a specific cache |
| create_discover | POST /settings/discover | Batch update all sliders. |
| create_discover_add | POST /settings/discover/add | Add a new slider |
| create_initialize | POST /settings/initialize | Initialize application |
| create_jellyfin | POST /settings/jellyfin | Update Jellyfin settings |
| create_jellyfin_sync | POST /settings/jellyfin/sync | Start full Jellyfin library sync |
| create_jobs_cancel | POST /settings/jobs/{jobId}/cancel | Cancel a specific job |
| create_jobs_run | POST /settings/jobs/{jobId}/run | Invoke a specific job |
| create_jobs_schedule | POST /settings/jobs/{jobId}/schedule | Modify job schedule |
| create_main | POST /settings/main | Update main settings |
| create_main_regenerate | POST /settings/main/regenerate | Get main settings with newly-generated API key |
| create_network | POST /settings/network | Update network settings |
| create_notifications_discord | POST /settings/notifications/discord | Update Discord notification settings |
| create_notifications_email | POST /settings/notifications/email | Update email notification settings |
| create_notifications_gotify | POST /settings/notifications/gotify | Update Gotify notification settings |
| create_notifications_ntfy | POST /settings/notifications/ntfy | Update ntfy.sh notification settings |
| create_notifications_pushbullet | POST /settings/notifications/pushbullet | Update Pushbullet notification settings |
| create_notifications_pushover | POST /settings/notifications/pushover | Update Pushover notification settings |
| create_notifications_slack | POST /settings/notifications/slack | Update Slack notification settings |
| create_notifications_telegram | POST /settings/notifications/telegram | Update Telegram notification settings |
| create_notifications_webhook | POST /settings/notifications/webhook | Update webhook notification settings |
| create_notifications_webpush | POST /settings/notifications/webpush | Update Web Push notification settings |
| create_plex | POST /settings/plex | Update Plex settings |
| create_plex_sync | POST /settings/plex/sync | Start full Plex library scan |
| create_radarr | POST /settings/radarr | Create Radarr instance |
| create_sonarr | POST /settings/sonarr | Create Sonarr instance |
| create_tautulli | POST /settings/tautulli | Update Tautulli settings |
| delete_discover | DELETE /settings/discover/{sliderId} | Delete slider by ID |
| delete_radarr | DELETE /settings/radarr/{radarrId} | Delete Radarr instance |
| delete_sonarr | DELETE /settings/sonarr/{sonarrId} | Delete Sonarr instance |
| get_about | GET /settings/about | Get server stats |
| get_cache | GET /settings/cache | Get a list of active caches |
| get_discover_reset | GET /settings/discover/reset | Reset all discover sliders |
| get_jellyfin | GET /settings/jellyfin | Get Jellyfin settings |
| get_jellyfin_sync | GET /settings/jellyfin/sync | Get status of full Jellyfin library sync |
| get_main | GET /settings/main | Get main settings |
| get_metadatas | GET /settings/metadatas | Get Metadata settings |
| get_network | GET /settings/network | Get network settings |
| get_notifications_discord | GET /settings/notifications/discord | Get Discord notification settings |
| get_notifications_email | GET /settings/notifications/email | Get email notification settings |
| get_notifications_gotify | GET /settings/notifications/gotify | Get Gotify notification settings |
| get_notifications_ntfy | GET /settings/notifications/ntfy | Get ntfy.sh notification settings |
| get_notifications_pushbullet | GET /settings/notifications/pushbullet | Get Pushbullet notification settings |
| get_notifications_pushover | GET /settings/notifications/pushover | Get Pushover notification settings |
| get_notifications_slack | GET /settings/notifications/slack | Get Slack notification settings |
| get_notifications_telegram | GET /settings/notifications/telegram | Get Telegram notification settings |
| get_notifications_webhook | GET /settings/notifications/webhook | Get webhook notification settings |
| get_notifications_webpush | GET /settings/notifications/webpush | Get Web Push notification settings |
| get_plex | GET /settings/plex | Get Plex settings |
| get_plex_sync | GET /settings/plex/sync | Get status of full Plex library scan |
| get_public | GET /settings/public | Get public settings |
| get_tautulli | GET /settings/tautulli | Get Tautulli settings |
| list_discover | GET /settings/discover | Get all discover sliders |
| list_jellyfin_library | GET /settings/jellyfin/library | Get Jellyfin libraries |
| list_jellyfin_users | GET /settings/jellyfin/users | Get Jellyfin Users |
| list_jobs | GET /settings/jobs | Get scheduled jobs |
| list_logs | GET /settings/logs | Returns logs |
| list_notifications_pushover_sounds | GET /settings/notifications/pushover/sounds | Get Pushover sounds |
| list_plex_devices_servers | GET /settings/plex/devices/servers | Gets the user's available Plex servers |
| list_plex_library | GET /settings/plex/library | Get Plex libraries |
| list_plex_users | GET /settings/plex/users | Get Plex users |
| list_radarr | GET /settings/radarr | Get Radarr settings |
| list_radarr_profiles | GET /settings/radarr/{radarrId}/profiles | Get available Radarr profiles |
| list_sonarr | GET /settings/sonarr | Get Sonarr settings |
| put_metadatas | PUT /settings/metadatas | Update Metadata settings |
| test_metadatas | POST /settings/metadatas/test | Test Provider configuration |
| test_notifications_discord | POST /settings/notifications/discord/test | Test Discord settings |
| test_notifications_email | POST /settings/notifications/email/test | Test email settings |
| test_notifications_gotify | POST /settings/notifications/gotify/test | Test Gotify settings |
| test_notifications_ntfy | POST /settings/notifications/ntfy/test | Test ntfy.sh settings |
| test_notifications_pushbullet | POST /settings/notifications/pushbullet/test | Test Pushbullet settings |
| test_notifications_pushover | POST /settings/notifications/pushover/test | Test Pushover settings |
| test_notifications_slack | POST /settings/notifications/slack/test | Test Slack settings |
| test_notifications_telegram | POST /settings/notifications/telegram/test | Test Telegram settings |
| test_notifications_webhook | POST /settings/notifications/webhook/test | Test webhook settings |
| test_notifications_webpush | POST /settings/notifications/webpush/test | Test Web Push settings |
| test_radarr | POST /settings/radarr/test | Test Radarr configuration |
| test_sonarr | POST /settings/sonarr/test | Test Sonarr configuration |
| update_discover | PUT /settings/discover/{sliderId} | Update a single slider |
| update_radarr | PUT /settings/radarr/{radarrId} | Update Radarr instance |
| update_sonarr | PUT /settings/sonarr/{sonarrId} | Update Sonarr instance |
create_cache_dns_flush(dns_entry) Flush a specific DNS cache entry
Flushes a specific DNS cache entry
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| dns_entry | String | [required] |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
create_cache_flush(cache_id) Flush a specific cache
Flushes all data from the cache ID provided
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| cache_id | String | [required] |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Vecmodels::DiscoverSlider create_discover(discover_slider) Batch update all sliders.
Batch update all sliders at once. Should also be used for creation. Will only update sliders provided and will not delete any sliders not present in the request. If a slider is missing a required field, it will be ignored. Requires the ADMIN permission.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| discover_slider | Vecmodels::DiscoverSlider | [required] |
Vecmodels::DiscoverSlider
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::DiscoverSlider create_discover_add(create_discover_add_request) Add a new slider
Add a single slider and return the newly created slider. Requires the ADMIN permission.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| create_discover_add_request | CreateDiscoverAddRequest | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::PublicSettings create_initialize() Initialize application
Sets the app as initialized, allowing the user to navigate to pages other than the setup page.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::JellyfinSettings create_jellyfin(jellyfin_settings) Update Jellyfin settings
Updates Jellyfin settings with the provided values.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| jellyfin_settings | JellyfinSettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::GetJellyfinSync2XxResponse create_jellyfin_sync(create_jellyfin_sync_request) Start full Jellyfin library sync
Runs a full Jellyfin library sync and returns the progress in a JSON array.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| create_jellyfin_sync_request | Option<CreateJellyfinSyncRequest> |
models::GetJellyfinSync2XxResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::Job create_jobs_cancel(job_id) Cancel a specific job
Cancels a specific job. Will return the new job status in JSON format.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| job_id | String | [required] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::Job create_jobs_run(job_id) Invoke a specific job
Invokes a specific job to run. Will return the new job status in JSON format.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| job_id | String | [required] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::Job create_jobs_schedule(job_id, create_jobs_schedule_request) Modify job schedule
Re-registers the job with the schedule specified. Will return the job in JSON format.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| job_id | String | [required] | ||
| create_jobs_schedule_request | CreateJobsScheduleRequest | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::MainSettings create_main(main_settings) Update main settings
Updates main settings with the provided values.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| main_settings | MainSettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::MainSettings create_main_regenerate() Get main settings with newly-generated API key
Returns main settings in a JSON object, using the new API key.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::NetworkSettings create_network(network_settings) Update network settings
Updates network settings with the provided values.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| network_settings | NetworkSettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::DiscordSettings create_notifications_discord(discord_settings) Update Discord notification settings
Updates Discord notification settings with the provided values.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| discord_settings | DiscordSettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::NotificationEmailSettings create_notifications_email(notification_email_settings) Update email notification settings
Updates email notification settings with provided values
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| notification_email_settings | NotificationEmailSettings | [required] |
models::NotificationEmailSettings
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::GotifySettings create_notifications_gotify(gotify_settings) Update Gotify notification settings
Update Gotify notification settings with the provided values.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| gotify_settings | GotifySettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::NtfySettings create_notifications_ntfy(ntfy_settings) Update ntfy.sh notification settings
Update ntfy.sh notification settings with the provided values.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| ntfy_settings | NtfySettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::PushbulletSettings create_notifications_pushbullet(pushbullet_settings) Update Pushbullet notification settings
Update Pushbullet notification settings with the provided values.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| pushbullet_settings | PushbulletSettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::PushoverSettings create_notifications_pushover(pushover_settings) Update Pushover notification settings
Update Pushover notification settings with the provided values.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| pushover_settings | PushoverSettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::SlackSettings create_notifications_slack(slack_settings) Update Slack notification settings
Updates Slack notification settings with the provided values.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| slack_settings | SlackSettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::TelegramSettings create_notifications_telegram(telegram_settings) Update Telegram notification settings
Update Telegram notification settings with the provided values.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| telegram_settings | TelegramSettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::WebhookSettings create_notifications_webhook(webhook_settings) Update webhook notification settings
Updates webhook notification settings with the provided values.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| webhook_settings | WebhookSettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::WebPushSettings create_notifications_webpush(web_push_settings) Update Web Push notification settings
Updates Web Push notification settings with the provided values.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| web_push_settings | WebPushSettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::PlexSettings create_plex(plex_settings) Update Plex settings
Updates Plex settings with the provided values.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| plex_settings | PlexSettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::GetPlexSync2XxResponse create_plex_sync(create_jellyfin_sync_request) Start full Plex library scan
Runs a full Plex library scan and returns the progress in a JSON array.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| create_jellyfin_sync_request | Option<CreateJellyfinSyncRequest> |
models::GetPlexSync2XxResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::RadarrSettings create_radarr(radarr_settings) Create Radarr instance
Creates a new Radarr instance from the request body.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| radarr_settings | RadarrSettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::SonarrSettings create_sonarr(sonarr_settings) Create Sonarr instance
Creates a new Sonarr instance from the request body.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| sonarr_settings | SonarrSettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::TautulliSettings create_tautulli(tautulli_settings) Update Tautulli settings
Updates Tautulli settings with the provided values.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| tautulli_settings | TautulliSettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::DiscoverSlider delete_discover(slider_id) Delete slider by ID
Deletes the slider with the provided sliderId. Requires the ADMIN permission.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| slider_id | f64 | [required] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::RadarrSettings delete_radarr(radarr_id) Delete Radarr instance
Deletes an existing Radarr instance based on the radarrId parameter.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| radarr_id | i32 | Radarr instance ID | [required] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::SonarrSettings delete_sonarr(sonarr_id) Delete Sonarr instance
Deletes an existing Sonarr instance based on the sonarrId parameter.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| sonarr_id | i32 | Sonarr instance ID | [required] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::GetAbout2XxResponse get_about() Get server stats
Returns current server stats in a JSON object.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::GetCache2XxResponse get_cache() Get a list of active caches
Retrieves a list of all active caches and their current stats.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_discover_reset() Reset all discover sliders
Resets all discovery sliders to the default values. Requires the ADMIN permission.
This endpoint does not need any parameter.
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::JellyfinSettings get_jellyfin() Get Jellyfin settings
Retrieves current Jellyfin settings.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::GetJellyfinSync2XxResponse get_jellyfin_sync() Get status of full Jellyfin library sync
Returns sync progress in a JSON array.
This endpoint does not need any parameter.
models::GetJellyfinSync2XxResponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::MainSettings get_main() Get main settings
Retrieves all main settings in a JSON object.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::MetadataSettings get_metadatas() Get Metadata settings
Retrieves current Metadata settings.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::MainSettings get_network() Get network settings
Retrieves all network settings in a JSON object.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::DiscordSettings get_notifications_discord() Get Discord notification settings
Returns current Discord notification settings in a JSON object.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::NotificationEmailSettings get_notifications_email() Get email notification settings
Returns current email notification settings in a JSON object.
This endpoint does not need any parameter.
models::NotificationEmailSettings
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::GotifySettings get_notifications_gotify() Get Gotify notification settings
Returns current Gotify notification settings in a JSON object.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::NtfySettings get_notifications_ntfy() Get ntfy.sh notification settings
Returns current ntfy.sh notification settings in a JSON object.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::PushbulletSettings get_notifications_pushbullet() Get Pushbullet notification settings
Returns current Pushbullet notification settings in a JSON object.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::PushoverSettings get_notifications_pushover() Get Pushover notification settings
Returns current Pushover notification settings in a JSON object.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::SlackSettings get_notifications_slack() Get Slack notification settings
Returns current Slack notification settings in a JSON object.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::TelegramSettings get_notifications_telegram() Get Telegram notification settings
Returns current Telegram notification settings in a JSON object.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::WebhookSettings get_notifications_webhook() Get webhook notification settings
Returns current webhook notification settings in a JSON object.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::WebPushSettings get_notifications_webpush() Get Web Push notification settings
Returns current Web Push notification settings in a JSON object.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::PlexSettings get_plex() Get Plex settings
Retrieves current Plex settings.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::GetPlexSync2XxResponse get_plex_sync() Get status of full Plex library scan
Returns scan progress in a JSON array.
This endpoint does not need any parameter.
models::GetPlexSync2XxResponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::PublicSettings get_public() Get public settings
Returns settings that are not protected or sensitive. Mainly used to determine if the application has been configured for the first time.
This endpoint does not need any parameter.
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::TautulliSettings get_tautulli() Get Tautulli settings
Retrieves current Tautulli settings.
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Vecmodels::DiscoverSlider list_discover() Get all discover sliders
Returns all discovery sliders. Built-in and custom made.
This endpoint does not need any parameter.
Vecmodels::DiscoverSlider
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Vecmodels::JellyfinLibrary list_jellyfin_library(sync, enable) Get Jellyfin libraries
Returns a list of Jellyfin libraries in a JSON array.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| sync | Option<String> | Syncs the current libraries with the current Jellyfin server | ||
| enable | Option<String> | Comma separated list of libraries to enable. Any libraries not passed will be disabled! |
Vecmodels::JellyfinLibrary
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Vecmodels::ListJellyfinUsers2XxResponseInner list_jellyfin_users() Get Jellyfin Users
Returns a list of Jellyfin Users in a JSON array.
This endpoint does not need any parameter.
Vecmodels::ListJellyfinUsers2XxResponseInner
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Vecmodels::Job list_jobs() Get scheduled jobs
Returns list of all scheduled jobs and details about their next execution time in a JSON array.
This endpoint does not need any parameter.
Vecmodels::Job
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Vecmodels::ListLogs2XxResponseInner list_logs(take, skip, filter, search) Returns logs
Returns list of all log items and details
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| take | Option<f64> | |||
| skip | Option<f64> | |||
| filter | Option<String> | [default to debug] | ||
| search | Option<String> |
Vecmodels::ListLogs2XxResponseInner
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Vecmodels::ListNotificationsPushoverSounds2XxResponseInner list_notifications_pushover_sounds(token) Get Pushover sounds
Returns valid Pushover sound options in a JSON array.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| token | String | [required] |
Vecmodels::ListNotificationsPushoverSounds2XxResponseInner
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Vecmodels::PlexDevice list_plex_devices_servers() Gets the user's available Plex servers
Returns a list of available Plex servers and their connectivity state
This endpoint does not need any parameter.
Vecmodels::PlexDevice
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Vecmodels::PlexLibrary list_plex_library(sync, enable) Get Plex libraries
Returns a list of Plex libraries in a JSON array.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| sync | Option<String> | Syncs the current libraries with the current Plex server | ||
| enable | Option<String> | Comma separated list of libraries to enable. Any libraries not passed will be disabled! |
Vecmodels::PlexLibrary
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Vecmodels::ListPlexUsers2XxResponseInner list_plex_users() Get Plex users
Returns a list of Plex users in a JSON array. Requires the MANAGE_USERS permission.
This endpoint does not need any parameter.
Vecmodels::ListPlexUsers2XxResponseInner
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Vecmodels::RadarrSettings list_radarr() Get Radarr settings
Returns all Radarr settings in a JSON array.
This endpoint does not need any parameter.
Vecmodels::RadarrSettings
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Vecmodels::ServiceProfile list_radarr_profiles(radarr_id) Get available Radarr profiles
Returns a list of profiles available on the Radarr server instance in a JSON array.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| radarr_id | i32 | Radarr instance ID | [required] |
Vecmodels::ServiceProfile
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
Vecmodels::SonarrSettings list_sonarr() Get Sonarr settings
Returns all Sonarr settings in a JSON array.
This endpoint does not need any parameter.
Vecmodels::SonarrSettings
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::MetadataSettings put_metadatas(metadata_settings) Update Metadata settings
Updates Metadata settings with the provided values.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| metadata_settings | MetadataSettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::TestMetadatas2XxResponse test_metadatas(test_metadatas_request) Test Provider configuration
Tests if the TVDB configuration is valid. Returns a list of available languages on success.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| test_metadatas_request | TestMetadatasRequest | [required] |
models::TestMetadatas2XxResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
test_notifications_discord(discord_settings) Test Discord settings
Sends a test notification to the Discord agent.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| discord_settings | DiscordSettings | [required] |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
test_notifications_email(notification_email_settings) Test email settings
Sends a test notification to the email agent.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| notification_email_settings | NotificationEmailSettings | [required] |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
test_notifications_gotify(gotify_settings) Test Gotify settings
Sends a test notification to the Gotify agent.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| gotify_settings | GotifySettings | [required] |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
test_notifications_ntfy(ntfy_settings) Test ntfy.sh settings
Sends a test notification to the ntfy.sh agent.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| ntfy_settings | NtfySettings | [required] |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
test_notifications_pushbullet(pushbullet_settings) Test Pushbullet settings
Sends a test notification to the Pushbullet agent.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| pushbullet_settings | PushbulletSettings | [required] |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
test_notifications_pushover(pushover_settings) Test Pushover settings
Sends a test notification to the Pushover agent.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| pushover_settings | PushoverSettings | [required] |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
test_notifications_slack(slack_settings) Test Slack settings
Sends a test notification to the Slack agent.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| slack_settings | SlackSettings | [required] |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
test_notifications_telegram(telegram_settings) Test Telegram settings
Sends a test notification to the Telegram agent.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| telegram_settings | TelegramSettings | [required] |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
test_notifications_webhook(webhook_settings) Test webhook settings
Sends a test notification to the webhook agent.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| webhook_settings | WebhookSettings | [required] |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
test_notifications_webpush(web_push_settings) Test Web Push settings
Sends a test notification to the Web Push agent.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| web_push_settings | WebPushSettings | [required] |
(empty response body)
- Content-Type: application/json
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::TestRadarr2XxResponse test_radarr(test_radarr_request) Test Radarr configuration
Tests if the Radarr configuration is valid. Returns profiles and root folders on success.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| test_radarr_request | TestRadarrRequest | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::TestRadarr2XxResponse test_sonarr(test_sonarr_request) Test Sonarr configuration
Tests if the Sonarr configuration is valid. Returns profiles and root folders on success.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| test_sonarr_request | TestSonarrRequest | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::DiscoverSlider update_discover(slider_id, update_discover_request) Update a single slider
Updates a single slider and return the newly updated slider. Requires the ADMIN permission.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| slider_id | f64 | [required] | ||
| update_discover_request | UpdateDiscoverRequest | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::RadarrSettings update_radarr(radarr_id, radarr_settings) Update Radarr instance
Updates an existing Radarr instance with the provided values.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| radarr_id | i32 | Radarr instance ID | [required] | |
| radarr_settings | RadarrSettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
models::SonarrSettings update_sonarr(sonarr_id, sonarr_settings) Update Sonarr instance
Updates an existing Sonarr instance with the provided values.
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| sonarr_id | i32 | Sonarr instance ID | [required] | |
| sonarr_settings | SonarrSettings | [required] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]