Skip to content

QueueApi.md

Latest commit

 

History

History
114 lines (68 loc) · 3.84 KB

QueueApi.md

File metadata and controls

114 lines (68 loc) · 3.84 KB

\QueueApi

All URIs are relative to http://localhost:8989

Method HTTP request Description
delete_queue DELETE /api/v3/queue/{id}
delete_queue_bulk DELETE /api/v3/queue/bulk
get_queue GET /api/v3/queue

delete_queue

delete_queue(id, remove_from_client, blocklist, skip_redownload, change_category)

Parameters

Name Type Description Required Notes
id i32 [required]
remove_from_client Option<bool> [default to true]
blocklist Option<bool> [default to false]
skip_redownload Option<bool> [default to false]
change_category Option<bool> [default to false]

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_queue_bulk

delete_queue_bulk(remove_from_client, blocklist, skip_redownload, change_category, queue_bulk_resource)

Parameters

Name Type Description Required Notes
remove_from_client Option<bool> [default to true]
blocklist Option<bool> [default to false]
skip_redownload Option<bool> [default to false]
change_category Option<bool> [default to false]
queue_bulk_resource Option<QueueBulkResource>

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_queue

models::QueueResourcePagingResource get_queue(page, page_size, sort_key, sort_direction, include_unknown_series_items, include_series, include_episode, series_ids, protocol, languages, quality, status)

Parameters

Name Type Description Required Notes
page Option<i32> [default to 1]
page_size Option<i32> [default to 10]
sort_key Option<String>
sort_direction Option<SortDirection>
include_unknown_series_items Option<bool> [default to false]
include_series Option<bool> [default to false]
include_episode Option<bool> [default to false]
series_ids Option<Vec>
protocol Option<DownloadProtocol>
languages Option<Vec>
quality Option<Vec>
status Option<Vecmodels::QueueStatus>

Return type

models::QueueResourcePagingResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]