sonarr.IndexerApi

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

Method	HTTP request	Description
create_indexer	POST /api/v3/indexer
create_indexer_action_by_name	POST /api/v3/indexer/action/{name}
delete_indexer	DELETE /api/v3/indexer/{id}
delete_indexer_bulk	DELETE /api/v3/indexer/bulk
get_indexer_by_id	GET /api/v3/indexer/{id}
list_indexer	GET /api/v3/indexer
list_indexer_schema	GET /api/v3/indexer/schema
put_indexer_bulk	PUT /api/v3/indexer/bulk
test_indexer	POST /api/v3/indexer/test
testall_indexer	POST /api/v3/indexer/testall
update_indexer	PUT /api/v3/indexer/{id}

create_indexer

IndexerResource create_indexer(force_save=force_save, indexer_resource=indexer_resource)

Example

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

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

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

Parameters

Name	Type	Description	Notes
force_save	bool		[optional] [default to False]
indexer_resource	IndexerResource		[optional]

Return type

IndexerResource

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_indexer_action_by_name

create_indexer_action_by_name(name, indexer_resource=indexer_resource)

Example

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

import sonarr
from sonarr.models.indexer_resource import IndexerResource
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.IndexerApi(api_client)
    name = 'name_example' # str | 
    indexer_resource = sonarr.IndexerResource() # IndexerResource |  (optional)

    try:
        api_instance.create_indexer_action_by_name(name, indexer_resource=indexer_resource)
    except Exception as e:
        print("Exception when calling IndexerApi->create_indexer_action_by_name: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str
indexer_resource	IndexerResource		[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_indexer

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

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

delete_indexer_bulk(indexer_bulk_resource=indexer_bulk_resource)

Example

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

import sonarr
from sonarr.models.indexer_bulk_resource import IndexerBulkResource
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.IndexerApi(api_client)
    indexer_bulk_resource = sonarr.IndexerBulkResource() # IndexerBulkResource |  (optional)

    try:
        api_instance.delete_indexer_bulk(indexer_bulk_resource=indexer_bulk_resource)
    except Exception as e:
        print("Exception when calling IndexerApi->delete_indexer_bulk: %s\n" % e)

Parameters

Name	Type	Description	Notes
indexer_bulk_resource	IndexerBulkResource		[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_indexer_by_id

IndexerResource get_indexer_by_id(id)

Example

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

import sonarr
from sonarr.models.indexer_resource import IndexerResource
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.IndexerApi(api_client)
    id = 56 # int | 

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

Parameters

Name	Type	Description	Notes
id	int

Return type

IndexerResource

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_indexer

List[IndexerResource] list_indexer()

Example

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

import sonarr
from sonarr.models.indexer_resource import IndexerResource
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.IndexerApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

List[IndexerResource]

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_indexer_schema

List[IndexerResource] list_indexer_schema()

Example

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

import sonarr
from sonarr.models.indexer_resource import IndexerResource
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.IndexerApi(api_client)

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

Parameters

This endpoint does not need any parameter.

Return type

List[IndexerResource]

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_indexer_bulk

IndexerResource put_indexer_bulk(indexer_bulk_resource=indexer_bulk_resource)

Example

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

import sonarr
from sonarr.models.indexer_bulk_resource import IndexerBulkResource
from sonarr.models.indexer_resource import IndexerResource
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.IndexerApi(api_client)
    indexer_bulk_resource = sonarr.IndexerBulkResource() # IndexerBulkResource |  (optional)

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

Parameters

Name	Type	Description	Notes
indexer_bulk_resource	IndexerBulkResource		[optional]

Return type

IndexerResource

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_indexer

test_indexer(force_test=force_test, indexer_resource=indexer_resource)

Example

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

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

    try:
        api_instance.test_indexer(force_test=force_test, indexer_resource=indexer_resource)
    except Exception as e:
        print("Exception when calling IndexerApi->test_indexer: %s\n" % e)

Parameters

Name	Type	Description	Notes
force_test	bool		[optional] [default to False]
indexer_resource	IndexerResource		[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_indexer

testall_indexer()

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

    try:
        api_instance.testall_indexer()
    except Exception as e:
        print("Exception when calling IndexerApi->testall_indexer: %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_indexer

IndexerResource update_indexer(id, force_save=force_save, indexer_resource=indexer_resource)

Example

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

import sonarr
from sonarr.models.indexer_resource import IndexerResource
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.IndexerApi(api_client)
    id = 'id_example' # str | 
    force_save = False # bool |  (optional) (default to False)
    indexer_resource = sonarr.IndexerResource() # IndexerResource |  (optional)

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

Parameters

Name	Type	Notes
id	str
force_save	bool	[optional] [default to False]
indexer_resource	IndexerResource	[optional]

Return type

IndexerResource

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

IndexerApi.md

Latest commit

History

IndexerApi.md

File metadata and controls

sonarr.IndexerApi

create_indexer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_indexer_action_by_name

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_indexer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_indexer_bulk

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_indexer_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_indexer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_indexer_schema

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

put_indexer_bulk

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

test_indexer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

testall_indexer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_indexer

Example

Parameters