prowlarr.IndexerProxyApi

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

Method	HTTP request	Description
create_indexer_proxy	POST /api/v1/indexerproxy
create_indexer_proxy_action_by_name	POST /api/v1/indexerproxy/action/{name}
delete_indexer_proxy	DELETE /api/v1/indexerproxy/{id}
get_indexer_proxy_by_id	GET /api/v1/indexerproxy/{id}
list_indexer_proxy	GET /api/v1/indexerproxy
list_indexer_proxy_schema	GET /api/v1/indexerproxy/schema
test_indexer_proxy	POST /api/v1/indexerproxy/test
testall_indexer_proxy	POST /api/v1/indexerproxy/testall
update_indexer_proxy	PUT /api/v1/indexerproxy/{id}

create_indexer_proxy

IndexerProxyResource create_indexer_proxy(force_save=force_save, indexer_proxy_resource=indexer_proxy_resource)

Example

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

import prowlarr
from prowlarr.models.indexer_proxy_resource import IndexerProxyResource
from prowlarr.rest import ApiException
from pprint import pprint

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

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

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

Parameters

Name	Type	Description	Notes
force_save	bool		[optional] [default to False]
indexer_proxy_resource	IndexerProxyResource		[optional]

Return type

IndexerProxyResource

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_proxy_action_by_name

create_indexer_proxy_action_by_name(name, indexer_proxy_resource=indexer_proxy_resource)

Example

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

import prowlarr
from prowlarr.models.indexer_proxy_resource import IndexerProxyResource
from prowlarr.rest import ApiException
from pprint import pprint

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

# 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 prowlarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = prowlarr.IndexerProxyApi(api_client)
    name = 'name_example' # str | 
    indexer_proxy_resource = prowlarr.IndexerProxyResource() # IndexerProxyResource |  (optional)

    try:
        api_instance.create_indexer_proxy_action_by_name(name, indexer_proxy_resource=indexer_proxy_resource)
    except Exception as e:
        print("Exception when calling IndexerProxyApi->create_indexer_proxy_action_by_name: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str
indexer_proxy_resource	IndexerProxyResource		[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_proxy

delete_indexer_proxy(id)

Example

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

import prowlarr
from prowlarr.rest import ApiException
from pprint import pprint

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

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

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

get_indexer_proxy_by_id

IndexerProxyResource get_indexer_proxy_by_id(id)

Example

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

import prowlarr
from prowlarr.models.indexer_proxy_resource import IndexerProxyResource
from prowlarr.rest import ApiException
from pprint import pprint

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

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

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

Parameters

Name	Type	Description	Notes
id	int

Return type

IndexerProxyResource

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_proxy

List[IndexerProxyResource] list_indexer_proxy()

Example

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

import prowlarr
from prowlarr.models.indexer_proxy_resource import IndexerProxyResource
from prowlarr.rest import ApiException
from pprint import pprint

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

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

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

Parameters

This endpoint does not need any parameter.

Return type

List[IndexerProxyResource]

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_proxy_schema

List[IndexerProxyResource] list_indexer_proxy_schema()

Example

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

import prowlarr
from prowlarr.models.indexer_proxy_resource import IndexerProxyResource
from prowlarr.rest import ApiException
from pprint import pprint

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

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

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

Parameters

This endpoint does not need any parameter.

Return type

List[IndexerProxyResource]

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]

test_indexer_proxy

test_indexer_proxy(force_test=force_test, indexer_proxy_resource=indexer_proxy_resource)

Example

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

import prowlarr
from prowlarr.models.indexer_proxy_resource import IndexerProxyResource
from prowlarr.rest import ApiException
from pprint import pprint

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

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

    try:
        api_instance.test_indexer_proxy(force_test=force_test, indexer_proxy_resource=indexer_proxy_resource)
    except Exception as e:
        print("Exception when calling IndexerProxyApi->test_indexer_proxy: %s\n" % e)

Parameters

Name	Type	Description	Notes
force_test	bool		[optional] [default to False]
indexer_proxy_resource	IndexerProxyResource		[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_proxy

testall_indexer_proxy()

Example

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

import prowlarr
from prowlarr.rest import ApiException
from pprint import pprint

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

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

    try:
        api_instance.testall_indexer_proxy()
    except Exception as e:
        print("Exception when calling IndexerProxyApi->testall_indexer_proxy: %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_proxy

IndexerProxyResource update_indexer_proxy(id, force_save=force_save, indexer_proxy_resource=indexer_proxy_resource)

Example

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

import prowlarr
from prowlarr.models.indexer_proxy_resource import IndexerProxyResource
from prowlarr.rest import ApiException
from pprint import pprint

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

# 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 prowlarr.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = prowlarr.IndexerProxyApi(api_client)
    id = 'id_example' # str | 
    force_save = False # bool |  (optional) (default to False)
    indexer_proxy_resource = prowlarr.IndexerProxyResource() # IndexerProxyResource |  (optional)

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

Parameters

Name	Type	Notes
id	str
force_save	bool	[optional] [default to False]
indexer_proxy_resource	IndexerProxyResource	[optional]

Return type

IndexerProxyResource

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

IndexerProxyApi.md

Latest commit

History

IndexerProxyApi.md

File metadata and controls

prowlarr.IndexerProxyApi

create_indexer_proxy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_indexer_proxy_action_by_name

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_indexer_proxy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_indexer_proxy_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_indexer_proxy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_indexer_proxy_schema

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

test_indexer_proxy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

testall_indexer_proxy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_indexer_proxy

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details