sonarr.ImportListApi

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

Method	HTTP request	Description
create_import_list	POST /api/v3/importlist
create_import_list_action_by_name	POST /api/v3/importlist/action/{name}
delete_import_list	DELETE /api/v3/importlist/{id}
delete_import_list_bulk	DELETE /api/v3/importlist/bulk
get_import_list_by_id	GET /api/v3/importlist/{id}
list_import_list	GET /api/v3/importlist
list_import_list_schema	GET /api/v3/importlist/schema
put_import_list_bulk	PUT /api/v3/importlist/bulk
test_import_list	POST /api/v3/importlist/test
testall_import_list	POST /api/v3/importlist/testall
update_import_list	PUT /api/v3/importlist/{id}

create_import_list

ImportListResource create_import_list(force_save=force_save, import_list_resource=import_list_resource)

Example

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

import sonarr
from sonarr.models.import_list_resource import ImportListResource
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.ImportListApi(api_client)
    force_save = False # bool |  (optional) (default to False)
    import_list_resource = sonarr.ImportListResource() # ImportListResource |  (optional)

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

Parameters

Name	Type	Description	Notes
force_save	bool		[optional] [default to False]
import_list_resource	ImportListResource		[optional]

Return type

ImportListResource

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_import_list_action_by_name

create_import_list_action_by_name(name, import_list_resource=import_list_resource)

Example

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

import sonarr
from sonarr.models.import_list_resource import ImportListResource
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.ImportListApi(api_client)
    name = 'name_example' # str | 
    import_list_resource = sonarr.ImportListResource() # ImportListResource |  (optional)

    try:
        api_instance.create_import_list_action_by_name(name, import_list_resource=import_list_resource)
    except Exception as e:
        print("Exception when calling ImportListApi->create_import_list_action_by_name: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str
import_list_resource	ImportListResource		[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_import_list

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

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

delete_import_list_bulk(import_list_bulk_resource=import_list_bulk_resource)

Example

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

import sonarr
from sonarr.models.import_list_bulk_resource import ImportListBulkResource
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.ImportListApi(api_client)
    import_list_bulk_resource = sonarr.ImportListBulkResource() # ImportListBulkResource |  (optional)

    try:
        api_instance.delete_import_list_bulk(import_list_bulk_resource=import_list_bulk_resource)
    except Exception as e:
        print("Exception when calling ImportListApi->delete_import_list_bulk: %s\n" % e)

Parameters

Name	Type	Description	Notes
import_list_bulk_resource	ImportListBulkResource		[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_import_list_by_id

ImportListResource get_import_list_by_id(id)

Example

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

import sonarr
from sonarr.models.import_list_resource import ImportListResource
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.ImportListApi(api_client)
    id = 56 # int | 

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

Parameters

Name	Type	Description	Notes
id	int

Return type

ImportListResource

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_import_list

List[ImportListResource] list_import_list()

Example

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

import sonarr
from sonarr.models.import_list_resource import ImportListResource
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.ImportListApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

List[ImportListResource]

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_import_list_schema

List[ImportListResource] list_import_list_schema()

Example

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

import sonarr
from sonarr.models.import_list_resource import ImportListResource
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.ImportListApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

List[ImportListResource]

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_import_list_bulk

ImportListResource put_import_list_bulk(import_list_bulk_resource=import_list_bulk_resource)

Example

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

import sonarr
from sonarr.models.import_list_bulk_resource import ImportListBulkResource
from sonarr.models.import_list_resource import ImportListResource
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.ImportListApi(api_client)
    import_list_bulk_resource = sonarr.ImportListBulkResource() # ImportListBulkResource |  (optional)

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

Parameters

Name	Type	Description	Notes
import_list_bulk_resource	ImportListBulkResource		[optional]

Return type

ImportListResource

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_import_list

test_import_list(force_test=force_test, import_list_resource=import_list_resource)

Example

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

import sonarr
from sonarr.models.import_list_resource import ImportListResource
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.ImportListApi(api_client)
    force_test = False # bool |  (optional) (default to False)
    import_list_resource = sonarr.ImportListResource() # ImportListResource |  (optional)

    try:
        api_instance.test_import_list(force_test=force_test, import_list_resource=import_list_resource)
    except Exception as e:
        print("Exception when calling ImportListApi->test_import_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
force_test	bool		[optional] [default to False]
import_list_resource	ImportListResource		[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_import_list

testall_import_list()

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.ImportListApi(api_client)

    try:
        api_instance.testall_import_list()
    except Exception as e:
        print("Exception when calling ImportListApi->testall_import_list: %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_import_list

ImportListResource update_import_list(id, force_save=force_save, import_list_resource=import_list_resource)

Example

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

import sonarr
from sonarr.models.import_list_resource import ImportListResource
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.ImportListApi(api_client)
    id = 56 # int | 
    force_save = False # bool |  (optional) (default to False)
    import_list_resource = sonarr.ImportListResource() # ImportListResource |  (optional)

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

Parameters

Name	Type	Notes
id	int
force_save	bool	[optional] [default to False]
import_list_resource	ImportListResource	[optional]

Return type

ImportListResource

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

ImportListApi.md

Latest commit

History

ImportListApi.md

File metadata and controls

sonarr.ImportListApi

create_import_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_import_list_action_by_name

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_import_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_import_list_bulk

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_import_list_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_import_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_import_list_schema

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

put_import_list_bulk

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

test_import_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

testall_import_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_import_list

Example

Parameters