sonarr.DownloadClientApi

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

Method	HTTP request	Description
create_download_client	POST /api/v3/downloadclient
create_download_client_action_by_name	POST /api/v3/downloadclient/action/{name}
delete_download_client	DELETE /api/v3/downloadclient/{id}
delete_download_client_bulk	DELETE /api/v3/downloadclient/bulk
get_download_client_by_id	GET /api/v3/downloadclient/{id}
list_download_client	GET /api/v3/downloadclient
list_download_client_schema	GET /api/v3/downloadclient/schema
put_download_client_bulk	PUT /api/v3/downloadclient/bulk
test_download_client	POST /api/v3/downloadclient/test
testall_download_client	POST /api/v3/downloadclient/testall
update_download_client	PUT /api/v3/downloadclient/{id}

create_download_client

DownloadClientResource create_download_client(force_save=force_save, download_client_resource=download_client_resource)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import sonarr
from sonarr.models.download_client_resource import DownloadClientResource
from sonarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8989
# See configuration.py for a list of all supported configuration parameters.
configuration = sonarr.Configuration(
    host = "http://localhost:8989"
)

# 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 sonarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sonarr.DownloadClientApi(api_client)
    force_save = False # bool |  (optional) (default to False)
    download_client_resource = sonarr.DownloadClientResource() # DownloadClientResource |  (optional)

    try:
        api_response = api_instance.create_download_client(force_save=force_save, download_client_resource=download_client_resource)
        print("The response of DownloadClientApi->create_download_client:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadClientApi->create_download_client: %s\n" % e)

Parameters

Name	Type	Description	Notes
force_save	bool		[optional] [default to False]
download_client_resource	DownloadClientResource		[optional]

Return type

DownloadClientResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	OK	-

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

create_download_client_action_by_name

create_download_client_action_by_name(name, download_client_resource=download_client_resource)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import sonarr
from sonarr.models.download_client_resource import DownloadClientResource
from sonarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8989
# See configuration.py for a list of all supported configuration parameters.
configuration = sonarr.Configuration(
    host = "http://localhost:8989"
)

# 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 sonarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sonarr.DownloadClientApi(api_client)
    name = 'name_example' # str | 
    download_client_resource = sonarr.DownloadClientResource() # DownloadClientResource |  (optional)

    try:
        api_instance.create_download_client_action_by_name(name, download_client_resource=download_client_resource)
    except Exception as e:
        print("Exception when calling DownloadClientApi->create_download_client_action_by_name: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str
download_client_resource	DownloadClientResource		[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	OK	-

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

delete_download_client

delete_download_client(id)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import sonarr
from sonarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8989
# See configuration.py for a list of all supported configuration parameters.
configuration = sonarr.Configuration(
    host = "http://localhost:8989"
)

# 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 sonarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sonarr.DownloadClientApi(api_client)
    id = 56 # int | 

    try:
        api_instance.delete_download_client(id)
    except Exception as e:
        print("Exception when calling DownloadClientApi->delete_download_client: %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	OK	-

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

delete_download_client_bulk

delete_download_client_bulk(download_client_bulk_resource=download_client_bulk_resource)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import sonarr
from sonarr.models.download_client_bulk_resource import DownloadClientBulkResource
from sonarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8989
# See configuration.py for a list of all supported configuration parameters.
configuration = sonarr.Configuration(
    host = "http://localhost:8989"
)

# 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 sonarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sonarr.DownloadClientApi(api_client)
    download_client_bulk_resource = sonarr.DownloadClientBulkResource() # DownloadClientBulkResource |  (optional)

    try:
        api_instance.delete_download_client_bulk(download_client_bulk_resource=download_client_bulk_resource)
    except Exception as e:
        print("Exception when calling DownloadClientApi->delete_download_client_bulk: %s\n" % e)

Parameters

Name	Type	Description	Notes
download_client_bulk_resource	DownloadClientBulkResource		[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	OK	-

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

get_download_client_by_id

DownloadClientResource get_download_client_by_id(id)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import sonarr
from sonarr.models.download_client_resource import DownloadClientResource
from sonarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8989
# See configuration.py for a list of all supported configuration parameters.
configuration = sonarr.Configuration(
    host = "http://localhost:8989"
)

# 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 sonarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sonarr.DownloadClientApi(api_client)
    id = 56 # int | 

    try:
        api_response = api_instance.get_download_client_by_id(id)
        print("The response of DownloadClientApi->get_download_client_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadClientApi->get_download_client_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int

Return type

DownloadClientResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	OK	-

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

list_download_client

List[DownloadClientResource] list_download_client()

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import sonarr
from sonarr.models.download_client_resource import DownloadClientResource
from sonarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8989
# See configuration.py for a list of all supported configuration parameters.
configuration = sonarr.Configuration(
    host = "http://localhost:8989"
)

# 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 sonarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sonarr.DownloadClientApi(api_client)

    try:
        api_response = api_instance.list_download_client()
        print("The response of DownloadClientApi->list_download_client:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadClientApi->list_download_client: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[DownloadClientResource]

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	OK	-

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

list_download_client_schema

List[DownloadClientResource] list_download_client_schema()

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import sonarr
from sonarr.models.download_client_resource import DownloadClientResource
from sonarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8989
# See configuration.py for a list of all supported configuration parameters.
configuration = sonarr.Configuration(
    host = "http://localhost:8989"
)

# 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 sonarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sonarr.DownloadClientApi(api_client)

    try:
        api_response = api_instance.list_download_client_schema()
        print("The response of DownloadClientApi->list_download_client_schema:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadClientApi->list_download_client_schema: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[DownloadClientResource]

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	OK	-

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

put_download_client_bulk

DownloadClientResource put_download_client_bulk(download_client_bulk_resource=download_client_bulk_resource)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import sonarr
from sonarr.models.download_client_bulk_resource import DownloadClientBulkResource
from sonarr.models.download_client_resource import DownloadClientResource
from sonarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8989
# See configuration.py for a list of all supported configuration parameters.
configuration = sonarr.Configuration(
    host = "http://localhost:8989"
)

# 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 sonarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sonarr.DownloadClientApi(api_client)
    download_client_bulk_resource = sonarr.DownloadClientBulkResource() # DownloadClientBulkResource |  (optional)

    try:
        api_response = api_instance.put_download_client_bulk(download_client_bulk_resource=download_client_bulk_resource)
        print("The response of DownloadClientApi->put_download_client_bulk:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadClientApi->put_download_client_bulk: %s\n" % e)

Parameters

Name	Type	Description	Notes
download_client_bulk_resource	DownloadClientBulkResource		[optional]

Return type

DownloadClientResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	OK	-

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

test_download_client

test_download_client(force_test=force_test, download_client_resource=download_client_resource)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import sonarr
from sonarr.models.download_client_resource import DownloadClientResource
from sonarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8989
# See configuration.py for a list of all supported configuration parameters.
configuration = sonarr.Configuration(
    host = "http://localhost:8989"
)

# 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 sonarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sonarr.DownloadClientApi(api_client)
    force_test = False # bool |  (optional) (default to False)
    download_client_resource = sonarr.DownloadClientResource() # DownloadClientResource |  (optional)

    try:
        api_instance.test_download_client(force_test=force_test, download_client_resource=download_client_resource)
    except Exception as e:
        print("Exception when calling DownloadClientApi->test_download_client: %s\n" % e)

Parameters

Name	Type	Description	Notes
force_test	bool		[optional] [default to False]
download_client_resource	DownloadClientResource		[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	OK	-

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

testall_download_client

testall_download_client()

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import sonarr
from sonarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8989
# See configuration.py for a list of all supported configuration parameters.
configuration = sonarr.Configuration(
    host = "http://localhost:8989"
)

# 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 sonarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sonarr.DownloadClientApi(api_client)

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

Parameters

This endpoint does not need any parameter.

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	OK	-

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

update_download_client

DownloadClientResource update_download_client(id, force_save=force_save, download_client_resource=download_client_resource)

Example

Api Key Authentication (apikey):
Api Key Authentication (X-Api-Key):

import sonarr
from sonarr.models.download_client_resource import DownloadClientResource
from sonarr.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8989
# See configuration.py for a list of all supported configuration parameters.
configuration = sonarr.Configuration(
    host = "http://localhost:8989"
)

# 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 sonarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sonarr.DownloadClientApi(api_client)
    id = 56 # int | 
    force_save = False # bool |  (optional) (default to False)
    download_client_resource = sonarr.DownloadClientResource() # DownloadClientResource |  (optional)

    try:
        api_response = api_instance.update_download_client(id, force_save=force_save, download_client_resource=download_client_resource)
        print("The response of DownloadClientApi->update_download_client:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling DownloadClientApi->update_download_client: %s\n" % e)

Parameters

Name	Type	Notes
id	int
force_save	bool	[optional] [default to False]
download_client_resource	DownloadClientResource	[optional]

Return type

DownloadClientResource

Authorization

apikey, X-Api-Key

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
2XX	OK	-

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

Files

DownloadClientApi.md

Latest commit

History

DownloadClientApi.md

File metadata and controls

sonarr.DownloadClientApi

create_download_client

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_download_client_action_by_name

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_download_client

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_download_client_bulk

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_download_client_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_download_client

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_download_client_schema

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

put_download_client_bulk

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

test_download_client

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

testall_download_client

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_download_client

Example

Parameters