QueueActionApi.md

lidarr.QueueActionApi

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

Method	HTTP request	Description
create_queue_grab_bulk	POST /api/v1/queue/grab/bulk
create_queue_grab_by_id	POST /api/v1/queue/grab/{id}

create_queue_grab_bulk

create_queue_grab_bulk(queue_bulk_resource=queue_bulk_resource)

Example

• 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.QueueActionApi(api_client)
    queue_bulk_resource = lidarr.QueueBulkResource() # QueueBulkResource |  (optional)

    try:
        api_instance.create_queue_grab_bulk(queue_bulk_resource=queue_bulk_resource)
    except Exception as e:
        print("Exception when calling QueueActionApi->create_queue_grab_bulk: %s\n" % e)

Parameters

Name	Type	Description	Notes
queue_bulk_resource	QueueBulkResource		[optional]

Return type

void (empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
2XX	Success	-

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

create_queue_grab_by_id

create_queue_grab_by_id(id)

Example

• 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.QueueActionApi(api_client)
    id = 56 # int | 

    try:
        api_instance.create_queue_grab_by_id(id)
    except Exception as e:
        print("Exception when calling QueueActionApi->create_queue_grab_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

void (empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
2XX	Success	-

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