All URIs are relative to http://localhost:8686
Method | HTTP request | Description |
---|---|---|
delete_queue | DELETE /api/v1/queue/{id} | |
delete_queue_bulk | DELETE /api/v1/queue/bulk | |
get_queue | GET /api/v1/queue |
delete_queue(id, remove_from_client=remove_from_client, blocklist=blocklist, skip_redownload=skip_redownload, change_category=change_category)
- Api Key Authentication (apikey):
- Api Key Authentication (X-Api-Key):
import lidarr
from lidarr.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8686
# See configuration.py for a list of all supported configuration parameters.
configuration = lidarr.Configuration(
host = "http://localhost:8686"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'
# Configure API key authorization: X-Api-Key
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Enter a context with an instance of the API client
with lidarr.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = lidarr.QueueApi(api_client)
id = 56 # int |
remove_from_client = True # bool | (optional) (default to True)
blocklist = False # bool | (optional) (default to False)
skip_redownload = False # bool | (optional) (default to False)
change_category = False # bool | (optional) (default to False)
try:
api_instance.delete_queue(id, remove_from_client=remove_from_client, blocklist=blocklist, skip_redownload=skip_redownload, change_category=change_category)
except Exception as e:
print("Exception when calling QueueApi->delete_queue: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
id | int | ||
remove_from_client | bool | [optional] [default to True] | |
blocklist | bool | [optional] [default to False] | |
skip_redownload | bool | [optional] [default to False] | |
change_category | bool | [optional] [default to False] |
void (empty response body)
- Content-Type: Not defined
- Accept: Not defined
Status code | Description | Response headers |
---|---|---|
2XX | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_queue_bulk(remove_from_client=remove_from_client, blocklist=blocklist, skip_redownload=skip_redownload, change_category=change_category, queue_bulk_resource=queue_bulk_resource)
- Api Key Authentication (apikey):
- Api Key Authentication (X-Api-Key):
import lidarr
from lidarr.models.queue_bulk_resource import QueueBulkResource
from lidarr.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8686
# See configuration.py for a list of all supported configuration parameters.
configuration = lidarr.Configuration(
host = "http://localhost:8686"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'
# Configure API key authorization: X-Api-Key
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Enter a context with an instance of the API client
with lidarr.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = lidarr.QueueApi(api_client)
remove_from_client = True # bool | (optional) (default to True)
blocklist = False # bool | (optional) (default to False)
skip_redownload = False # bool | (optional) (default to False)
change_category = False # bool | (optional) (default to False)
queue_bulk_resource = lidarr.QueueBulkResource() # QueueBulkResource | (optional)
try:
api_instance.delete_queue_bulk(remove_from_client=remove_from_client, blocklist=blocklist, skip_redownload=skip_redownload, change_category=change_category, queue_bulk_resource=queue_bulk_resource)
except Exception as e:
print("Exception when calling QueueApi->delete_queue_bulk: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
remove_from_client | bool | [optional] [default to True] | |
blocklist | bool | [optional] [default to False] | |
skip_redownload | bool | [optional] [default to False] | |
change_category | bool | [optional] [default to False] | |
queue_bulk_resource | QueueBulkResource | [optional] |
void (empty response body)
- Content-Type: application/json, text/json, application/*+json
- Accept: Not defined
Status code | Description | Response headers |
---|---|---|
2XX | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
QueueResourcePagingResource get_queue(page=page, page_size=page_size, sort_key=sort_key, sort_direction=sort_direction, include_unknown_artist_items=include_unknown_artist_items, include_artist=include_artist, include_album=include_album, artist_ids=artist_ids, protocol=protocol, quality=quality)
- Api Key Authentication (apikey):
- Api Key Authentication (X-Api-Key):
import lidarr
from lidarr.models.download_protocol import DownloadProtocol
from lidarr.models.queue_resource_paging_resource import QueueResourcePagingResource
from lidarr.models.sort_direction import SortDirection
from lidarr.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:8686
# See configuration.py for a list of all supported configuration parameters.
configuration = lidarr.Configuration(
host = "http://localhost:8686"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: apikey
configuration.api_key['apikey'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apikey'] = 'Bearer'
# Configure API key authorization: X-Api-Key
configuration.api_key['X-Api-Key'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Api-Key'] = 'Bearer'
# Enter a context with an instance of the API client
with lidarr.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = lidarr.QueueApi(api_client)
page = 1 # int | (optional) (default to 1)
page_size = 10 # int | (optional) (default to 10)
sort_key = 'sort_key_example' # str | (optional)
sort_direction = lidarr.SortDirection() # SortDirection | (optional)
include_unknown_artist_items = False # bool | (optional) (default to False)
include_artist = False # bool | (optional) (default to False)
include_album = False # bool | (optional) (default to False)
artist_ids = [56] # List[int] | (optional)
protocol = lidarr.DownloadProtocol() # DownloadProtocol | (optional)
quality = 56 # int | (optional)
try:
api_response = api_instance.get_queue(page=page, page_size=page_size, sort_key=sort_key, sort_direction=sort_direction, include_unknown_artist_items=include_unknown_artist_items, include_artist=include_artist, include_album=include_album, artist_ids=artist_ids, protocol=protocol, quality=quality)
print("The response of QueueApi->get_queue:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling QueueApi->get_queue: %s\n" % e)
Name | Type | Description | Notes |
---|---|---|---|
page | int | [optional] [default to 1] | |
page_size | int | [optional] [default to 10] | |
sort_key | str | [optional] | |
sort_direction | SortDirection | [optional] | |
include_unknown_artist_items | bool | [optional] [default to False] | |
include_artist | bool | [optional] [default to False] | |
include_album | bool | [optional] [default to False] | |
artist_ids | List[int] | [optional] | |
protocol | DownloadProtocol | [optional] | |
quality | int | [optional] |
- Content-Type: Not defined
- Accept: application/json
Status code | Description | Response headers |
---|---|---|
2XX | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]